Method: partners.list

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

Kolejność jest określana przez parametr orderBy.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wymagana wartość z zakresu od 1 do 200. Jeśli nie określono inaczej, domyślna wartość to 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 partners.list. Jeśli nie określono tego ustawienia, zostanie zwrócona pierwsza strona wyników.

orderBy

string

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

  • displayName

Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą w polu, dodaj sufiks „desc” . Na przykład: displayName desc.

filter

string

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

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej jednego ograniczenia.
  • Ograniczenia mogą być łączone za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa funkcji AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Wszystkie pola muszą używać operatora EQUALS (=).

Obsługiwane pola:

  • entityStatus

Przykłady:

  • Wszyscy aktywni partnerzy: entityStatus="ENTITY_STATUS_ACTIVE"

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

Więcej informacji znajdziesz w 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
{
  "partners": [
    {
      object (Partner)
    }
  ],
  "nextPageToken": string
}
Pola
partners[]

object (Partner)

Lista partnerów.

Jeśli lista będzie pusta, nie będzie ona dostępna.

nextPageToken

string

Token do pobrania następnej strony wyników. Przekaż tę wartość w polu pageToken w kolejnym wywołaniu metody partners.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 artykule Omówienie protokołu OAuth 2.0.