Method: accounts.list

Lista todas as contas do usuário autenticado. Isso inclui todas as contas do usuário e todas as contas sobre as quais ele tem direitos de gerenciamento.

Solicitação HTTP

GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts

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

Parâmetros de consulta

Parâmetros
parentAccount

string

Opcional. O nome do recurso da conta para a qual a lista de contas diretamente acessíveis deve ser recuperada. Isso só faz sentido para organizações e grupos de usuários. Se estiver vazio, retornará accounts.list para o usuário autenticado. accounts/{account_id}.

pageSize

integer

Opcional. Quantas contas serão buscadas por página. O padrão e o máximo é 20.

pageToken

string

Opcional. Se especificado, a próxima página de contas é recuperada. O pageToken é retornado quando uma chamada para accounts.list retorna mais resultados do que o permitido no tamanho da página solicitado.

filter

string

Opcional. Um filtro que restringe o retorno das contas. A resposta inclui apenas entradas que correspondem ao filtro. Se filter estiver vazio, nenhuma restrição será aplicada, e todas as contas (paginadas) serão recuperadas para a conta solicitada.

Por exemplo, uma solicitação com o filtro type=USER_GROUP retornará apenas grupos de usuários.

O campo type é o único filtro aceito.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para Accounts.ListAccounts.

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)

Um conjunto de contas ao qual o usuário tem acesso. A conta pessoal do usuário que fez a consulta será sempre o primeiro item do resultado, a menos que seja filtrada.

nextPageToken

string

Se o número de contas exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de contas em uma chamada subsequente para accounts.list. Se não houver mais contas, este campo não estará presente na resposta.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

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