Method: targetingTypes.targetingOptions.search

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

HTTP-запрос

POST https://displayvideo.googleapis.com/v1/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 )

Условия поиска для вариантов таргетинга на бизнес-цепочку. Можно использовать только в том случае, если 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 .

PoiSearchУсловия

Условия поиска для параметров таргетинга на POI.

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

string

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

БизнесСетьПоискУсловия

Условия поиска для вариантов таргетинга на бизнес-цепочку.

Хотя бы одно поле должно быть заполнено.

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

string

Поисковый запрос по нужной бизнес-цепочке. В запросе должно быть полное название компании, например «KFC», «mercedes-Benz».

regionQuery

string

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

ГеоРегионПоискУсловия

Условия поиска для параметров таргетинга на географический регион.

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

string

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