Method: advertisers.locationLists.list

Wyświetla listy lokalizacji na podstawie podanego identyfikatora reklamodawcy.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v2/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 200. 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 identyfikujący stronę z wynikami, który powinien zwrócić serwer.

Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody locationLists.list. Jeśli nie podasz żadnej wartości, wyświetlana będzie pierwsza strona wyników.
orderBy

string

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

  • locationListId (domyślnie)
  • displayName

Domyślna kolejność sortowania rosnąco. Aby określić kolejność malejącą w polu, 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 obejmują co najmniej 1 ograniczenie.
  • 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}.
  • Wszystkie pola muszą używać operatora EQUALS (=).

Obsługiwane pola:

  • locationType

Przykłady:

  • Wszystkie regionalne listy lokalizacji: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • Cała lista lokalizacji zbliżonych: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

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

Więcej informacji znajdziesz w naszym 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 jest pusta, nie będzie jej widać.
nextPageToken

string

Token pobierający następną stronę 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 omówieniu protokołu OAuth 2.0.