Method: users.list

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

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

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

Żądanie HTTP

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

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

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 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 (:).
  • Pole lastLoginTime musi używać operatora LESS THAN OR EQUAL TO (<=) lub GREATER THAN OR EQUAL TO (>=).
  • Wszystkie pozostałe pola muszą używać operatora EQUALS (=).

Obsługiwane pola:

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

Przykłady:

  • Użytkownik, którego displayName zawiera „foo”: displayName:"foo"
  • Użytkownik z atrybutem email zawierającym „bar”: email:"bar"
  • Wszyscy użytkownicy ze standardowymi rolami użytkownika: assignedUserRole.userRole="STANDARD"
  • Wszyscy użytkownicy z rolami użytkownika dla partnera 123: assignedUserRole.partnerId="123"
  • Wszyscy użytkownicy z rolami użytkownika dla 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 podlegających partnerowi 123: parentPartnerId="123"
  • Wszyscy użytkownicy, którzy ostatnio zalogowali się 1 stycznia 2023 r. o godzinie 00:00:00Z (format ISO 8601) lub później: lastLoginTime>="2023-01-01T00:00:00Z"

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

object (User)

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

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.