Display & Video 360 API (displayvideo:v4)

Deletions

Methods


• ▼ ▲ displayvideo.advertisers.lineItems.generateDefault

  HTTP Method : POST

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

  Description : Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.

  Parameters :

  advertiserId

  Format : int64

  Description : Required. The ID of the advertiser this line item belongs to.

  Required : Yes

  Location : path

  Pattern : ^[^/]+$

  Type : string

  Flat Path : v4/advertisers/{advertisersId}/lineItems:generateDefault

  Parameter Order : advertiserId

  Path : v4/advertisers/{+advertiserId}/lineItems:generateDefault

• ▼ ▲ displayvideo.advertisers.insertionOrders.listAssignedTargetingOptions

  Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}:listAssignedTargetingOptions

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

  Parameters :

  pageToken

  Description : A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

  Location : query

  Type : string

  advertiserId

  Location : path

  Format : int64

  Pattern : ^[^/]+$

  Description : Required. The ID of the advertiser the insertion order belongs to.

  Type : string

  Required : Yes

  pageSize

  Description : Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

  Type : integer

  Format : int32

  Location : query

  insertionOrderId

  Required : Yes

  Pattern : ^[^/]+$

  Location : path

  Type : string

  Description : Required. The ID of the insertion order to list assigned targeting options for.

  Format : int64

  orderBy

  Description : Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.

  Type : string

  Location : query

  filter

  Location : query

  Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

  Type : string

  HTTP Method : GET

  Description : Lists assigned targeting options of an insertion order across targeting types.

  Parameter Order :

  • advertiserId
  • insertionOrderId

  Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions

• ▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.get

  Description : Gets a single targeting option assigned to an insertion order.

  Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

  HTTP Method : GET

  Parameters :

  advertiserId

  Pattern : ^[^/]+$

  Required : Yes

  Format : int64

  Location : path

  Type : string

  Description : Required. The ID of the advertiser the insertion order belongs to.

  assignedTargetingOptionId

  Location : path

  Pattern : ^[^/]+$

  Type : string

  Required : Yes

  Description : Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested.

  insertionOrderId

  Location : path

  Pattern : ^[^/]+$

  Required : Yes

  Format : int64

  Type : string

  Description : Required. The ID of the insertion order the assigned targeting option belongs to.

  targetingType

  Description : Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`

  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.

  Type : string

  Required : Yes

  Location : path

  Pattern : ^[^/]+$

  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

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

  Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

  Parameter Order :

  • advertiserId
  • insertionOrderId
  • targetingType
  • assignedTargetingOptionId

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

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

  HTTP Method : DELETE

  Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

  Parameter Order :

  • advertiserId
  • insertionOrderId
  • targetingType
  • assignedTargetingOptionId

  Description : Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`

  Parameters :

  targetingType

  Required : Yes

  Pattern : ^[^/]+$

  Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`

  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

  Location : path

  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.

  Type : string

  advertiserId

  Description : Required. The ID of the advertiser the insertion order belongs to.

  Pattern : ^[^/]+$

  Required : Yes

  Format : int64

  Location : path

  Type : string

  assignedTargetingOptionId

  Location : path

  Pattern : ^[^/]+$

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

  Type : string

  Required : Yes

  insertionOrderId

  Required : Yes

  Pattern : ^[^/]+$

  Type : string

  Location : path

  Description : Required. The ID of the insertion order the assigned targeting option belongs to.

  Format : int64

  Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

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

  Parameters :

  insertionOrderId

  Pattern : ^[^/]+$

  Required : Yes

  Type : string

  Description : Required. The ID of the insertion order the assigned targeting option will belong to.

  Format : int64

  Location : path

  advertiserId

  Pattern : ^[^/]+$

  Description : Required. The ID of the advertiser the insertion order belongs to.

  Required : Yes

  Format : int64

  Location : path

  Type : string

  targetingType

  Pattern : ^[^/]+$

  Type : string

  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

  Location : path

  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 : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`

  Required : Yes

  Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

  Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions

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

  HTTP Method : POST

  Description : Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`

  Parameter Order :

  • advertiserId
  • insertionOrderId
  • targetingType

• ▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list

  Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions

  Parameter Order :

  • advertiserId
  • insertionOrderId
  • targetingType

  HTTP Method : GET

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

  Description : Lists the targeting options assigned to an insertion order.

  Parameters :

  pageToken

  Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

  Type : string

  Location : query

  orderBy

  Location : query

  Type : string

  Description : Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.

  filter

  Location : query

  Type : string

  Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

  pageSize

  Type : integer

  Description : Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

  Location : query

  Format : int32

  advertiserId

  Pattern : ^[^/]+$

  Format : int64

  Type : string

  Description : Required. The ID of the advertiser the insertion order belongs to.

  Required : Yes

  Location : path

  insertionOrderId

  Location : path

  Format : int64

  Required : Yes

  Type : string

  Pattern : ^[^/]+$

  Description : Required. The ID of the insertion order to list assigned targeting options for.

  targetingType

  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.

  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

  Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`

  Location : path

  Pattern : ^[^/]+$

  Type : string

  Required : Yes

  Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

• ▼ ▲ displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.get

  Parameter Order :

  • advertiserId
  • campaignId
  • targetingType
  • assignedTargetingOptionId

  Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}

  Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}

  Description : Gets a single targeting option assigned to a campaign.

  HTTP Method : GET

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

  Parameters :

  assignedTargetingOptionId

  Location : path

  Type : string

  Required : Yes

  Pattern : ^[^/]+$

  Description : Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested.

  advertiserId

  Format : int64

  Pattern : ^[^/]+$

  Location : path

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

  Type : string

  Required : Yes

  campaignId

  Required : Yes

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

  Format : int64

  Type : string

  Pattern : ^[^/]+$

  Location : path

  targetingType

  Type : string

  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

  Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY`

  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.

  Pattern : ^[^/]+$

  Required : Yes

  Location : path

• ▼ ▲ displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list

  Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions

  Description : Lists the targeting options assigned to a campaign for a specified targeting type.

  Parameter Order :

  • advertiserId
  • campaignId
  • targetingType

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

  HTTP Method : GET

  Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions

  Parameters :

  pageToken

  Type : string

  Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

  Location : query

  campaignId

  Required : Yes

  Location : path

  Description : Required. The ID of the campaign to list assigned targeting options for.

  Format : int64

  Type : string

  Pattern : ^[^/]+$

  targetingType

  Pattern : ^[^/]+$

  Type : string

  Required : Yes

  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 : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY`

  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

  orderBy

  Description : Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.

  Type : string

  Location : query

  advertiserId

  Required : Yes

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

  Location : path

  Type : string

  Pattern : ^[^/]+$

  Format : int64

  pageSize

  Description : Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

  Location : query

  Type : integer

  Format : int32

  filter

  Type : string

  Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

  Location : query

• ▼ ▲ displayvideo.advertisers.campaigns.listAssignedTargetingOptions

  Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions

  Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}:listAssignedTargetingOptions

  Parameters :

  orderBy

  Description : Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.

  Location : query

  Type : string

  pageToken

  Description : A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.

  Type : string

  Location : query

  campaignId

  Type : string

  Required : Yes

  Pattern : ^[^/]+$

  Description : Required. The ID of the campaign to list assigned targeting options for.

  Location : path

  Format : int64

  filter

  Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.

  Location : query

  Type : string

  advertiserId

  Format : int64

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

  Pattern : ^[^/]+$

  Type : string

  Location : path

  Required : Yes

  pageSize

  Format : int32

  Type : integer

  Description : Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

  Location : query

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

  HTTP Method : GET

  Description : Lists assigned targeting options of a campaign across targeting types.

  Parameter Order :

  • advertiserId
  • campaignId