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 auf die Daten des jeweils anderen zugreifen.

Für diese Methode gelten spezielle Authentifizierungsanforderungen. Lesen Sie die Voraussetzungen in unserem Leitfaden zum Verwalten von Nutzern, bevor Sie diese Methode verwenden.

Die Funktion „Diese Methode ausprobieren“ funktioniert für diese Methode nicht.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageSize

integer

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

string

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

string

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

  • displayName (Standard)

Die Standardsortierreihenfolge ist aufsteigend. Wenn Sie ein Feld absteigend sortieren möchten, sollte dem Feldnamen das Suffix „desc“ hinzugefügt werden. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach Nutzerfeldern.

Unterstützte Syntax:

  • Filterausdrücke umfassen eine oder mehrere Einschränkungen.
  • Einschränkungen können mit dem logischen Operator AND kombiniert werden.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Für die Felder displayName und email muss der Operator HAS (:) verwendet werden.
  • Für das Feld lastLoginTime muss entweder der Operator LESS THAN OR EQUAL TO (<=) oder GREATER THAN OR EQUAL TO (>=) verwendet werden.
  • Für alle anderen Felder muss der Operator EQUALS (=) verwendet werden.

Unterstützte Felder:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: Dies ist das synthetische Feld von AssignedUserRole, das zum Filtern verwendet wird. Gibt den Typ der Entität an, der die Nutzerrolle zugewiesen ist. Gültige Werte sind Partner und Advertiser.
  • assignedUserRole.parentPartnerId: 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 (im ISO 8601-Format eingeben oder YYYY-MM-DDTHH:MM:SSZ)

Beispiele:

  • Der Nutzer mit displayName, die „foo“ enthält: displayName:"foo"
  • Der Nutzer mit email, die „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 Werbetreibenden 123: assignedUserRole.advertiserId="123"
  • Alle Nutzer mit Nutzerrollen auf Partnerebene: entityType="PARTNER"
  • Alle Nutzer mit Nutzerrollen für Partner 123 und Werbetreibende unter Partner 123: parentPartnerId="123"
  • Alle Nutzer, die sich zuletzt am 01.01.2023 oder nach dem 01.01.2023 angemeldet haben (ISO 8601-Format): lastLoginTime>="2023-01-01T00:00:00Z"

Dieses Feld darf maximal 500 Zeichen lang sein.

Weitere Informationen finden Sie im Leitfaden LIST-Anfragen filtern.

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.

Wenn die Liste leer ist, ist sie nicht vorhanden.
nextPageToken

string

Ein Token, mit dem die nächste Ergebnisseite abgerufen werden kann. Übergeben Sie diesen Wert im Feld pageToken im nachfolgenden Aufruf der Methode users.list, um die nächste Ergebnisseite abzurufen. Dieses Token ist nicht vorhanden, 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 OAuth 2.0-Übersicht.