Method: accounts.list

Répertorie tous les comptes de l'utilisateur authentifié. Cela inclut tous les comptes dont l'utilisateur est propriétaire ou dont il dispose des droits de gestion.

Requête HTTP

GET https://mybusiness.googleapis.com/v4/accounts

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
pageSize

integer

Nombre de comptes à récupérer par page. La valeur par défaut est 20, la minimale est 2 et la maximale est 20.
pageToken

string

Si elle est spécifiée, la page de comptes suivante est récupérée. Le pageToken est renvoyé lorsqu'un appel à accounts.list renvoie plus de résultats que la taille de page demandée ne peut en tenir.
name

string

Nom de ressource du compte pour lequel la liste des comptes directement accessibles doit être récupérée. Cela n'a de sens que pour les organisations et les groupes d'utilisateurs. Si ce champ est vide, renvoie accounts.list pour l'utilisateur authentifié.
filter

string

Filtre contraignant les comptes à afficher. La réponse n'inclut que les entrées qui correspondent au filtre. Si filter est vide, aucune contrainte n'est appliquée et tous les comptes (paginés) sont récupérés pour le compte demandé.

Par exemple, une requête avec le filtre type=USER_GROUP ne renverra que des groupes d'utilisateurs.

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 qui ont la structure suivante :

Message de réponse pour Accounts.ListAccounts.

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

object (Account)

Ensemble de comptes auxquels l'utilisateur a accès. Le compte personnel de l'utilisateur effectuant la requête sera toujours le premier élément du résultat, sauf s'il est filtré.
nextPageToken

string

Si le nombre de comptes dépasse la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page de comptes suivante lors d'un prochain appel à accounts.list. S'il n'y a plus de comptes, ce champ n'est pas présent dans la réponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

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