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. 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 googleAudiences.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:

  • googleAudienceId (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 odbiorców Google.

Obsługiwana składnia:

  • Wyrażenia filtra dla grup 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:

  • Wszyscy odbiorcy Google, 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 te encje odbiorców Google, które są dostępne dla encji DV360 określonej w parametrze accessor. accessor może mieć tylko jedną z tych wartości:
partnerId

string (int64 format)

Identyfikator partnera, który ma dostęp do pobranych list 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 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 googleAudiences.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.