Method: targetingTypes.targetingOptions.search

Wyszukiwanie opcji kierowania danego typu na podstawie podanych wyszukiwanych haseł.

Żądanie HTTP

POST https://displayvideo.googleapis.com/v4/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, którego dotyczy prośba.
pageSize

integer

Żądany rozmiar strony. Wartość musi się mieścić w zakresie 1–200. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna 100. Jeśli podana zostanie nieprawidłowa 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ślony, zwrócona zostanie pierwsza strona wyników.
Pole unii search_terms. Zapytania, za pomocą których można wyszukiwać opcje kierowania. W polu search_terms może być wypełnione tylko jedno pole, które musi odpowiadać polu targeting_type. search_terms może być tylko jednym z tych elementów:
poiSearchTerms

object (PoiSearchTerms)

wyszukiwane hasła dotyczące opcji kierowania na punkty POI; Można go używać tylko wtedy, gdy targetingType to TARGETING_TYPE_POI.
businessChainSearchTerms

object (BusinessChainSearchTerms)

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

object (GeoRegionSearchTerms)

Wyszukaj hasła dotyczące opcji kierowania na region geograficzny. Można jej używać tylko wtedy, gdy targetingType jest TARGETING_TYPE_GEO_REGION.

Treść odpowiedzi

Odpowiedź na pytanie „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, które pasują do kryteriów wyszukiwania.

Jeśli lista jest pusta, nie będzie widoczna.
nextPageToken

string

Token do pobierania następnej strony wyników. Aby pobrać kolejną stronę wyników, prześlij tę wartość w polu pageToken w kolejnych wywołaniach metody targetingOptions.search.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.

PoiSearchTerms

wyszukiwane hasła dotyczące opcji kierowania na punkty POI;

Zapis JSON 
{
  "poiQuery": string
}
Pola
poiQuery

string

Zapytanie o nazwę, adres lub współrzędne wybranego punktu POI. Zapytanie może być prefiksem, np. „Times Square”, „40.7505045,-73.99562”, „315 W 44th St” itp.

BusinessChainSearchTerms

wyszukiwane hasła w przypadku opcji kierowania na sieć placówek,

Musisz wypełnić co najmniej 1 pole.

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

string

Zapytanie wyszukiwania odpowiedniej sieci handlowej. Zapytanie musi zawierać pełną nazwę firmy, np. „KFC” lub „Mercedes-Benz”.
regionQuery

string

Wyszukiwane hasło dotyczące wybranego regionu geograficznego, np. „Seattle”, „Stany Zjednoczone”.

GeoRegionSearchTerms

Wyszukiwanie haseł pod kątem opcji kierowania na region geograficzny.

Zapis JSON 
{
  "geoRegionQuery": string
}
Pola
geoRegionQuery

string

Zapytanie wyszukiwania odpowiedniego regionu geograficznego. Zapytanie może być prefiksem, np. „Nowy Jork”, „Seattle”, „USA” itp.