Method: users.list

Listet Nutzer auf, auf die der aktuelle Nutzer zugreifen kann. Wenn zwei Nutzer Nutzerrollen für denselben Partner oder Werbetreibenden haben, können sie aufeinander zugreifen.

Diese Methode hat besondere Authentifizierungsanforderungen. Lesen Sie die Voraussetzungen im Nutzerhandbuch zur Nutzerverwaltung, bevor Sie diese Methode verwenden.

Die Funktion „Testen Sie diese Methode“ funktioniert bei dieser Methode nicht.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn keine Vorgabe erfolgt, wird standardmäßig 100 verwendet.
pageToken

string

Ein Token, das eine Ergebnisseite identifiziert, die der Server liefern soll. In der Regel ist dies der Wert von nextPageToken, der vom vorherigen Aufruf der users.list-Methode zurückgegeben wurde. Wenn nicht angegeben, wird die erste Ergebnisseite zurückgegeben.
orderBy

string

Feld, nach dem die Liste sortiert werden soll. Akzeptable Werte sind:

  • displayName (Standard)

Die standardmäßige Sortierreihenfolge ist aufsteigend. Wenn ein Feld absteigend sortiert werden soll, muss dem Feldnamen das Suffix „desc“ hinzugefügt werden. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach Nutzerfeldern.

Unterstützte Syntax:

  • Filterausdrücke bestehen aus einer oder mehreren Einschränkungen.
  • Einschränkungen können mit dem logischen Operator AND kombiniert werden.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • In den Feldern displayName und email muss der Operator HAS (:) verwendet werden.
  • Im Feld lastLoginTime muss entweder der Operator LESS THAN OR EQUAL TO (<=) oder GREATER THAN OR EQUAL TO (>=) verwendet werden.
  • Alle anderen Felder müssen den Operator EQUALS (=) verwenden.

Unterstützte Felder:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: Dies ist ein synthetisches Feld von AssignedUserRole, das zum Filtern verwendet wird. Gibt den Entitätstyp an, dem die Nutzerrolle zugewiesen ist. Gültige Werte sind Partner und Advertiser.
  • assignedUserRole.parentPartnerId: Dies ist ein synthetisches Feld von AssignedUserRole, das zum Filtern verwendet wird. Gibt den übergeordneten Partner der Entität an, der die Nutzerrolle zugewiesen ist.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (Eingabe im ISO-8601-Format oder YYYY-MM-DDTHH:MM:SSZ)

Beispiele:

  • Nutzer mit displayName, der „foo“ enthält: displayName:"foo"
  • Nutzer mit email, der „bar“ enthält: email:"bar"
  • Alle Nutzer mit Standardnutzerrollen: assignedUserRole.userRole="STANDARD"
  • Alle Nutzer mit Nutzerrollen für Partner 123: assignedUserRole.partnerId="123"
  • Alle Nutzer mit Nutzerrollen für den Werbetreibenden 123: assignedUserRole.advertiserId="123"
  • Alle Nutzer mit Nutzerrollen auf Partnerebene: entityType="PARTNER"
  • Alle Nutzer mit Nutzerrollen für Partner 123 und Werbetreibende bei Partner 123: parentPartnerId="123"
  • Alle Nutzer, die sich zuletzt am oder nach dem 01.01.2023, 00:00:00Z (Format ISO 8601) angemeldet haben: lastLoginTime>="2023-01-01T00:00:00Z"

Die Länge dieses Feldes darf 500 Zeichen nicht überschreiten.

Weitere Informationen finden Sie im Leitfaden zu LIST-Filteranfragen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Felder
users[]

object (User)

Die Liste der Nutzer.

Diese Liste fehlt, wenn sie leer ist.
nextPageToken

string

Ein Token, mit dem die nächste Ergebnisseite abgerufen werden kann. Übergeben Sie diesen Wert im nachfolgenden Aufruf der users.list-Methode im Feld pageToken, um die nächste Ergebnisseite abzurufen. Dieses Token fehlt, wenn keine weiteren Ergebnisse zurückgegeben werden können.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.