Method: users.list

Répertorie les utilisateurs auxquels l'utilisateur actuel peut accéder. Si deux utilisateurs possèdent des rôles utilisateur pour le même partenaire ou le même annonceur, ils peuvent accéder l'un à l'autre.

Cette méthode a des exigences d'authentification uniques. Lisez les conditions préalables de notre Guide de gestion des utilisateurs avant d'utiliser cette méthode.

La fonctionnalité "Essayer cette méthode" ne fonctionne pas avec cette méthode.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
pageSize

integer

Taille de la page demandée. Doit être compris entre 1 et 200. Si aucune valeur n'est spécifiée, la valeur par défaut est 100.
pageToken

string

Jeton identifiant une page de résultats que le serveur doit renvoyer. Il s'agit généralement de la valeur de nextPageToken renvoyée par l'appel précédent de la méthode users.list. Si aucune valeur n'est spécifiée, la première page de résultats est affichée.
orderBy

string

Champ selon lequel trier la liste. Les valeurs acceptées sont les suivantes :

  • displayName (par défaut)

Par défaut, l'ordre de tri est croissant. Pour indiquer l'ordre décroissant d'un champ, vous devez ajouter le suffixe "desc" au nom du champ. Par exemple, displayName desc.
filter

string

Permet de filtrer par champs utilisateur.

Syntaxe acceptée:

  • Les expressions de filtre sont constituées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées avec l'opérateur logique AND.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Les champs displayName et email doivent utiliser l'opérateur HAS (:).
  • Le champ lastLoginTime doit utiliser l'opérateur LESS THAN OR EQUAL TO (<=) ou GREATER THAN OR EQUAL TO (>=).
  • Tous les autres champs doivent utiliser l'opérateur EQUALS (=).

Champs acceptés:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: champ synthétique de AssignedUserRole utilisé pour le filtrage. Identifie le type d'entité à laquelle le rôle utilisateur est attribué. Les valeurs valides sont Partner et Advertiser.
  • assignedUserRole.parentPartnerId: champ synthétique de AssignedUserRole utilisé pour le filtrage. Identifie le partenaire parent de l'entité à laquelle le rôle utilisateur est attribué.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (entrée au format ISO 8601, ou YYYY-MM-DDTHH:MM:SSZ)

Exemples :

  • Utilisateur avec displayName contenant "foo": displayName:"foo"
  • Utilisateur avec email contenant "bar": email:"bar"
  • Tous les utilisateurs disposant des rôles utilisateur standards: assignedUserRole.userRole="STANDARD"
  • Tous les utilisateurs disposant de rôles utilisateur pour le partenaire 123: assignedUserRole.partnerId="123"
  • Tous les utilisateurs disposant des rôles utilisateur pour l'annonceur 123: assignedUserRole.advertiserId="123"
  • Tous les utilisateurs disposant de rôles utilisateur au niveau du partenaire: entityType="PARTNER"
  • Tous les utilisateurs disposant de rôles utilisateur pour le partenaire 123 et les annonceurs du partenaire 123: parentPartnerId="123"
  • Tous les utilisateurs qui se sont connectés pour la dernière fois le 2023-01-01T00:00:00Z (format ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

La longueur de ce champ ne doit pas dépasser 500 caractères.

Pour en savoir plus, consultez notre guide sur les requêtes LIST de filtrage.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :

Représentation JSON 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Champs
users[]

object (User)

Liste des utilisateurs.

Si cette liste est vide, elle sera absente.
nextPageToken

string

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur dans le champ pageToken lors de l'appel suivant de la méthode users.list pour récupérer la page de résultats suivante. Ce jeton sera absent s'il n'y a plus de résultats à renvoyer.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.