Method: advertisers.locationLists.list

Wyświetla listy lokalizacji na podstawie podanego identyfikatora reklamodawcy.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/locationLists

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

To pole jest wymagane. Identyfikator reklamodawcy DV360, do którego należą pobrane listy lokalizacji.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi mieścić się w zakresie od 1 do 100. Jeśli nie zostanie ustawiony, domyślna wartość to 100. Zwraca kod błędu INVALID_ARGUMENT, jeśli określono nieprawidłową wartość.
pageToken

string

Token określający stronę z wynikami zwracanymi przez serwer.

Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody locationLists.list. Jeśli nie podasz tych danych, zwracana jest pierwsza strona wyników.
orderBy

string

Pole służące do sortowania listy. Dopuszczalne wartości:

  • locationListId (domyślnie)
  • displayName

Domyślna kolejność sortowania jest rosnąca. Aby określić kolejność malejącą w przypadku pola, do jego nazwy musisz dodać sufiks „desc”. Przykład: displayName desc.
filter

string

Umożliwia filtrowanie według pól listy lokalizacji.

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej 1 ograniczenia.
  • Ograniczenia mogą być łączone za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa elementu AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Operatorem musi być EQUALS (=).
  • Obsługiwane pola:
    • locationType

Przykłady:

  • Wszystkie listy lokalizacji regionalnych: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • Wszystkie listy lokalizacji w pobliżu: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Zapis JSON 
{
  "locationLists": [
    {
      object (LocationList)
    }
  ],
  "nextPageToken": string
}
Pola
locationLists[]

object (LocationList)

Lista list lokalizacji.

Tej listy nie będzie, jeśli będzie pusta.
nextPageToken

string

Token do pobierania następnej strony wyników.

W kolejnym wywołaniu metody locationLists.list przekaż tę wartość w polu pageToken, 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 artykule Omówienie protokołu OAuth 2.0.