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á los valores de las 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 el recuento de filas de la fila inicial del informe. La primera fila se cuenta como fila 0.

Cuando se pagina, la primera solicitud no especifica el desplazamiento, o lo que es equivalente, lo establece en 0. La primera solicitud muestra la primera limit de filas. La segunda solicitud establece el desplazamiento en el limit de la primera solicitud. La segunda solicitud muestra 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 mostrarán en el informe. Si no se especifica, se devuelven 10,000 filas. La API muestra un máximo de 250,000 filas por solicitud, independientemente de cuántas solicites. limit debe ser positivo.

La API también puede mostrar menos filas que el limit solicitado, si no hay tantos valores de dimensión como el limit. La cantidad de filas disponibles para una QueryReportTaskRequest se limita aún más por el límite de la ReportTask asociada. Una consulta puede recuperar como máximo ReportTask.limit filas. Por ejemplo, si la 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

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 DimensionHeaders 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 MetricHeaders 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, 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

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

object (ResponseMetaData)

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

ResponseMetaData

Son los metadatos de la respuesta que contienen información adicional sobre el contenido del informe.

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

boolean

Si es verdadero, indica que algunos grupos de combinaciones de dimensiones se incluyen en la fila "(other)". 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 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) podría eliminarse del informe porque la solicitud contiene un filtro en sessionSource = google. Este parámetro se propagará de todos modos 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.
samplingMetadatas[]

object (SamplingMetadata)

Si los resultados de este informe se muestran, se describe el porcentaje de eventos que se usan en este informe. Se propaga un samplingMetadatas para cada período. Cada samplingMetadatas corresponde a un período para que los períodos se especifiquen en la solicitud.

Sin embargo, si no se toman muestras de los resultados, este campo no se definirá.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Describe las restricciones de esquemas que se aplican de forma activa cuando se crea este informe. Para obtener más información, consulta Administración del acceso y de la restricción de datos.
currencyCode

string

Es el código de moneda que se usa en este informe. Se usa para dar formato a las métricas de moneda, como purchaseRevenue, para la visualización. Si se especificó currencyCode en la solicitud, este parámetro de respuesta repetirá el parámetro de 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 moneda del estándar ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217); por ejemplo, "USD", "EUR", "JPY". Para obtener más información, consulta https://support.google.com/analytics/answer/9796179.
timeZone

string

Es la zona horaria actual de la propiedad. Se usa para interpretar dimensiones basadas en el tiempo, como hour y minute. Con formato de cadenas de la base de datos de zonas horarias de 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 datos que cumplen con los umbrales mínimos de agregación. Es posible que una solicitud esté sujeta a un umbral de umbrales y que no falten datos en el informe. Esto sucede cuando todos los datos están por encima de los umbrales. Para obtener más información, consulta Umbral de datos y Acerca de los datos demográficos y de intereses.

SchemaRestrictionResponse

Las restricciones de esquema que se aplican de forma activa cuando se crea este informe Para obtener más información, consulta Administración del acceso y de la restricción de datos.

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

object (ActiveMetricRestriction)

Todas las restricciones que se aplican de forma activa cuando se crea el 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

Una métrica restringida de forma activa cuando se crea el 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 categorías de datos que es posible que no puedas ver en ciertas propiedades de Google Analytics.

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