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.

Wymagane jest jedno partnerId. Wykazywanie w ramach umowy między partnerami nie jest 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)

Wymagane. Identyfikator partnera, do którego mają należeć pobrane reklamodawcy. System obsługuje tylko wyświetlanie reklamodawców dla jednego partnera naraz.
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.
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 advertisers.list. Jeśli nie zostanie określony, zwrócona zostanie pierwsza strona wyników.
orderBy

string

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

  • displayName (domyślnie)
  • entityStatus
  • updateTime

Domyślna kolejność sortowania to rosnąco. Aby określić pole w kolejności malejącej, 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}.
  • W polu updateTime musisz użyć operatora GREATER THAN OR EQUAL TO (>=) lub LESS THAN OR EQUAL TO (<=).
  • W pozostałych polach musisz użyć operatora EQUALS (=).

Obsługiwane pola:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (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órzy mają czas aktualizacji mniejszy lub równy 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Wszyscy reklamodawcy, których czas aktualizacji jest równy lub większy niż 2020-11-04T18:54:47Z (format ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

Więcej informacji znajdziesz w przewodniku dotyczącym żą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 widoczna.
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 advertisers.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.