Method: partners.list

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

Kolejność jest określana przez parametr orderBy.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
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 partners.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:

  • displayName

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

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. Sekwencja ograniczeń domyślnie używa operatora 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"

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
{
  "partners": [
    {
      object (Partner)
    }
  ],
  "nextPageToken": string
}
Pola
partners[]

object (Partner)

Lista partneró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 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 OAuth 2.0 Overview.