Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
campaigns

Updates an existing campaign. This method supports patch semantics.

patch/userprofiles/{+profileId}/campaigns

Path parameters

profileIdstring required

User profile ID associated with this request.

Query parameters

idstring required

Required. Campaign ID.

Request body

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".

subaccountIdstring int64

Subaccount ID of this campaign. This is a read-only field that can be left blank.

idstring int64

ID of this campaign. This is a read-only auto-generated field.

defaultLandingPageIdstring int64

The default landing page ID for this campaign.

namestring

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.

accountIdstring int64

Account ID of this campaign. This is a read-only field that can be left blank.

startDatestring date
advertiserIdstring int64

Advertiser ID of this campaign. This is a required field.

commentstring

Arbitrary comments about this campaign. Must be less than 256 characters long.

endDatestring date
externalIdstring

External ID for this campaign.

creativeGroupIdsstring[]

List of creative group IDs that are assigned to the campaign.

advertiserGroupIdstring int64

Advertiser group ID of the associated advertiser.

archivedboolean

Whether this campaign has been archived.

billingInvoiceCodestring

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

Successful response