Method: accounts.reports.search

Recupera um relatório definido por uma consulta de pesquisa. A resposta pode conter menos linhas do que o especificado por pageSize. Use nextPageToken para determinar se há mais linhas a serem solicitadas.

Solicitação HTTP

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. ID da conta que fez a chamada. Precisa ser uma conta independente ou uma subconta de MCA. Formato: accounts/{account}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Campos
query

string

Obrigatório. Consulta que define um relatório a ser recuperado.

Para saber como criar sua consulta, consulte o guia da linguagem de consulta. Para conferir a lista completa de tabelas e campos disponíveis, consulte os campos disponíveis.
pageSize

integer

Opcional. Número de ReportRows a serem recuperados em uma única página. O valor padrão é 1000. Valores acima de 5.000 são convertidos em 5.000.
pageToken

string

Opcional. Token da página a ser recuperada. Se não for especificado, a primeira página de resultados será retornada. Para solicitar a próxima página de resultados, use o valor recebido de nextPageToken na resposta anterior.

Corpo da resposta

Mensagem de resposta para o método ReportService.Search.

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

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

object (ReportRow)

Linhas que correspondem à consulta de pesquisa.
nextPageToken

string

Token que pode ser enviado como pageToken para recuperar a próxima página. Se 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.