advertisers

Changed on

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

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

Request

  • Base URL: https://displayvideo.googleapis.com
  • URL: https://displayvideo.googleapis.com/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/display-video) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/display-video)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/display-video-mediaplanning) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/display-video-mediaplanning)

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

advertiserIdstring int64

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

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.

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.

updateTimestring google-datetime

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

Response

Successful response

Changes

  • 6329126f9fb6Revision changes
    • info

      the security scope https://www.googleapis.com/auth/display-video was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/display-video was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/display-video-mediaplanning was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/display-video-mediaplanning was removed from the endpoint's security scheme Oauth2c

  • 583e0cff0ab9Revision changes
    • info

      the security scope https://www.googleapis.com/auth/display-video was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/display-video was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/display-video-mediaplanning was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/display-video-mediaplanning was removed from the endpoint's security scheme Oauth2c