Method: properties.runReport

Devuelve 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 devuelve la API se presentan en 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.

Solicitud HTTP

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

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

Parámetros de ruta

Parámetros
property

string

Obligatorio. 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)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Campos
dimensions[]

object (Dimension)

Opcional. Son las dimensiones solicitadas y mostradas.
metrics[]

object (Metric)

Opcional. Son las métricas solicitadas y que se muestran.
dateRanges[]

object (DateRange)

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

object (FilterExpression)

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

object (FilterExpression)

Opcional. 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. No se pueden usar dimensiones en este filtro.
offset

string (int64 format)

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

Cuando se realiza la paginación, la primera solicitud no especifica un desplazamiento o, de manera equivalente, establece el desplazamiento en 0. La primera solicitud devuelve el primer limit de filas. La segunda solicitud establece el desplazamiento en el limit de la primera solicitud, y devuelve 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 máxima de filas que se devolverán. Si no se especifica, se devuelven 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, sin importar cuántas solicites. limit debe ser positivo.

La API también puede devolver menos filas que el limit solicitado si no hay tantos valores de dimensión 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)

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

object (OrderBy)

Opcional. Especifica cómo se ordenan las filas en la respuesta. Las solicitudes que incluyen comparaciones y varios períodos tendrán cláusulas order by aplicadas a las comparaciones.
currencyCode

string

Opcional. 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)

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

boolean

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

Independientemente de este parámetro de 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 búsqueda de la dimensión eventName y la métrica eventCount no tendrá una fila eventName: "purchase" y eventCount: 0.
returnPropertyQuota

boolean

Opcional. Alterna si se debe devolver el estado actual de la cuota de esta propiedad de Google Analytics. La cuota se devuelve en PropertyQuota.
comparisons[]

object (Comparison)

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.
conversionSpec

object (ConversionSpec)

Opcional. Controla el registro de conversiones. Este campo es opcional. Si se configura este campo o se solicitan métricas de conversiones, el informe será un informe de conversiones.

Cuerpo de la respuesta

Es la tabla del informe de respuesta correspondiente a una solicitud.

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)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
Campos
dimensionHeaders[]

object (DimensionHeader)

Describe las columnas de dimensiones. La cantidad de DimensionHeaders y el orden de estos 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 estos 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, son los valores totales de las métricas.
maximums[]

object (Row)

Si se solicitan, son los valores máximos de las métricas.
minimums[]

object (Row)

Si se solicita, son los valores mínimos de las métricas.
rowCount

integer

Es la cantidad total de filas en el resultado de la consulta, independientemente de la cantidad de filas que se devuelven en la respuesta. Por ejemplo, si una búsqueda devuelve 175 filas y la solicitud a la API incluye limit = 50, la respuesta contendrá rowCount = 175, pero solo 50 filas.

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

object (ResponseMetaData)

Son los metadatos del informe.
propertyQuota

object (PropertyQuota)

Es el estado de la cuota de esta propiedad de Analytics, incluida esta solicitud.
kind

string

Identifica qué tipo de recurso es este mensaje. Este kind siempre es la cadena fija "analyticsData#runReport". Es útil para distinguir entre los tipos de respuesta en JSON.
nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

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

Comparación

Define una comparación individual. La mayoría de las solicitudes incluirán varias comparaciones para que el informe compare entre las comparaciones.

Representación JSON 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
Campos
name

string

Cada comparación produce filas separadas en la respuesta. En la respuesta, esta comparación se identifica con este nombre. Si no se especifica el nombre, usaremos el nombre visible de las comparaciones guardadas.

Campo de unión one_comparison.

one_comparison puede ser una de las siguientes opciones:
dimensionFilter

object (FilterExpression)

Una comparación básica.
comparison

string

Es una comparación guardada que se identifica por el nombre del recurso de la comparación. Por ejemplo, “comparisons/1234”.

ConversionSpec

Controla el registro de conversiones.

Representación JSON 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Campos
conversionActions[]

string

Son los IDs de las acciones de conversión que se incluirán en el informe. Si está vacío, se incluyen todas las conversiones. Los IDs de acciones de conversión válidos se pueden recuperar del campo conversionAction dentro de la lista conversions en la respuesta del método properties.getMetadata. Por ejemplo, "conversionActions/1234".
attributionModel

enum (AttributionModel)

Es el modelo de atribución que se usará en el Informe de conversiones. Si no se especifica, se usa DATA_DRIVEN.

AttributionModel

Modelo de atribución que se usará en el Informe de conversiones

Enums
ATTRIBUTION_MODEL_UNSPECIFIED Modelo de atribución sin especificar.
DATA_DRIVEN La atribución se basó en el modelo basado en datos de canales pagados y orgánicos
LAST_CLICK La atribución se basó en el modelo de último clic en canales pagados y orgánicos