Method: googleAudiences.list

Wyświetla listy odbiorców Google.

Kolejność jest określana przez parametr orderBy.

Żądanie HTTP

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

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 googleAudiences.list. Jeśli nie określono tego ustawienia, zostanie zwrócona pierwsza strona wyników.
orderBy

string

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

  • googleAudienceId (domyślnie)
  • displayName

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

string

Umożliwia filtrowanie według pól list odbiorców Google.

Obsługiwana składnia:

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

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

Więcej informacji znajdziesz w przewodniku dotyczącym żądań LIST.
Parametr unii accessor. Wymagane. Określa, do której jednostki DV360 jest wysyłane żądanie. Zapytanie LIST zwróci tylko te elementy listy odbiorców Google, które są dostępne dla elementu DV360 zidentyfikowanego w ramach accessor. accessor może mieć tylko jedną z tych wartości:
partnerId

string (int64 format)

Identyfikator partnera, który ma dostęp do pobranych odbiorców Google.
advertiserId

string (int64 format)

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Zapis JSON 
{
  "googleAudiences": [
    {
      object (GoogleAudience)
    }
  ],
  "nextPageToken": string
}
Pola
googleAudiences[]

object (GoogleAudience)

Lista odbiorców Google.

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

string

Token do pobierania następnej strony wyników. Aby pobrać kolejną stronę wyników, prześlij tę wartość w polu pageToken w kolejnych wywołaniach metody googleAudiences.list.

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.