Method: properties.reportTasks.query

Recupera el contenido de una tarea de informe. Una vez que solicites 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 a la consulta mostrará los valores de filas y columnas tabulares 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 de acceso

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 la cantidad de filas de la fila de inicio del informe. La primera fila se cuenta como la fila 0.

Cuando se realiza la paginación, la primera solicitud no especifica el desplazamiento o, de manera equivalente, lo establece en 0. La primera solicitud muestra las primeras limit de filas. La segunda solicitud establece el desplazamiento en el limit de la primera solicitud; la segunda solicitud muestra la segunda solicitud 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 mostrarán en el informe. Si no se especifica, se muestran 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, sin importar cuántas tengas. limit debe ser positivo.

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

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

Cuerpo de la respuesta

El contenido del informe correspondiente a una tarea de denuncia.

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 DimensionHeaders coinciden con las dimensiones presentes en las filas.
metricHeaders[]

object (MetricHeader)

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

object (Row)

Filas de combinaciones de valores de dimensiones y valores de métricas del informe.
totals[]

object (Row)

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

object (Row)

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

object (Row)

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

integer

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

object (ResponseMetaData)

Metadatos del informe.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

ResponseMetaData

Metadatos de la respuesta que contienen información adicional sobre el contenido de la denuncia.

Representación JSON 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Campos
dataLossFromOtherRow

boolean

Si es verdadero, indica que algunos buckets de combinaciones de dimensiones se incluyen en la fila "(other)". Esto puede ocurrir en los informes de alta cardinalidad.

El parámetro de metadatos dataLossFromOtherRow se propaga en función de la tabla de datos agregados que se usa en el informe. El parámetro se propagará con precisión independientemente de los filtros y límites del informe.

Por ejemplo, la fila (other) se podría quitar del informe porque la solicitud contiene un filtro en sessionSource = google. Este parámetro se seguirá propagando si la pérdida de datos de otra fila estaba presente en los datos agregados de entrada que se usaron para generar este informe.

Para obtener más información, consulta Acerca de la fila (other) y el muestreo de datos.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Describe las restricciones de esquema que se aplican activamente en la creación de este informe. Para obtener más información, consulta Administración de accesos y restricciones de datos.
currencyCode

string

Es el código de moneda que se utiliza en este informe. Está destinado a usarse en el formato de métricas de moneda, como purchaseRevenue, para su visualización. Si se especificó currencyCode en la solicitud, este parámetro de respuesta hará eco del parámetro de la solicitud; de lo contrario, este parámetro de respuesta será el currencyCode actual de la propiedad.

Los códigos de moneda son codificaciones de cadena de tipos de moneda según el estándar ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217); por ejemplo, “USD”, “EUR” o “JPY”. Para obtener más información, consulta https://support.google.com/analytics/answer/9796179.
timeZone

string

La zona horaria actual de la propiedad. Está destinado a usarse para interpretar dimensiones basadas en el tiempo, como hour y minute. Tienen formato como cadenas de la base de datos de zonas horarias de la IANA (https://www.iana.org/time-zones). Por ejemplo, "America/New_York" o "Asia/Tokyo".
emptyReason

string

Si se especifica un motivo vacío, el informe estará vacío por este motivo.
subjectToThresholding

boolean

Si subjectToThresholding es verdadero, este informe está sujeto a umbrales y solo muestra los datos que cumplen con los umbrales mínimos de agregación. Es posible que una solicitud esté sujeta a umbrales y que no falte ningún dato en el informe, y esto sucede cuando todos los datos superan los umbrales. Para obtener más información, consulta Umbrales de datos y Acerca de los intereses y datos demográficos.

SchemaRestrictionResponse

Las restricciones del esquema que se aplican activamente en la creación de este informe. Para obtener más información, consulta Administración de accesos y restricciones de datos.

Representación JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Campos
activeMetricRestrictions[]

object (ActiveMetricRestriction)

Todas las restricciones que se aplican activamente durante la creación del informe. Por ejemplo, purchaseRevenue siempre tiene el tipo de restricción REVENUE_DATA. Sin embargo, esta restricción de respuesta activa solo se propaga si el rol personalizado del usuario no permite el acceso a REVENUE_DATA.

ActiveMetricRestriction

Es una métrica restringida activamente en la creación del informe.

Representación JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Campos
restrictedMetricTypes[]

enum (RestrictedMetricType)

El motivo de la restricción de esta métrica.
metricName

string

El nombre de la métrica restringida.

RestrictedMetricType

Categorías de datos que puede tener restricciones para ver en ciertas propiedades GA4.

Enumeradores
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo no especificado
COST_DATA Métricas de costos como adCost
REVENUE_DATA Métricas de ingresos, como purchaseRevenue