Method: targetingTypes.targetingOptions.search

Wyszukuje opcje kierowania danego typu na podstawie podanych wyszukiwanych słów.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
targetingType

enum (TargetingType)

Wymagane. Typ opcji kierowania do pobrania.

Akceptowane wartości:

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis 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.
}
Pola
advertiserId

string (int64 format)

Wymagane. Reklamodawca, w kontekście którego wysyłane jest to żądanie.
pageSize

integer

Żądany rozmiar strony. Musi należeć do przedziału od 1 do 200. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna 100. Jeśli podano nieprawidłową wartość, zwraca kod błędu INVALID_ARGUMENT.
pageToken

string

Token identyfikujący stronę wyników, którą serwer powinien zwrócić. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody targetingOptions.search. Jeśli nie zostanie określona, zwracana jest pierwsza strona wyników.
Pole zbiorcze search_terms. Zapytania, za pomocą których można wyszukiwać opcje kierowania. Można wypełnić tylko jedno pole w search_terms, które musi odpowiadać polu targeting_type. search_terms może mieć tylko jedną z tych wartości:
poiSearchTerms

object (PoiSearchTerms)

Wyszukiwane hasła dotyczące opcji kierowania na miejsca. Można jej używać tylko wtedy, gdy targetingType jest TARGETING_TYPE_POI.
businessChainSearchTerms

object (BusinessChainSearchTerms)

Wyszukiwane hasła do opcji kierowania na sieć placówek. Można jej używać tylko wtedy, gdy targetingType jest TARGETING_TYPE_BUSINESS_CHAIN.
geoRegionSearchTerms

object (GeoRegionSearchTerms)

Terminy wyszukiwania opcji kierowania na region geograficzny. Można jej używać tylko wtedy, gdy targetingType jest TARGETING_TYPE_GEO_REGION.

Treść odpowiedzi

Wiadomość z odpowiedzią dla targetingOptions.search.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
Pola
targetingOptions[]

object (TargetingOption)

Lista opcji kierowania pasujących do kryteriów wyszukiwania.

Jeśli lista jest pusta, nie będzie jej w odpowiedzi.
nextPageToken

string

Token do pobierania następnej strony wyników. Przekaż tę wartość w polu pageToken w kolejnym wywołaniu metody targetingOptions.search, aby pobrać następną stronę wyników.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.

PoiSearchTerms

Wyszukiwane hasła dotyczące opcji kierowania na miejsca.

Zapis JSON 
{
  "poiQuery": string
}
Pola
poiQuery

string

Zapytanie wyszukiwania dotyczące nazwy, adresu lub współrzędnych wybranego punktu POI. Zapytanie może być prefiksem, np. „Times squar”, „40.7505045,-73.99562”, „315 W 44th St” itp.

BusinessChainSearchTerms

Wyszukiwane hasła do opcji kierowania na sieć placówek.

Musisz wypełnić co najmniej jedno pole.

Zapis JSON 
{
  "businessChainQuery": string,
  "regionQuery": string
}
Pola
businessChainQuery

string

Wyszukiwane hasło dla wybranej sieci firm. Zapytanie musi zawierać pełną nazwę firmy, np. „KFC”, „mercedes-benz”.
regionQuery

string

Zapytanie wyszukiwania dotyczące wybranego regionu geograficznego, np. „Seattle”, „Stany Zjednoczone”.

GeoRegionSearchTerms

Terminy wyszukiwania opcji kierowania na region geograficzny.

Zapis JSON 
{
  "geoRegionQuery": string
}
Pola
geoRegionQuery

string

Zapytanie wyszukiwania dotyczące wybranego regionu geograficznego. Zapytanie może być prefiksem, np. „New Yor”, „Seattle”, „USA” itp.