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. Musi należeć do przedziału od 1 do 200. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna 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 z poprzedniego wywołania metody customLists.list. Jeśli nie zostanie określona, zwracana jest pierwsza strona wyników.
orderBy

string

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

  • customListId (domyślnie)
  • displayName

Domyślna kolejność sortowania to 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 niestandardowej.

Obsługiwana składnia:

  • Wyrażenia filtra dla list niestandardowych mogą zawierać maksymalnie 1 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 nazwa wyświetlana zawiera słowo „Google”: displayName:"Google".

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

Więcej informacji znajdziesz w przewodniku filtrowanie żądań.LIST
Parametr zbiorczy accessor. Wymagane. Określa, w którym podmiocie DV360 jest wysyłane żądanie. Żądanie LIST zwróci tylko elementy listy niestandardowej, które są dostępne dla elementu DV360 zidentyfikowanego w parametrze accessor. accessor może mieć tylko jedną z tych wartości:
advertiserId

string (int64 format)

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

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.

Jeśli lista jest pusta, nie będzie jej w odpowiedzi.
nextPageToken

string

Token do pobierania następnej strony wyników. Przekaż tę wartość w polu pageToken w kolejnym wywołaniu metody customLists.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 sekcji OAuth 2.0 Overview.