Method: properties.runReport

Muestra un informe personalizado de tus datos de eventos de Google Analytics. Los informes contienen estadísticas derivadas de los datos recopilados por el código de seguimiento de Google Analytics. Los datos que se muestran de la API se presentan como una tabla con columnas para las dimensiones y métricas solicitadas. Las métricas son mediciones individuales de la actividad del usuario en tu propiedad, como los usuarios activos o el recuento de eventos. Las dimensiones desglosan las métricas según algunos criterios comunes, como el país o el nombre del evento.

Para obtener una guía sobre cómo crear solicitudes y comprender las respuestas, consulta Cómo crear un informe.

Solicitud HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
property

string

Es un identificador de propiedad de Google Analytics cuyos eventos se rastrean. Se especifica en la ruta de URL y no en el cuerpo. Para obtener más información, consulta dónde encontrar el ID de tu propiedad. En una solicitud por lotes, esta propiedad no debe especificarse o debe ser coherente con la propiedad a nivel del lote.

Ejemplo: properties/1234

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Campos
dimensions[]

object (Dimension)

Son las dimensiones solicitadas y mostradas.
metrics[]

object (Metric)

Son las métricas solicitadas y mostradas.
dateRanges[]

object (DateRange)

Son los períodos de los datos que se leerán. Si se solicitan varios períodos, cada fila de respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, los datos de eventos de los días superpuestos se incluyen en las filas de respuesta de ambos períodos. En una solicitud de cohorte, este dateRanges no debe especificarse.
dimensionFilter

object (FilterExpression)

Los filtros de dimensiones te permiten solicitar solo valores de dimensiones específicos en el informe. Para obtener más información, consulta Conceptos básicos de los filtros de dimensiones para ver ejemplos. Las métricas no se pueden usar en este filtro.
metricFilter

object (FilterExpression)

Es la cláusula de filtro de las métricas. Se aplica después de agregar las filas del informe, de forma similar a la cláusula having de SQL. Las dimensiones no se pueden usar en este filtro.
offset

string (int64 format)

Es el recuento de filas de la fila de inicio. La primera fila se cuenta como la fila 0.

Cuando se pagina, la primera solicitud no especifica el desplazamiento o, de manera equivalente, establece el desplazamiento en 0. La primera solicitud muestra el primer 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)

Es la cantidad de filas que se mostrarán. Si no se especifica, se muestran 10,000 filas. La API muestra un máximo de 250,000 filas por solicitud, sin importar 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 dimensiones como el limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country, por lo que, cuando generas informes solo sobre country, no puedes obtener más de 300 filas, incluso si estableces limit en un valor más alto.

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

enum (MetricAggregation)

Es la agregación de métricas. Los valores de métricas agregados se mostrarán en las filas en las que los dimensionValues estén configurados como "RESERVED_(MetricAggregation)". Los agregados, incluidas las comparaciones y los períodos múltiples, se agregarán según los períodos.
orderBys[]

object (OrderBy)

Especifica cómo se ordenan las filas en la respuesta. Las solicitudes que incluyen comparaciones y períodos múltiples tendrán órdenes aplicados en las comparaciones.
currencyCode

string

Es un código de moneda en formato ISO4217, como "AED", "USD" o "JPY". Si el campo está vacío, el informe usa la moneda predeterminada de la propiedad.
cohortSpec

object (CohortSpec)

Es el grupo de cohortes asociado con esta solicitud. Si hay un grupo de cohortes en la solicitud, la dimensión "cohort" debe estar presente.
keepEmptyRows

boolean

Si es falso o no se especifica, no se mostrará cada fila con todas las métricas iguales a 0. Si es verdadero, estas filas se mostrarán si un filtro no las quita por separado.

Independientemente de esta configuración de keepEmptyRows, solo se pueden mostrar en un informe los datos registrados por la propiedad de Google Analytics.

Por ejemplo, si una propiedad nunca registra un evento purchase, una consulta para la dimensión eventName y la métrica eventCount no tendrá una fila eventName: "purchase" y eventCount: 0.
returnPropertyQuota

boolean

Activa o desactiva la opción para mostrar el estado actual de la cuota de esta propiedad de Google Analytics. La cuota se muestra en PropertyQuota.
comparisons[]

object (Comparison)

Es opcional. Es la configuración de las comparaciones solicitadas y mostradas. La solicitud solo requiere un campo de comparaciones para recibir una columna de comparación en la respuesta.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de RunReportResponse.

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