Method: targetingTypes.targetingOptions.search

Searches for targeting options of a given type based on the given search terms.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
targetingType

enum (TargetingType)

Required. The type of targeting options to retrieve.

Accepted values are:

  • TARGETING_TYPE_GEO_REGION

Request body

The request body contains data with the following structure:

JSON representation
{
  "advertiserId": string,
  "pageSize": integer,
  "pageToken": string,
  "geoRegionSearchTerms": {
    object (GeoRegionSearchTerms)
  }
}
Fields
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 100. 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.search method. If not specified, the first page of results will be returned.

geoRegionSearchTerms

object (GeoRegionSearchTerms)

Search terms for geo region targeting options. Can only be used when targetingType is TARGETING_TYPE_GEO_REGION.

Response body

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

Response message for [SearchTargetingOptionsResponse][TargetingOptionsService.SearchTargetingOptionsResponse].

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

object (TargetingOption)

The list of targeting options that match the search criteria.

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.search 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.

GeoRegionSearchTerms

Search terms for geo region targeting options.

JSON representation
{
  "geoRegionQuery": string
}
Fields
geoRegionQuery

string

The search query for the desired geo region. The query can be a prefix, e.g. "New Yor", "Seattle", "USA", etc.