Method: partners.list

Wyświetla listę partnerów dostępnych dla bieżącego użytkownika.

Kolejność jest określana przez parametr orderBy.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi się mieścić w zakresie 1200. 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 partners.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ślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą, 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 mogą być łączone za pomocą operatorów logicznych AND lub OR. Sekwencja ograniczeń używa domyślnie 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 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
{
  "partners": [
    {
      object (Partner)
    }
  ],
  "nextPageToken": string
}
Pola
partners[]

object (Partner)

lista partneró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 partners.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.