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 esté ACTIVO. Este método mostrará un error si el estado de la tarea de informe no es ACTIVE. Una respuesta de consulta mostrará la fila tabular y valores de columna 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. El recuento de filas de la fila inicial en el informe. La primera fila se cuenta como fila 0.

Durante la paginación, la primera solicitud no especifica el desplazamiento. o, de forma equivalente, establece el desplazamiento en 0; la primera solicitud muestra el primer limit de las filas. La segunda solicitud establece el desplazamiento al limit de la primera. la segunda solicitud muestra el segundo limit de las 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, independientemente de cuántas solicites. El valor de 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 limit. La cantidad de filas disponibles para una QueryReportTaskRequest se ve limitada por el límite de la ReportTask asociada. Una consulta puede recuperar como máximo las filas ReportTask.limit. Por ejemplo, si ReportTask tiene un límite de 1,000, una solicitud reportTasks.query con offset=900 y limit=500 mostrará 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

El contenido del informe que corresponde 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 coincide con las dimensiones presentes en las filas.
metricHeaders[]

object (MetricHeader)

Describe las columnas de métricas. La cantidad de MetricHeaders y el orden de los 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 permisos de OAuth:

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

ResponseMetaData

Los 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 intervalos de combinaciones de dimensiones se incluyen en "(other)". fila. Esto puede suceder 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 usó en el informe. El parámetro se propagará con precisión, independientemente de los filtros y los límites del informe.

Por ejemplo, la fila (other) podría quitarse del informe porque la solicitud contiene un filtro en sessionSource = google. Este parámetro se completará si hay pérdida de datos de otra fila 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 aplicadas de forma activa 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 usa en este informe. Está destinado a usarse para dar formato a métricas de moneda, como purchaseRevenue, para su visualización. Si se especificó currencyCode en la solicitud, este parámetro de respuesta replicará el parámetro de la solicitud. De lo contrario, este parámetro de respuesta es el currencyCode actual de la propiedad.

Los códigos de moneda son codificaciones de cadenas de tipos de monedas 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á diseñado para usarse para interpretar dimensiones basadas en el tiempo, como hour y minute. Están formadas como cadenas de la base de datos de zonas horarias de IANA (https://www.iana.org/time-zones). por ejemplo, "América/Nueva_York" o “Asia/Tokio”.
emptyReason

string

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

boolean

Si la subjectToThresholding es verdadera, este informe estará sujeto a umbrales y solo mostrará los datos que cumplan con los umbrales de agregación mínimos. Es posible que una solicitud esté sujeta a umbrales y no falten datos en el informe. Esto sucede cuando todos los datos superan los umbrales. Para obtener más información, consulta Umbrales de datos y Acerca de los datos demográficos y los intereses.

SchemaRestrictionResponse

Son las restricciones de esquema aplicadas de forma activa 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 de forma activa en 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 completa si el rol personalizado del usuario no permite el acceso a REVENUE_DATA.

ActiveMetricRestriction

Es una métrica que se restringe de forma activa 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

Es el nombre de la métrica restringida.

RestrictedMetricType

Son las categorías de datos que es posible que no puedas ver en ciertas propiedades GA4.

Enumeraciones
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo no especificado
COST_DATA Las métricas de costos, como adCost
REVENUE_DATA Las métricas de ingresos, como purchaseRevenue