Method: advertisers.list

Wyświetla listę reklamodawców, do których bieżący użytkownik ma dostęp.

Kolejność jest określana przez parametr orderBy.

Wymagany jest pojedynczy obiekt partnerId. Informacje o różnych partnerach nie są obsługiwane.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
partnerId

string (int64 format)

To pole jest wymagane. Identyfikator partnera, do którego powinni należeć wszyscy pobrani reklamodawcy. System umożliwia wyświetlanie listy reklamodawców tylko dla jednego partnera naraz.
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.
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 advertisers.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:

  • displayName (domyślnie)
  • entityStatus
  • updateTime

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

string

Umożliwia filtrowanie według pól reklamodawcy.

Obsługiwana składnia:

  • Wyrażenia filtra obejmują co najmniej 1 ograniczenie.
  • Ograniczenia mogą być łączone za pomocą operatorów logicznych AND lub OR.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Pole updateTime musi zawierać operator GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • We wszystkich innych polach musi być używany operator EQUALS (=).

Obsługiwane pola:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (dane wejściowe w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Przykłady:

  • Wszyscy aktywni reklamodawcy w ramach partnera: entityStatus="ENTITY_STATUS_ACTIVE"
  • Wszyscy reklamodawcy, których czas aktualizacji nie przekracza 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Wszyscy reklamodawcy, których czas aktualizacji to 2020-11-04T18:54:47Z (format ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

Więcej informacji znajdziesz w naszym przewodniku po filtrowaniu żądań LIST.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Zapis JSON 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
Pola
advertisers[]

object (Advertiser)

Lista reklamodawców.

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 advertisers.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.