Method: users.list

Listet die 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.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 100 liegen. Wenn kein Wert angegeben ist, 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 Standardsortierreihenfolge ist aufsteigend. Wenn ein Feld in absteigender Reihenfolge sortiert werden soll, muss dem Feldnamen das Suffix „desc“ hinzugefügt werden. Beispiel: displayName desc.
filter

string

Ermöglicht das Filtern nach Nutzereigenschaften.

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}.
  • Der Operator muss CONTAINS (:) oder EQUALS (=) sein.
  • Der Operator muss für die folgenden Felder CONTAINS (:) sein:
    • displayName
    • email
  • Der Operator muss für die folgenden Felder EQUALS (=) sein:
    • assignedUserRole.userRole
    • assignedUserRole.partnerId
    • assignedUserRole.advertiserId
    • assignedUserRole.entityType: 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: Ein synthetisches Feld von „AssignedUserRole“, das zum Filtern verwendet wird. Gibt den übergeordneten Partner der Entität an, der die Nutzerrolle zugewiesen ist.

Beispiele:

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

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

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 users.list-Methode 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.