Method: combinedAudiences.list

Wyświetla połączone listy odbiorców.

Kolejność jest określana przez parametr orderBy.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi się mieścić w zakresie 1–200. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna 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 combinedAudiences.list. Jeśli nie zostanie określony, zwrócona zostanie pierwsza strona wyników.
orderBy

string

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

  • combinedAudienceId (domyślnie)
  • displayName

Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą, do nazwy pola należy dodać sufiks „desc”. Przykład: displayName desc.
filter

string

Umożliwia filtrowanie według pól połączonych list odbiorców.

Obsługiwana składnia:

  • Wyrażenia filtra w przypadku połączonych grup odbiorców 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 połączone listy odbiorców, których wyświetlana nazwa zawiera „Google”: displayName : "Google".

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

Więcej informacji znajdziesz w przewodniku po filtrowaniu żądań LIST.
Parametr unii accessor. Wymagane. Określa, do której jednostki DV360 jest wysyłane żądanie. Żądanie LIST zwróci tylko te elementy odbiorców z połączonych list, które są dostępne dla elementu DV360 określonego w accessor. accessor może być tylko jednym z tych elementów:
partnerId

string (int64 format)

Identyfikator partnera, który ma dostęp do pobranych połączonych list odbiorców.
advertiserId

string (int64 format)

Identyfikator reklamodawcy, który ma dostęp do pobranych połączonych grup 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 
{
  "combinedAudiences": [
    {
      object (CombinedAudience)
    }
  ],
  "nextPageToken": string
}
Pola
combinedAudiences[]

object (CombinedAudience)

Lista połączonych list odbiorców.

Jeśli lista będzie pusta, nie będzie ona dostępna.
nextPageToken

string

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