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/v1/partners

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
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 określający stronę z wynikami zwracanymi przez serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody partners.list. Jeśli nie podasz tych danych, zwracana jest pierwsza strona wyników.

orderBy

string

Pole służące do sortowania listy. Dopuszczalne wartości:

  • displayName

Domyślna kolejność sortowania jest rosnąca. Aby określić kolejność malejącą w przypadku pola, do jego nazwy musisz 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 mogą być łączone za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń domyślnie używa elementu 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 nie może zawierać więcej niż 500 znaków.

Więcej informacji znajdziesz w naszym przewodniku po żądaniach filtra 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.

Tej listy nie będzie, jeśli będzie pusta.

nextPageToken

string

Token do pobierania następnej strony wyników. W kolejnym wywołaniu metody partners.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 artykule Omówienie protokołu OAuth 2.0.