Method: users.list

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

Ta metoda ma unikalne wymagania dotyczące uwierzytelniania. Zanim użyjesz tej metody, przeczytaj wymagania wstępne w naszym przewodniku zarządzania użytkownikami.

Opcja „Wypróbuj tę metodę” nie działa dla 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. Wymagana wartość z zakresu od 1 do 200. Jeśli nie określono inaczej, domyślna wartość to 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 określono tego ustawienia, zostanie zwrócona pierwsza strona wyników.
orderBy

string

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

  • displayName (domyślnie)

Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą w polu, dodaj 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 jednego ograniczenia.
  • Ograniczenia można łączyć za pomocą operatora logicznego AND.
  • Ograniczenie ma postać {field} {operator} {value}.
  • W polach displayName i email musisz używać operatora HAS (:).
  • Pole lastLoginTime musi zawierać operator LESS THAN OR EQUAL TO (<=) lub GREATER THAN OR EQUAL TO (>=).
  • We wszystkich innych polach należy 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 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 elementu, 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 z wartością displayName zawierającą ciąg „foo”: displayName:"foo"
  • Użytkownik z wartością email zawierającą 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 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 poniżej 123: parentPartnerId="123"
  • Wszyscy użytkownicy, którzy ostatnio zalogowali się 01.01.2023 r. lub później 00:00:00Z (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 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 będzie pusta, nie będzie ona dostępna.
nextPageToken

string

Token do pobrania 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. Ten token będzie brakował, 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 artykule Omówienie protokołu OAuth 2.0.