Method: customLists.list

Wyświetla listy niestandardowe.

Kolejność jest określana przez parametr orderBy.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v3/customLists

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi mieścić się w zakresie od 1 do 200. Jeśli nie określono inaczej, domyślnie przyjmuje się wartość 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 customLists.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:

  • customListId (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 niestandardowych pól listy.

Obsługiwana składnia:

  • Wyrażenia filtra dla list niestandardowych mogą zawierać tylko jedno ograniczenie.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Wszystkie pola muszą używać operatora HAS (:).

Obsługiwane pola:

  • displayName

Przykłady:

  • Wszystkie listy niestandardowe, których wyświetlana nazwa zawiera słowo „Google”: displayName:"Google".

To pole nie może zawierać więcej niż 500 znaków.

Więcej informacji znajdziesz w naszym przewodniku po żądaniach filtra LIST.
Parametr sumy accessor. To pole jest wymagane. Określa, do którego jednostki DV360 przesyłane jest żądanie. Żądanie LIST zwróci tylko niestandardowe elementy listy, które są dostępne dla encji DV360 zidentyfikowanej w elemencie accessor. accessor może mieć tylko jedną z tych wartości:
advertiserId

string (int64 format)

Identyfikator reklamodawcy DV360, który ma dostęp do pobranych list niestandardowych.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Zapis JSON 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
Pola
customLists[]

object (CustomList)

Lista list niestandardowych.

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 customLists.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.