advertisers

POST /v4/advertisers/{advertisersId}/campaigns

Creates a new campaign. Returns the newly created campaign if successful.

Request

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

Path parameters

advertisersIdstring required

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

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.

Changes

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