Method: users.list

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

Für diese Methode gelten spezielle Authentifizierungsanforderungen. Lesen Sie die Voraussetzungen im Leitfaden zur Nutzerverwaltung, bevor Sie diese Methode verwenden.

Die Seite „Teste diese Methode“ funktioniert bei dieser 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 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 Methode users.list 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)

Standardmäßig wird die Sortierreihenfolge aufsteigend sein. Wenn Sie für ein Feld eine absteigende Reihenfolge angeben möchten, fügen Sie das Suffix „desc“ ein. dem Feldnamen hinzugefügt werden soll. 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}.
  • 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 der Operator GREATER THAN OR EQUAL TO (>=) verwendet werden.
  • In allen anderen Feldern 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: Dies ist ein synthetisches Feld von AssignedUserRole, das zum Filtern verwendet wird. Gibt den übergeordneten Partner der Entität an, der die User-Rolle zugewiesen ist.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (Eingabe im ISO 8601-Format oder YYYY-MM-DDTHH:MM:SSZ)

Beispiele:

  • Der Nutzer mit displayName, der „foo“ enthält: displayName:"foo"
  • Der 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 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"

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

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.

Diese Liste ist nicht vorhanden, 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 Methode users.list im Feld pageToken, 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 Übersicht über OAuth 2.0.