- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de autorización
- ResponseMetaData
- SchemaRestrictionResponse
- ActiveMetricRestriction
- RestrictedMetricType
- Pruébala
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 |
Obligatorio. Es el nombre de la fuente del informe. Formato: |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "offset": string, "limit": string } |
Campos | |
---|---|
offset |
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 Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
limit |
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. La API también puede mostrar menos filas que la 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 ( |
Campos | |
---|---|
dimensionHeaders[] |
Describe las columnas de dimensiones. La cantidad de DimensionHeaders y el orden de DimensionHeaders coinciden con las dimensiones presentes en las filas. |
metricHeaders[] |
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[] |
Filas de combinaciones de valores de dimensiones y valores de métricas del informe. |
totals[] |
Si se solicita, los valores totales de las métricas. |
maximums[] |
Si se solicita, los valores máximos de las métricas. |
minimums[] |
Si se solicita, los valores mínimos de las métricas. |
rowCount |
La cantidad total de filas en el resultado de la consulta. |
metadata |
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 ( |
Campos | |
---|---|
dataLossFromOtherRow |
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 |
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 |
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 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 |
La zona horaria actual de la propiedad. Está destinado a usarse para interpretar dimensiones basadas en el tiempo, como |
emptyReason |
Si se especifica un motivo vacío, el informe estará vacío por este motivo. |
subjectToThresholding |
Si |
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 ( |
Campos | |
---|---|
activeMetricRestrictions[] |
Todas las restricciones que se aplican activamente durante la creación del informe. Por ejemplo, |
ActiveMetricRestriction
Es una métrica restringida activamente en la creación del informe.
Representación JSON |
---|
{
"restrictedMetricTypes": [
enum ( |
Campos | |
---|---|
restrictedMetricTypes[] |
El motivo de la restricción de esta métrica. |
metricName |
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 |