Method: googleAudiences.list

Wyświetla listę odbiorców Google.

Kolejność jest określana przez parametr orderBy.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi mieścić się w zakresie od 1 do 200. Jeśli nie określono inaczej, domyślnie przyjmuje się wartość 100. Zwraca kod błędu INVALID_ARGUMENT, jeśli określono nieprawidłową wartość.
pageToken

string

Token identyfikujący stronę z wynikami, który powinien zwrócić serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody googleAudiences.list. Jeśli nie podasz żadnej wartości, wyświetlana będzie pierwsza strona wyników.
orderBy

string

Pole służące do sortowania listy. Akceptowane wartości:

  • googleAudienceId (domyślnie)
  • displayName

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

string

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

Obsługiwana składnia:

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

To pole może zawierać maksymalnie 500 znaków.

Więcej informacji znajdziesz w naszym przewodniku po filtrowaniu żądań LIST.
Parametr sumy funkcji accessor. To pole jest wymagane. Identyfikuje element DV360, w sprawie którego wysyłane jest żądanie. Żądanie LIST zwróci tylko te elementy odbiorców Google, które są dostępne dla elementu DV360 określonego w elemencie accessor. accessor może być 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 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 widać.
nextPageToken

string

Token pobierający następną stronę wyników. W kolejnym wywołaniu metody googleAudiences.list przekaż tę wartość w polu pageToken, 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 omówieniu protokołu OAuth 2.0.