GOgoogle
campaigns

PUT /userprofiles/{userprofilesId}/campaigns

Updates an existing campaign.

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Request body

accountIdstring int64

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

advertiserGroupIdstring int64

Advertiser group ID of the associated advertiser.

advertiserIdstring int64

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

archivedboolean

Whether this campaign has been archived.

billingInvoiceCodestring

Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.

commentstring

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

creativeGroupIdsstring[]

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

defaultLandingPageIdstring int64

The default landing page ID for this campaign.

endDatestring date
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.

externalIdstring

External ID for this campaign.

idstring int64

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

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#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.

startDatestring date
subaccountIdstring int64

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

Response

Successful response

accountIdstring int64

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

advertiserGroupIdstring int64

Advertiser group ID of the associated advertiser.

advertiserIdstring int64

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

archivedboolean

Whether this campaign has been archived.

billingInvoiceCodestring

Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.

commentstring

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

creativeGroupIdsstring[]

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

defaultLandingPageIdstring int64

The default landing page ID for this campaign.

endDatestring date
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.

externalIdstring

External ID for this campaign.

idstring int64

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

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#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.

startDatestring date
subaccountIdstring int64

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

Changes

No recorded changes to this operation across all 5 revisions of this API.