Method: accounts.reports.search

Recupera un informe definido por una búsqueda. La respuesta puede contener menos filas que las especificadas por pageSize. Usa nextPageToken para determinar si hay más filas que se deben solicitar.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el ID de la cuenta que realiza la llamada. Debe ser una cuenta independiente o una cuenta secundaria de la MCA. Formato: accounts/{account}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Campos
query

string

Obligatorio. Es una consulta que define un informe que se recuperará.

Para obtener detalles sobre cómo crear tu consulta, consulta la guía del lenguaje de consulta. Para obtener la lista completa de las tablas y los campos disponibles, consulta los campos disponibles.
pageSize

integer

Opcional. Cantidad de ReportRows que se recuperarán en una sola página. La configuración predeterminada es 1,000. Los valores superiores a 5,000 se convierten a 5,000.
pageToken

string

Opcional. Es el token de la página que se recuperará. Si no se especifica, se muestra la primera página de resultados. Para solicitar la siguiente página de resultados, se debe usar el valor obtenido de nextPageToken en la respuesta anterior.

Cuerpo de la respuesta

Mensaje de respuesta para el método ReportService.Search.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
Campos
results[]

object (ReportRow)

Filas que coincidieron con la búsqueda.
nextPageToken

string

Es un token que se puede enviar como pageToken para recuperar la página siguiente. Si se omite, no habrá páginas siguientes.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.