Method: users.list

Wyświetla listę użytkowników, do których obecny użytkownik ma dostęp. Jeśli 2 użytkowników ma role użytkownika w przypadku tego samego partnera lub reklamodawcy, mogą uzyskać 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 po zarządzaniu użytkownikami.

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

Żądanie HTTP

GET https://displayvideo.googleapis.com/v3/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 podasz tu ż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ślona, zwracana jest pierwsza strona wyników.
orderBy

string

Pole, według którego ma być posortowana lista. Akceptowane wartości:

  • displayName (domyślnie)

Domyślna kolejność sortowania to 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 (>=).
  • W przypadku wszystkich pozostałych pól musisz użyć operatora EQUALS (=).

Obsługiwane pola:

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

Przykłady:

  • Użytkownik z displayName zawierającym „foo”: displayName:"foo"
  • Użytkownik z polem email zawierającym „bar”: email:"bar"
  • Wszyscy użytkownicy z rolami użytkownika o standardowym dostępie: assignedUserRole.userRole="STANDARD"
  • Wszyscy użytkownicy z rolami 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 użytkownika na poziomie partnera: entityType="PARTNER"
  • Wszyscy użytkownicy z rolami użytkownika w przypadku partnera 123 i reklamodawców podlegających partnerowi 123: parentPartnerId="123"
  • Wszyscy użytkownicy, którzy ostatni raz zalogowali się 1 stycznia 2023 r. lub później (format ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

Długość tego pola nie powinna przekraczać 500 znaków.

Więcej informacji znajdziesz w przewodniku filtrowanie żą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 jej w odpowiedzi.
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 sekcji OAuth 2.0 Overview.