Method: advertisers.locationLists.list

Wyświetla listy lokalizacji na podstawie podanego identyfikatora reklamodawcy.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Wymagane. Identyfikator reklamodawcy w DV360, do którego należą pobrane listy lokalizacji.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Musi należeć do przedziału od 1 do 200. Jeśli nie zostanie ustawiony, domyślna wartość to 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 przez poprzednie wywołanie metody locationLists.list. Jeśli nie zostanie określona, zwrócona zostanie pierwsza strona wyników.
orderBy

string

Pole, według którego ma być sortowana lista. Akceptowane wartości:

  • locationListId (domyślnie)
  • displayName

Domyślna kolejność sortowania jest rosnąca. Aby określić kolejność malejącą dla pola, do nazwy pola należy 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 można łączyć za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa operatora AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Wszystkie pola muszą używać operatora EQUALS (=).

Obsługiwane pola:

  • locationType

Przykłady:

  • Lista wszystkich lokalizacji regionalnych: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • Lista wszystkich lokalizacji w pobliżu: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

To pole może zawierać maksymalnie 500 znaków.

Więcej informacji znajdziesz w naszym przewodniku dotyczącym filtrowania żądań LIST.

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.

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

string

Token do pobierania następnej strony wyników.

Przekaż tę wartość w polu pageToken w kolejnym wywołaniu metody locationLists.list, 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 OAuth 2.0 Overview.