Method: accounts.listSubaccounts

Permet de répertorier tous les sous-comptes d'un multicompte donné. Il s'agit d'un wrapper de commodité pour la méthode accounts.list, plus puissante. Cette méthode produira les mêmes résultats que d'appeler ListsAccounts avec le filtre suivant: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

Requête HTTP

GET https://merchantapi.googleapis.com/accounts/v1beta/{provider=accounts/*}:listSubaccounts

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
provider

string

Obligatoire. Le compte parent Format : accounts/{account}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de comptes à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 250 comptes au maximum seront renvoyés. La valeur maximale est 500. Les valeurs supérieures à 500 sont forcées à 500.
pageToken

string

Facultatif. Jeton de page reçu d'un appel accounts.list précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à accounts.list doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

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

Corps de la réponse

Message de réponse pour la méthode accounts.listSubaccounts.

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

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

object (Account)

Comptes pour lesquels le compte parent donné est un agrégateur.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

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