Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13177414729.5 KB
advertisers

Updates an existing campaign. Returns the updated campaign if successful.

patch/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}

Path parameters

advertiserIdstring required

Output only. The unique ID of the advertiser the campaign belongs to.

campaignIdstring required

Output only. The unique ID of the campaign. Assigned by the system.

Query parameters

updateMaskstring

Required. The mask to control which fields to update.

Request body

campaignIdstring int64

Output only. The unique ID of the campaign. Assigned by the system.

displayNamestring

Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.

updateTimestring google-datetime

Output only. The timestamp when the campaign was last updated. Assigned by the system.

advertiserIdstring int64

Output only. The unique ID of the advertiser the campaign belongs to.

entityStatus'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION'

Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, and ENTITY_STATUS_PAUSED. * For CreateCampaign method, ENTITY_STATUS_ARCHIVED is not allowed.

namestring

Output only. The resource name of the campaign.

Response

Successful response