- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- ResponseMetaData
- SchemaRestrictionResponse
- ActiveMetricRestriction
- RestrictedMetricType
- Pruébalo
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 |
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. 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 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, independientemente de cuántas solicites. El valor de 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 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 ( |
Campos | |
---|---|
dimensionHeaders[] |
Describe las columnas de dimensiones. La cantidad de DimensionHeaders y el orden de DimensionHeaders coincide con las dimensiones presentes en las filas. |
metricHeaders[] |
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[] |
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 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 ( |
Campos | |
---|---|
dataLossFromOtherRow |
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 |
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 |
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 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 |
La zona horaria actual de la propiedad. Está diseñado para usarse para interpretar dimensiones basadas en el tiempo, como |
emptyReason |
Si se especifica un valor vacío, el informe estará vacío por este motivo. |
subjectToThresholding |
Si la |
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 ( |
Campos | |
---|---|
activeMetricRestrictions[] |
Todas las restricciones que se aplican de forma activa en la creación del informe. Por ejemplo, |
ActiveMetricRestriction
Es una métrica que se restringe de forma activa en la creación del informe.
Representación JSON |
---|
{
"restrictedMetricTypes": [
enum ( |
Campos | |
---|---|
restrictedMetricTypes[] |
El motivo de la restricción de esta métrica. |
metricName |
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 |