Method: advertisers.locationLists.list

Zawiera listę lokalizacji na podstawie podanego identyfikatora reklamodawcy.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

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

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wymagana wartość z zakresu od 1 do 200. Jeśli nie zostanie ustawiony, domyślna wartość to 100. Zwraca kod błędu INVALID_ARGUMENT w przypadku określenia nieprawidłowej wartości.

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 locationLists.list. Jeśli nie określono tego ustawienia, zostanie zwrócona pierwsza strona wyników.

orderBy

string

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

  • locationListId (domyślnie)
  • displayName

Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą w polu, dodaj 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 jednego ograniczenia.
  • Ograniczenia mogą być łączone za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa funkcji 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"
  • Cała lista przybliżonych lokalizacji: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

Długość tego pola nie powinna przekraczać 500 znaków.

Więcej informacji znajdziesz w przewodniku po filtrowaniu żą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 lista będzie pusta, nie będzie ona dostępna.

nextPageToken

string

Token do pobrania 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 artykule Omówienie protokołu OAuth 2.0.