Method: targetingTypes.targetingOptions.list

  • This document details the process for listing targeting options for a specific type using the Display & Video 360 API v1.

  • The Display & Video 360 API v1 has been sunset.

  • The request is made using an HTTP GET method to a specified URL which utilizes gRPC Transcoding syntax.

  • The type of targeting option to be listed is a required path parameter.

  • The request requires specifying the advertiser ID and allows for pagination, sorting, and filtering of results through query parameters.

Lists targeting options of a given type.

HTTP request

GET https://displayvideo.googleapis.com/v1/targetingTypes/{targetingType}/targetingOptions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
targetingType

enum (TargetingType)

Required. The type of targeting option to be listed.

Accepted values are:

  • TARGETING_TYPE_APP_CATEGORY
  • TARGETING_TYPE_AGE_RANGE
  • 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_BROWSER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_ON_SCREEN_POSITION
  • TARGETING_TYPE_CARRIER_AND_ISP
  • TARGETING_TYPE_OPERATING_SYSTEM
  • TARGETING_TYPE_DEVICE_MAKE_MODEL
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_CATEGORY
  • TARGETING_TYPE_VIEWABILITY
  • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
  • TARGETING_TYPE_LANGUAGE
  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_SUB_EXCHANGE
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID

Query parameters

Parameters
advertiserId

string (int64 format)

Required. The Advertiser this request is being made in the context of.
pageSize

integer

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

string

A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to targetingOptions.list method. If not specified, the first page of results will be returned.
orderBy

string

Field by which to sort the list. Acceptable values are:

  • targetingOptionId (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: targetingOptionId desc.
filter

string

Allows filtering by targeting option fields.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by OR logical operators.
  • A restriction has the form of {field} {operator} {value}.
  • All fields must use the EQUALS (=) operator.

Supported fields:

  • carrierAndIspDetails.type
  • geoRegionDetails.geoRegionType
  • targetingOptionId

Examples:

  • All GEO REGION targeting options that belong to sub type GEO_REGION_TYPE_COUNTRY or GEO_REGION_TYPE_STATE: geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"
  • All CARRIER AND ISP targeting options that belong to sub type CARRIER_AND_ISP_TYPE_CARRIER: carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"

The length of this field should be no more than 500 characters.

Reference our filter LIST requests guide for more information.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for targetingOptions.list.

JSON representation 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
Fields
targetingOptions[]

object (TargetingOption)

The list of targeting options.

This list will be absent if empty.
nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to targetingOptions.list method to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.