Method: users.list

Wyświetla listę użytkowników dostępnych dla bieżącego użytkownika. Jeśli 2 użytkowników ma przypisane role tego samego partnera lub reklamodawcy, mogą uzyskiwać dostęp do siebie nawzajem.

Ta metoda ma unikalne wymagania dotyczące uwierzytelniania. Przed użyciem tej metody zapoznaj się z wymaganiami wstępnymi w naszym przewodniku po zarządzaniu użytkownikami.

Funkcja „Wypróbuj tę metodę” nie działa w przypadku tej metody.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v1/users

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 users.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ślnie)

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 użytkownika.

Obsługiwana składnia:

  • Wyrażenia filtra składają się z co najmniej 1 ograniczenia.
  • Ograniczenia można łączyć za pomocą operatora logicznego AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Pole budget.budget_segments.date_range.end_date musi zawierać operator LESS THAN (<).
  • Operator displayName andemailfield must use theHAS (:).
  • W pozostałych polach należy używać operatora EQUALS (=).

Obsługiwane pola:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType
  • To jest pole syntetyczne pola AssignedUserRole używane do filtrowania. Określa typ jednostki, do której przypisana jest rola użytkownika. Prawidłowe wartości to Partner i Advertiser.
  • assignedUserRole.parentPartnerId
  • To jest pole syntetyczne pola AssignedUserRole używane do filtrowania. Identyfikuje partnera nadrzędnego elementu, do którego przypisana jest rola użytkownika.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email

Przykłady:

  • Użytkownik z polem displayName zawierającym „foo”: displayName:"foo"
  • Użytkownik z polem email zawierającym słowo „bar”: email:"bar"
  • Wszyscy użytkownicy ze standardowymi rolami: assignedUserRole.userRole="STANDARD"
  • Wszyscy użytkownicy z rolami użytkownika w przypadku partnera 123: assignedUserRole.partnerId="123"
  • Wszyscy użytkownicy z rolami użytkownika na potrzeby reklamodawcy 123: assignedUserRole.advertiserId="123"
  • Wszyscy użytkownicy z rolami użytkownika na poziomie partnera: entityType="PARTNER"
  • Wszyscy użytkownicy z rolami użytkownika w przypadku partnera 123 i reklamodawców powiązanych z partnerem 123: parentPartnerId="123"

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

object (User)

Lista użytkownikó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 users.list przekaż tę wartość w polu pageToken, aby pobrać następną stronę wyników. Jeśli nie ma więcej wyników do zwrócenia, token będzie niedostępny.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/display-video-user-management

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.