Method: advertisers.locationLists.list

Wyświetla listy lokalizacji na podstawie danego identyfikatora reklamodawcy.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v3/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. Wartość musi się mieścić w zakresie 1–200. Jeśli nie zostanie ustawiony, domyślna wartość to 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 locationLists.list. Jeśli nie określono tego ustawienia, zostanie zwrócona 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 to rosnąco. Aby określić pole w kolejności malejącej, 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 jednego ograniczenia.
  • Ograniczenia można łączyć za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń używa domyślnie AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Wszystkie pola muszą używać operatora EQUALS (=).

Obsługiwane pola:

  • locationType

Przykłady:

  • Wszystkie regionalne listy lokalizacji: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • Lista wszystkich lokalizacji w pobliżu: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

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

Więcej informacji znajdziesz w przewodniku dotyczącym żą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 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 locationLists.list.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie OAuth 2.0.