Method: users.list

Wyświetla listę użytkowników, do których ma dostęp bieżący użytkownik. Jeśli 2 użytkownicy mają role użytkownika w przypadku tego samego partnera lub reklamodawcy, mogą mieć do siebie dostęp.

Ta metoda ma unikalne wymagania dotyczące uwierzytelniania. Zanim użyjesz tej metody, zapoznaj się z wymaganiami w przewodniku Zarządzanie użytkownikami.

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

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Żądany rozmiar strony. Wartość musi się mieścić w zakresie 1–200. 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 users.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ślnie)

Domyślna kolejność sortowania to rosnąco. Aby określić pole w kolejności malejącej, do nazwy pola należy 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}.
  • Pola displayName i email muszą używać operatora HAS (:).
  • W polu lastLoginTime musisz użyć operatora LESS THAN OR EQUAL TO (<=) lub GREATER THAN OR EQUAL TO (>=).
  • W pozostałych polach musisz użyć operatora EQUALS (=).

Obsługiwane pola:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: to syntetyczne pole AssignedUserRole służące do filtrowania. Określa typ elementu, do którego przypisana jest rola użytkownika. Prawidłowe wartości to Partner i Advertiser.
  • assignedUserRole.parentPartnerId: to syntetyczne pole AssignedUserRole służące do filtrowania. Identyfikuje nadrzędnego partnera podmiotu, do którego przypisana jest rola użytkownika.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (w formacie ISO 8601 lub YYYY-MM-DDTHH:MM:SSZ)

Przykłady:

  • Użytkownik o identyfikatorze displayName zawierającym ciąg znaków „foo”: displayName:"foo"
  • Użytkownik o identyfikatorze email zawierającym ciąg znaków „bar”: email:"bar"
  • Wszyscy użytkownicy z rolą użytkownika o standardowym dostępie: assignedUserRole.userRole="STANDARD"
  • Wszyscy użytkownicy z rolą użytkownika w przypadku partnera 123: assignedUserRole.partnerId="123"
  • Wszyscy użytkownicy z rolami użytkownika w przypadku reklamodawcy 123: assignedUserRole.advertiserId="123"
  • Wszyscy użytkownicy z rolami na poziomie partnera: entityType="PARTNER"
  • Wszyscy użytkownicy z rolami użytkownika u partnera 123 i reklamodawców u partnera 123: parentPartnerId="123"
  • Wszyscy użytkownicy, którzy ostatnio logowali się 1 stycznia 2023 r. lub później (w formacie ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

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

object (User)

Lista użytkownikó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 users.list. Ten token nie będzie obecny, jeśli nie ma już żadnych wyników do zwrócenia.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.