Method: properties.reportTasks.query

Recupera el contenido de una tarea de informe. Después de solicitar el reportTasks.create, podrás recuperar el contenido del informe una vez que este esté ACTIVO. Este método mostrará un error si el estado de la tarea del informe no es ACTIVE. Una respuesta de consulta devolverá los valores tabulares de filas y columnas del informe.

Solicitud HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

Parámetros de ruta

Parámetros
name

string

Obligatorio. Es el nombre de la fuente del informe. Formato: properties/{property}/reportTasks/{report}

Cuerpo de la solicitud

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

Representación JSON 
{
  "offset": string,
  "limit": string
}
Campos
offset

string (int64 format)

Opcional. Es el recuento de filas de la fila inicial en el informe. La primera fila se cuenta como la fila 0.

Cuando se realiza la paginación, la primera solicitud no especifica un desplazamiento o, de manera equivalente, establece el desplazamiento en 0. La primera solicitud devuelve el primer limit de filas. La segunda solicitud establece el desplazamiento en el limit de la primera solicitud, y devuelve el segundo limit de filas.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.
limit

string (int64 format)

Opcional. Es la cantidad de filas que se devolverán del informe. Si no se especifica, se devuelven 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, sin importar cuántas solicites. limit debe ser positivo.

La API también puede devolver menos filas que el limit solicitado si no hay tantos valores de dimensión como el limit. La cantidad de filas disponibles para un objeto QueryReportTaskRequest se limita aún más por el límite del objeto ReportTask asociado. Una consulta puede recuperar como máximo filas de ReportTask.limit. Por ejemplo, si ReportTask tiene un límite de 1,000, una solicitud reportTasks.query con offset=900 y limit=500 devolverá como máximo 100 filas.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.

Cuerpo de la respuesta

Es el contenido del informe correspondiente a una tarea de informe.

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

Representación JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
Campos
dimensionHeaders[]

object (DimensionHeader)

Describe las columnas de dimensiones. La cantidad de DimensionHeaders y el orden de estos coinciden con las dimensiones presentes en las filas.
metricHeaders[]

object (MetricHeader)

Describe las columnas de métricas. La cantidad de MetricHeaders y el orden de estos coinciden con las métricas presentes en las filas.
rows[]

object (Row)

Son las filas de combinaciones de valores de dimensiones y valores de métricas en el informe.
totals[]

object (Row)

Si se solicita, son los valores totales de las métricas.
maximums[]

object (Row)

Si se solicitan, son los valores máximos de las métricas.
minimums[]

object (Row)

Si se solicita, son los valores mínimos de las métricas.
rowCount

integer

Es la cantidad total de filas en el resultado de la consulta.
metadata

object (ResponseMetaData)

Son los metadatos del informe.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics