--- title: "PATCH /userprofiles/{+profileId}/campaigns" method: PATCH path: "/userprofiles/{+profileId}/campaigns" tags: ["campaigns"] --- # PATCH /userprofiles/{+profileId}/campaigns `PATCH /userprofiles/{+profileId}/campaigns` Updates an existing campaign. This method supports patch semantics. ## Path parameters - `profileId` string, required ## Query parameters - `id` string, required ## Request body - Campaign — Contains properties of a Campaign Manager campaign. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". - `subaccountId` string, int64 — Subaccount ID of this campaign. This is a read-only field that can be left blank. - `lastModifiedInfo` LastModifiedInfo — Modification timestamp. - `time` string, int64 — Timestamp of the last change in milliseconds since epoch. - `id` string, int64 — ID of this campaign. This is a read-only auto-generated field. - `eventTagOverrides` EventTagOverride[] — Overrides that can be used to activate or deactivate advertiser event tags. - `id` string, int64 — ID of this event tag override. This is a read-only, auto-generated field. - `enabled` boolean — Whether this override is enabled. - `defaultLandingPageId` string, int64 — The default landing page ID for this campaign. - `defaultClickThroughEventTagProperties` DefaultClickThroughEventTagProperties — Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. - `overrideInheritedEventTag` boolean — Whether this entity should override the inherited default click-through event tag with its own defined value. - `defaultClickThroughEventTagId` string, int64 — ID of the click-through event tag to apply to all ads in this entity's scope. - `name` string — Name of this campaign. This is a required field and must be less than 512 characters long and unique among campaigns of the same advertiser. - `accountId` string, int64 — Account ID of this campaign. This is a read-only field that can be left blank. - `startDate` string, date - `advertiserId` string, int64 — Advertiser ID of this campaign. This is a required field. - `audienceSegmentGroups` AudienceSegmentGroup[] — Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. - `id` string, int64 — ID of this audience segment group. This is a read-only, auto-generated field. - `name` string — Name of this audience segment group. This is a required field and must be less than 65 characters long. - `audienceSegments` AudienceSegment[] — Audience segments assigned to this group. The number of segments must be between 2 and 100. - `id` string, int64 — ID of this audience segment. This is a read-only, auto-generated field. - `name` string — Name of this audience segment. This is a required field and must be less than 65 characters long. - `allocation` integer — Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. - `adBlockingConfiguration` AdBlockingConfiguration — Campaign ad blocking settings. - `enabled` boolean — Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. - `additionalCreativeOptimizationConfigurations` CreativeOptimizationConfiguration[] — Additional creative optimization configurations for the campaign. - `id` string, int64 — ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. - `optimizationActivitys` OptimizationActivity[] — List of optimization activities associated with this configuration. - `weight` integer — Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. - `floodlightActivityId` string, int64 — Floodlight activity ID of this optimization activity. This is a required field. - `floodlightActivityIdDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `name` string — Name of this creative optimization config. This is a required field and must be less than 129 characters long. - `optimizationModel` 'CLICK' | 'POST_CLICK' | 'POST_IMPRESSION' | 'POST_CLICK_AND_IMPRESSION' | 'VIDEO_COMPLETION' — Optimization model for this configuration. - `comment` string — Arbitrary comments about this campaign. Must be less than 256 characters long. - `endDate` string, date - `clickThroughUrlSuffixProperties` ClickThroughUrlSuffixProperties — Click Through URL Suffix settings. - `overrideInheritedSuffix` boolean — Whether this entity should override the inherited click-through URL suffix with its own defined value. - `clickThroughUrlSuffix` string — Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. - `creativeOptimizationConfiguration` CreativeOptimizationConfiguration — Creative optimization settings. - `id` string, int64 — ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. - `optimizationActivitys` OptimizationActivity[] — List of optimization activities associated with this configuration. - `weight` integer — Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. - `floodlightActivityId` string, int64 — Floodlight activity ID of this optimization activity. This is a required field. - `floodlightActivityIdDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `name` string — Name of this creative optimization config. This is a required field and must be less than 129 characters long. - `optimizationModel` 'CLICK' | 'POST_CLICK' | 'POST_IMPRESSION' | 'POST_CLICK_AND_IMPRESSION' | 'VIDEO_COMPLETION' — Optimization model for this configuration. - `idDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `externalId` string — External ID for this campaign. - `createInfo` LastModifiedInfo — Modification timestamp. - `time` string, int64 — Timestamp of the last change in milliseconds since epoch. - `creativeGroupIds` string[] — List of creative group IDs that are assigned to the campaign. - `measurementPartnerLink` MeasurementPartnerCampaignLink - `partnerCampaignId` string — Partner campaign ID needed for establishing linking with Measurement partner. - `measurementPartner` 'NONE' | 'INTEGRAL_AD_SCIENCE' | 'DOUBLE_VERIFY' — Measurement partner used for tag wrapping. - `linkStatus` 'MEASUREMENT_PARTNER_UNLINKED' | 'MEASUREMENT_PARTNER_LINKED' | 'MEASUREMENT_PARTNER_LINK_PENDING' | 'MEASUREMENT_PARTNER_LINK_FAILURE' | 'MEASUREMENT_PARTNER_LINK_OPT_OUT' | 'MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING' | 'MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING' | 'MEASUREMENT_PARTNER_MODE_CHANGE_PENDING' | 'MEASUREMENT_PARTNER_UNLINK_PENDING' — . - `advertiserIdDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `advertiserGroupId` string, int64 — Advertiser group ID of the associated advertiser. - `archived` boolean — Whether this campaign has been archived. - `billingInvoiceCode` string — Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. - `euPoliticalAdsDeclaration` 'CONTAINS_EU_POLITICAL_ADS' | 'DOES_NOT_CONTAIN_EU_POLITICAL_ADS' — Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/dfareporting.md) · [All operations](https://skmtc.net/google/apis/dfareporting/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/dfareporting/revisions/8163d57aeb31/schema)