Method: combinedAudiences.list

Wyświetla listę połączonych grup 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 mieścić się w przedziale 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 combinedAudiences.list. Jeśli nie zostanie określona, zwracana będzie pierwsza strona wyników.
orderBy

string

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

  • combinedAudienceId (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 połączonych list odbiorców.

Obsługiwana składnia:

  • Wyrażenia filtra w przypadku połączonych grup odbiorców mogą zawierać co najwyżej 1 ograniczenie.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Wszystkie pola muszą używać operatora HAS (:).

Obsługiwane pola:

  • displayName

Przykłady:

  • Wszystkie grupy odbiorców z połączonych list, których wyświetlana nazwa 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 połączone jednostki listy odbiorców, które są dostępne dla jednostki DV360 zidentyfikowanej w accessor. accessor może mieć tylko jedną z tych wartości:
partnerId

string (int64 format)

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

string (int64 format)

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

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 grup odbiorców.

Jeśli lista jest pusta, nie będzie jej w tym miejscu.
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 sekcji OAuth 2.0 Overview.