Display & Video 360 API (displayvideo:v3)

Additions

Methods


• ▼ ▲ displayvideo.advertisers.adGroupAds.delete

  Description : Deletes an ad group ad.

  Parameters :

  advertiserId

  Required : Yes

  Format : int64

  Description : Required. The ID of the advertiser the ad belongs to.

  Location : path

  Pattern : ^[^/]+$

  Type : string

  adGroupAdId

  Type : string

  Location : path

  Pattern : ^[^/]+$

  Description : Required. The ID of the ad to delete.

  Required : Yes

  Format : int64

  Flat Path : v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}

  Scopes : https://www.googleapis.com/auth/display-video

  Path : v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}

  HTTP Method : DELETE

  Parameter Order :

  • advertiserId
  • adGroupAdId

• ▼ ▲ displayvideo.advertisers.adGroupAds.patch

  Path : v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}

  HTTP Method : PATCH

  Parameter Order :

  • advertiserId
  • adGroupAdId

  Scopes : https://www.googleapis.com/auth/display-video

  Parameters :

  adGroupAdId

  Required : Yes

  Format : int64

  Description : Output only. The unique ID of the ad. Assigned by the system.

  Pattern : ^[^/]+$

  Location : path

  Type : string

  updateMask

  Format : google-fieldmask

  Location : query

  Description : Required. The mask to control which fields to update.

  Type : string

  advertiserId

  Pattern : ^[^/]+$

  Location : path

  Type : string

  Required : Yes

  Format : int64

  Description : Output only. The unique ID of the advertiser the ad belongs to.

  Description : Updates an ad group ad.

  Flat Path : v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}

• ▼ ▲ displayvideo.advertisers.adGroupAds.create

  Path : v3/advertisers/{+advertiserId}/adGroupAds

  HTTP Method : POST

  Parameter Order : advertiserId

  Description : Creates an ad group ad.

  Parameters :

  advertiserId

  Required : Yes

  Format : int64

  Description : Output only. The unique ID of the advertiser the ad belongs to.

  Pattern : ^[^/]+$

  Location : path

  Type : string

  Flat Path : v3/advertisers/{advertisersId}/adGroupAds

  Scopes : https://www.googleapis.com/auth/display-video

• ▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create

  Description : Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

  Parameters :

  targetingType

  Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`

  Required : Yes

  Type : string

  Pattern : ^[^/]+$

  Enum Descriptions :

  • Default value when type is not specified or is unknown in this version.
  • Target a channel (a custom group of related websites or apps).
  • Target an app category (for example, education or puzzle games).
  • Target a specific app (for example, Angry Birds).
  • Target a specific url (for example, quora.com).
  • Target ads during a chosen time period on a specific day.
  • Target ads to a specific age range (for example, 18-24).
  • Target ads to the specified regions on a regional location list.
  • Target ads to the specified points of interest on a proximity location list.
  • Target ads to a specific gender (for example, female or male).
  • Target a specific video player size for video ads.
  • Target user rewarded content for video ads.
  • Target ads to a specific parental status (for example, parent or not a parent).
  • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
  • Target ads in a specific content outstream position.
  • Target ads to a specific device type (for example, tablet or connected TV).
  • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
  • Target ads to specific web browsers (for example, Chrome).
  • Target ads to a specific household income range (for example, top 10%).
  • Target ads in a specific on screen position.
  • Filter web sites through third party verification (for example, IAS or DoubleVerify).
  • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
  • Filter website content by sensitive categories (for example, adult).
  • Target ads to a specific environment (for example, web or app).
  • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
  • Target ads to a specific operating system (for example, macOS).
  • Target ads to a specific device make or model (for example, Roku or Samsung).
  • Target ads to a specific keyword (for example, dog or retriever).
  • Target ads to a specific negative keyword list.
  • Target ads to a specific viewability (for example, 80% viewable).
  • Target ads to a specific content category (for example, arts & entertainment).
  • Purchase impressions from specific deals and auction packages.
  • Target ads to a specific language (for example, English or Japanese).
  • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
  • Target ads to a specific regional location (for example, a city or state).
  • Purchase impressions from a group of deals and auction packages.
  • Purchase impressions from specific exchanges.
  • Purchase impressions from specific sub-exchanges.
  • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
  • Target ads around locations of a business chain within a specific geo region.
  • Target ads to a specific video content duration.
  • Target ads to a specific video content stream type.
  • Target ads to a specific native content position.
  • Target ads in an Open Measurement enabled inventory.
  • Target ads to a specific audio content type.
  • Target ads to a specific content genre.
  • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
  • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
  • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
  • Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.

  Location : path

  Enum :

  • TARGETING_TYPE_UNSPECIFIED
  • TARGETING_TYPE_CHANNEL
  • TARGETING_TYPE_APP_CATEGORY
  • TARGETING_TYPE_APP
  • TARGETING_TYPE_URL
  • TARGETING_TYPE_DAY_AND_TIME
  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_REGIONAL_LOCATION_LIST
  • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_USER_REWARDED_CONTENT
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_AUDIENCE_GROUP
  • TARGETING_TYPE_BROWSER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_ON_SCREEN_POSITION
  • TARGETING_TYPE_THIRD_PARTY_VERIFIER
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_CARRIER_AND_ISP
  • TARGETING_TYPE_OPERATING_SYSTEM
  • TARGETING_TYPE_DEVICE_MAKE_MODEL
  • TARGETING_TYPE_KEYWORD
  • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
  • TARGETING_TYPE_VIEWABILITY
  • TARGETING_TYPE_CATEGORY
  • TARGETING_TYPE_INVENTORY_SOURCE
  • TARGETING_TYPE_LANGUAGE
  • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_SUB_EXCHANGE
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN
  • TARGETING_TYPE_CONTENT_DURATION
  • TARGETING_TYPE_CONTENT_STREAM_TYPE
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID
  • TARGETING_TYPE_AUDIO_CONTENT_TYPE
  • TARGETING_TYPE_CONTENT_GENRE
  • TARGETING_TYPE_YOUTUBE_VIDEO
  • TARGETING_TYPE_YOUTUBE_CHANNEL
  • TARGETING_TYPE_SESSION_POSITION
  • TARGETING_TYPE_CONTENT_THEME_EXCLUSION

  advertiserId

  Description : Required. The ID of the advertiser the ad group belongs to.

  Required : Yes

  Format : int64

  Type : string

  Location : path

  Pattern : ^[^/]+$

  adGroupId

  Location : path

  Pattern : ^[^/]+$

  Type : string

  Required : Yes

  Format : int64

  Description : Required. The ID of the ad group the assigned targeting option will belong to.

  Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

  Scopes : https://www.googleapis.com/auth/display-video

  Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions

  HTTP Method : POST

  Parameter Order :

  • advertiserId
  • adGroupId
  • targetingType

• ▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete

  Parameters :

  advertiserId

  Type : string

  Pattern : ^[^/]+$

  Location : path

  Description : Required. The ID of the advertiser the ad group belongs to.

  Required : Yes

  Format : int64

  adGroupId

  Required : Yes

  Format : int64

  Description : Required. The ID of the ad group the assigned targeting option belongs to.

  Pattern : ^[^/]+$

  Location : path

  Type : string

  assignedTargetingOptionId

  Required : Yes

  Description : Required. The ID of the assigned targeting option to delete.

  Location : path

  Pattern : ^[^/]+$

  Type : string

  targetingType

  Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`

  Required : Yes

  Type : string

  Location : path

  Enum :

  • TARGETING_TYPE_UNSPECIFIED
  • TARGETING_TYPE_CHANNEL
  • TARGETING_TYPE_APP_CATEGORY
  • TARGETING_TYPE_APP
  • TARGETING_TYPE_URL
  • TARGETING_TYPE_DAY_AND_TIME
  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_REGIONAL_LOCATION_LIST
  • TARGETING_TYPE_PROXIMITY_LOCATION_LIST
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_USER_REWARDED_CONTENT
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_AUDIENCE_GROUP
  • TARGETING_TYPE_BROWSER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_ON_SCREEN_POSITION
  • TARGETING_TYPE_THIRD_PARTY_VERIFIER
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_CARRIER_AND_ISP
  • TARGETING_TYPE_OPERATING_SYSTEM
  • TARGETING_TYPE_DEVICE_MAKE_MODEL
  • TARGETING_TYPE_KEYWORD
  • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
  • TARGETING_TYPE_VIEWABILITY
  • TARGETING_TYPE_CATEGORY
  • TARGETING_TYPE_INVENTORY_SOURCE
  • TARGETING_TYPE_LANGUAGE
  • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_INVENTORY_SOURCE_GROUP
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_SUB_EXCHANGE
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN
  • TARGETING_TYPE_CONTENT_DURATION
  • TARGETING_TYPE_CONTENT_STREAM_TYPE
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID
  • TARGETING_TYPE_AUDIO_CONTENT_TYPE
  • TARGETING_TYPE_CONTENT_GENRE
  • TARGETING_TYPE_YOUTUBE_VIDEO
  • TARGETING_TYPE_YOUTUBE_CHANNEL
  • TARGETING_TYPE_SESSION_POSITION
  • TARGETING_TYPE_CONTENT_THEME_EXCLUSION

  Pattern : ^[^/]+$

  Enum Descriptions :

  • Default value when type is not specified or is unknown in this version.
  • Target a channel (a custom group of related websites or apps).
  • Target an app category (for example, education or puzzle games).
  • Target a specific app (for example, Angry Birds).
  • Target a specific url (for example, quora.com).
  • Target ads during a chosen time period on a specific day.
  • Target ads to a specific age range (for example, 18-24).
  • Target ads to the specified regions on a regional location list.
  • Target ads to the specified points of interest on a proximity location list.
  • Target ads to a specific gender (for example, female or male).
  • Target a specific video player size for video ads.
  • Target user rewarded content for video ads.
  • Target ads to a specific parental status (for example, parent or not a parent).
  • Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
  • Target ads in a specific content outstream position.
  • Target ads to a specific device type (for example, tablet or connected TV).
  • Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
  • Target ads to specific web browsers (for example, Chrome).
  • Target ads to a specific household income range (for example, top 10%).
  • Target ads in a specific on screen position.
  • Filter web sites through third party verification (for example, IAS or DoubleVerify).
  • Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
  • Filter website content by sensitive categories (for example, adult).
  • Target ads to a specific environment (for example, web or app).
  • Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
  • Target ads to a specific operating system (for example, macOS).
  • Target ads to a specific device make or model (for example, Roku or Samsung).
  • Target ads to a specific keyword (for example, dog or retriever).
  • Target ads to a specific negative keyword list.
  • Target ads to a specific viewability (for example, 80% viewable).
  • Target ads to a specific content category (for example, arts & entertainment).
  • Purchase impressions from specific deals and auction packages.
  • Target ads to a specific language (for example, English or Japanese).
  • Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
  • Target ads to a specific regional location (for example, a city or state).
  • Purchase impressions from a group of deals and auction packages.
  • Purchase impressions from specific exchanges.
  • Purchase impressions from specific sub-exchanges.
  • Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
  • Target ads around locations of a business chain within a specific geo region.
  • Target ads to a specific video content duration.
  • Target ads to a specific video content stream type.
  • Target ads to a specific native content position.
  • Target ads in an Open Measurement enabled inventory.
  • Target ads to a specific audio content type.
  • Target ads to a specific content genre.
  • Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
  • Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
  • Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
  • Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.

  Description : Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

  Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

  Scopes : https://www.googleapis.com/auth/display-video

  Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

  HTTP Method : DELETE

  Parameter Order :

  • advertiserId
  • adGroupId
  • targetingType
  • assignedTargetingOptionId

• ▼ ▲ displayvideo.advertisers.adGroups.create

  Parameter Order : advertiserId

  Path : v3/advertisers/{+advertiserId}/adGroups

  HTTP Method : POST

  Scopes : https://www.googleapis.com/auth/display-video

  Flat Path : v3/advertisers/{advertisersId}/adGroups

  Parameters :

  advertiserId

  Pattern : ^[^/]+$

  Location : path

  Type : string

  Required : Yes

  Format : int64

  Description : Output only. The unique ID of the advertiser the ad group belongs to.

  Description : Creates a new ad group. Returns the newly created ad group if successful.

• ▼ ▲ displayvideo.advertisers.adGroups.patch

  Parameter Order :

  • advertiserId
  • adGroupId

  Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}

  HTTP Method : PATCH

  Scopes : https://www.googleapis.com/auth/display-video

  Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}

  Description : Updates an existing ad group. Returns the updated ad group if successful.

  Parameters :

  updateMask

  Description : Required. The mask to control which fields to update.

  Type : string

  Format : google-fieldmask

  Location : query

  advertiserId

  Description : Output only. The unique ID of the advertiser the ad group belongs to.

  Required : Yes

  Format : int64

  Type : string

  Pattern : ^[^/]+$

  Location : path

  adGroupId

  Location : path

  Pattern : ^[^/]+$

  Type : string

  Required : Yes

  Format : int64

  Description : Output only. The unique ID of the ad group. Assigned by the system.

• ▼ ▲ displayvideo.advertisers.adGroups.delete

  Scopes : https://www.googleapis.com/auth/display-video

  Description : Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.

  Parameters :

  advertiserId

  Type : string

  Pattern : ^[^/]+$

  Location : path

  Description : Required. The ID of the advertiser this ad group belongs to.

  Required : Yes

  Format : int64

  adGroupId

  Type : string

  Location : path

  Pattern : ^[^/]+$

  Description : Required. The ID of the ad group to delete.

  Required : Yes

  Format : int64

  Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}

  Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}

  HTTP Method : DELETE

  Parameter Order :

  • advertiserId
  • adGroupId

• ▼ ▲ displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions

  Description : Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

  Parameters :

  advertiserId

  Required : Yes

  Format : int64

  Description : Required. The ID of the advertiser the ad groups belong to.

  Pattern : ^[^/]+$

  Location : path

  Type : string

  Flat Path : v3/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions

  Scopes : https://www.googleapis.com/auth/display-video

  Path : v3/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions

  HTTP Method : POST

  Parameter Order : advertiserId