Method: users.list

Wyświetla listę użytkowników, którzy są dostępni dla bieżącego użytkownika. Jeśli 2 użytkowników ma role przypisane do tego samego partnera lub reklamodawcy, może 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 przewodniku Zarządzanie użytkownikami.

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

Żądanie HTTP

GET https://displayvideo.googleapis.com/v2/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 identyfikujący stronę z wynikami, który powinien zwrócić serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody users.list. Jeśli nie podasz żadnej wartości, wyświetlana będzie pierwsza strona wyników.
orderBy

string

Pole służące do sortowania listy. Akceptowane wartości:

  • displayName (domyślnie)

Domyślna kolejność sortowania rosnąco. Aby określić kolejność malejącą w polu, 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 obejmują co najmniej 1 ograniczenie.
  • Ograniczenia mogą być łączone za pomocą operatora logicznego AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Pola displayName i email muszą używać operatora HAS (:).
  • Pole lastLoginTime musi zawierać operator LESS THAN OR EQUAL TO (<=) lub GREATER THAN OR EQUAL TO (>=).
  • We wszystkich innych polach musi być używany operator EQUALS (=).

Obsługiwane pola:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: to jest syntetyczne pole 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 syntetyczne pole AssignedUserRole używane do filtrowania. Określa partnera nadrzędnego jednostki, do której 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 uprawnieniem displayName zawierającym „foo”: displayName:"foo"
  • Użytkownik z uprawnieniem email zawierającym słowo „bar”: email:"bar"
  • Wszyscy użytkownicy ze standardowymi rolami: assignedUserRole.userRole="STANDARD"
  • Wszyscy użytkownicy z rolami użytkownika 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 partnera 123 i reklamodawców poniżej konta partnera 123: parentPartnerId="123"
  • Wszyscy użytkownicy, którzy ostatnio logowali się 01.01.2023 r. 01T00:00:00Z (w formacie ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

To pole może zawierać maksymalnie 500 znaków.

Więcej informacji znajdziesz w naszym przewodniku po filtrowaniu żą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 widać.
nextPageToken

string

Token pobierający następną stronę wyników. W kolejnym wywołaniu metody users.list przekaż tę wartość w polu pageToken, aby pobrać następną stronę wyników. Ten token nie będzie widoczny, jeśli nie będzie więcej 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 omówieniu protokołu OAuth 2.0.