Method: advertisers.list

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

Kolejność jest określana przez parametr orderBy.

Wymagany jest pojedynczy element partnerId. Wyświetlanie informacji o partnerach nie jest obsługiwane.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
partnerId

string (int64 format)

Wymagane. Identyfikator partnera, do którego powinni należeć wszyscy pobrani reklamodawcy. System obsługuje wyświetlanie reklamodawców tylko dla jednego partnera naraz.
pageSize

integer

Żądany rozmiar strony. Musi należeć do przedziału od 1 do 200. Jeśli nie zostanie określony, domyślnie będzie to 100.
pageToken

string

Token identyfikujący stronę wyników, którą serwer powinien zwrócić. Zwykle jest to wartość nextPageToken zwrócona przez poprzednie wywołanie metody advertisers.list. Jeśli nie zostanie określona, zwrócona zostanie pierwsza strona wyników.
orderBy

string

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

  • advertiserId (domyślnie)
  • displayName
  • entityStatus
  • updateTime

Domyślna kolejność sortowania jest rosnąca. Aby określić kolejność malejącą dla pola, 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 składają się z co najmniej 1 ograniczenia.
  • Ograniczenia można łączyć za pomocą operatorów logicznych AND lub OR.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Pole updateTime musi używać operatorów GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • Wszystkie pozostałe pola muszą używać operatora EQUALS (=).

Obsługiwane pola:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (wpisz w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Przykłady:

  • Wszyscy aktywni reklamodawcy powiązani z danym partnerem: entityStatus="ENTITY_STATUS_ACTIVE"
  • Wszyscy reklamodawcy, których czas aktualizacji jest wcześniejszy niż 2020-11-04T18:54:47Z (format ISO 8601) lub równy tej dacie: updateTime<="2020-11-04T18:54:47Z"
  • Wszyscy reklamodawcy, których czas aktualizacji jest równy lub późniejszy niż 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 dotyczącym filtrowania żą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 ta lista jest pusta, nie będzie widoczna.
nextPageToken

string

Token do pobierania następnej strony wyników. Przekaż tę wartość w polu pageToken w kolejnym wywołaniu metody advertisers.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 OAuth 2.0 Overview.