Method: users.list

Répertorie les utilisateurs accessibles à l'utilisateur actuel. Si deux utilisateurs ont des rôles utilisateur sur le même partenaire ou annonceur, ils peuvent accéder l'un à l'autre.

Cette méthode présente des exigences d'authentification uniques. Avant d'utiliser cette méthode, lisez les conditions préalables dans notre guide sur la gestion des utilisateurs.

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

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
pageSize

integer

Taille de la page demandée. La valeur doit être comprise 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. En général, il s'agit de la valeur de nextPageToken renvoyée par l'appel précédent de la méthode users.list. Si ce paramètre n'est pas spécifié, la première page de résultats est renvoyée.
orderBy

string

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

  • displayName (par défaut)

L'ordre de tri par défaut est croissant. Pour spécifier l'ordre décroissant d'un champ, ajoutez 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 composées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées par 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é auquel 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 :

  • L'utilisateur dont l'adresse e-mail (displayName) contient "foo" : displayName:"foo"
  • L'utilisateur dont le email contient "bar" : email:"bar"
  • Tous les utilisateurs disposant de 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 de rôles utilisateur pour l'annonceur 123 : assignedUserRole.advertiserId="123"
  • Tous les utilisateurs disposant de rôles utilisateur au niveau Partenaire : entityType="PARTNER"
  • Tous les utilisateurs disposant de rôles utilisateur pour le partenaire 123 et les annonceurs associés au partenaire 123 : parentPartnerId="123"
  • Tous les utilisateurs qui se sont connectés pour la dernière fois le 01/01/2023 à 00:00:00Z (format ISO 8601) ou après cette date : 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 de filtrage LIST.

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.

Cette liste sera absente si elle est vide.
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 plus d'informations, consultez la OAuth 2.0 Overview.