Method: users.list

Liste les utilisateurs accessibles à l'utilisateur actuel. Si deux utilisateurs disposent de rôles utilisateur pour 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, consultez les conditions préalables décrites dans notre Guide de gestion des utilisateurs.

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

Requête HTTP

GET https://displayvideo.googleapis.com/v1/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. En règle générale, il s'agit de la valeur de nextPageToken renvoyée par l'appel précédent à la méthode users.list. Si aucune valeur n'est spécifiée, la première page de résultats est renvoyée.
orderBy

string

Champ selon lequel la liste doit être triée. Les valeurs acceptées sont les suivantes :

  • displayName (par défaut)

Par défaut, l'ordre de tri est croissant. Pour spécifier 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 composées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées à l'aide de l'opérateur logique AND.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Le champ budget.budget_segments.date_range.end_date doit utiliser l'opérateur LESS THAN (<).
  • L'opérateur displayName andemailfield must use theHAS (:)`.
  • Tous les autres champs doivent utiliser l'opérateur EQUALS (=).

Champs pris en charge:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType
  • Il s'agit du 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
  • Il s'agit d'un 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

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 de rôles utilisateur pour l'annonceur 123: assignedUserRole.advertiserId="123"
  • Tous les utilisateurs disposant de rôles utilisateur de niveau partenaire: entityType="PARTNER"
  • Tous les utilisateurs disposant de rôles utilisateur pour le partenaire 123 et les annonceurs de partenaire 123: parentPartnerId="123"

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

Pour en savoir plus, consultez notre guide sur le filtrage des requêtes 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 est 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 est 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.