Method: targetingTypes.targetingOptions.search

Поиск вариантов таргетинга заданного типа на основе заданных поисковых терминов.

HTTP-запрос

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

URL использует синтаксис перекодировки gRPC .

Параметры пути

Параметры
targetingType

enum ( TargetingType )

Обязательно. Тип параметров таргетинга, которые необходимо получить.

Принятые значения:

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

Текст запроса

Тело запроса содержит данные со следующей структурой:

JSON-представление 
{
  "advertiserId": string,
  "pageSize": integer,
  "pageToken": string,

  // Union field search_terms can be only one of the following:
  "poiSearchTerms": {
    object (PoiSearchTerms)
  },
  "businessChainSearchTerms": {
    object (BusinessChainSearchTerms)
  },
  "geoRegionSearchTerms": {
    object (GeoRegionSearchTerms)
  }
  // End of list of possible types for union field search_terms.
}
Поля
advertiserId

string ( int64 format)

Обязательно. Рекламодатель, в контексте которого сделан этот запрос.

pageSize

integer

Запрошенный размер страницы. Должен быть от 1 до 200 Если не указан, по умолчанию будет 100 Возвращает код ошибки INVALID_ARGUMENT если указано недопустимое значение.

pageToken

string

Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken , возвращаемое предыдущим вызовом метода targetingOptions.search . Если не указано иное, будет возвращена первая страница результатов.

Поле объединения search_terms . Запросы для поиска вариантов таргетинга. В search_terms можно заполнить только одно поле, которое должно соответствовать targeting_type . search_terms может быть только одним из следующих:
poiSearchTerms

object ( PoiSearchTerms )

Поисковые запросы для параметров таргетинга на POI. Можно использовать только если targetingType — TARGETING_TYPE_POI .

businessChainSearchTerms

object ( BusinessChainSearchTerms )

Поисковые запросы для параметров таргетинга Business Chain. Можно использовать только если targetingType — TARGETING_TYPE_BUSINESS_CHAIN ​​.

geoRegionSearchTerms

object ( GeoRegionSearchTerms )

Поисковые запросы для параметров таргетинга по георегиону. Можно использовать только если targetingType — TARGETING_TYPE_GEO_REGION .

Тело ответа

Ответное сообщение для targetingOptions.search .

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
Поля
targetingOptions[]

object ( TargetingOption )

Список вариантов таргетинга, соответствующих критериям поиска.

Если список пуст, он будет отсутствовать.

nextPageToken

string

Токен для получения следующей страницы результатов. Передайте это значение в поле pageToken при последующем вызове метода targetingOptions.search для получения следующей страницы результатов.

Области авторизации

Требуется следующая область OAuth:

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

Для получения более подробной информации см.OAuth 2.0 Overview .

PoiSearchTerms

Поисковые запросы для выбора точек интереса.

JSON-представление 
{
  "poiQuery": string
}
Поля
poiQuery

string

Поисковый запрос по названию, адресу или координатам интересующей вас точки интереса. Запрос может содержать префикс, например, «Таймс-сквер», «40.7505045,-73.99562», «315 W 44th St» и т. д.

BusinessChainSearchTerms

Поисковые запросы для вариантов таргетинга Business Chain.

По крайней мере одно поле должно быть заполнено.

JSON-представление 
{
  "businessChainQuery": string,
  "regionQuery": string
}
Поля
businessChainQuery

string

Поисковый запрос для нужной сети предприятий. Запрос должен содержать полное название предприятия, например, «KFC», «Mercedes-Benz».

regionQuery

string

Поисковый запрос для нужного георегиона, например «Сиэтл», «США».

GeoRegionSearchTerms

Поисковые запросы для вариантов таргетинга по георегиону.

JSON-представление 
{
  "geoRegionQuery": string
}
Поля
geoRegionQuery

string

Поисковый запрос для нужного георегиона. Запрос может быть префиксом, например, «Нью-Йорк», «Сиэтл», «США» и т. д.