Method: accounts.listSubaccounts

Liste todas as subcontas de uma determinada conta de múltiplos clientes. Esse é um wrapper de conveniência para o método accounts.list mais eficiente. Esse método produzirá os mesmos resultados que chamar ListsAccounts com o seguinte filtro: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
provider

string

Obrigatório. A conta principal. Formato: accounts/{account}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de contas a serem retornadas. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 250 contas são retornadas. O valor máximo é 500. valores acima de 500 são convertidos para 500.
pageToken

string

Opcional. Um token de página recebido de uma chamada accounts.list anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para accounts.list precisam corresponder à chamada que forneceu o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método accounts.listSubaccounts.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
Campos
accounts[]

object (Account)

As contas para as quais a conta principal fornecida é um agregador.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.