Descripción general de la API de Google Analytics Data

Puedes usar la API de datos para acceder de manera programática a los datos de los informes de Google Analytics.

Obtén más información sobre las propiedades de Google Analytics.

Los datos que devuelve la API son coherentes con los que se muestran en la interfaz de usuario de Google Analytics y respetan por completo la configuración de la identidad para los informes (como Combinada, Observada o Basada en el dispositivo) que se estableció para tu propiedad de Google Analytics.

A continuación, se incluyen algunos ejemplos de informes que puedes generar con la versión 1 de la API de Google Analytics Data:

  • ¿Cuántos usuarios activos por día tuvo tu app para Android durante la semana pasada?
  • Cuántas vistas de página tuvieron las 10 páginas principales de tu sitio en los últimos 28 días.
  • Cuántos usuarios activos por país tuvo tu app para iOS en los últimos 30 minutos

También puedes usar la versión 1 de la API de Google Analytics Data para hacer lo siguiente:

  • Crear paneles personalizados para mostrar datos de Google Analytics
  • Automatizar tareas complejas de informes para ahorrar tiempo
  • Integrar tus datos de Google Analytics con otras aplicaciones empresariales

Coherencia de los datos y la identidad para los informes

La API de Google Analytics Data v1 accede a los mismos datos de informes que la interfaz de Google Analytics. Los datos que devuelve la API respetan por completo la configuración de la identidad para los informes establecida para tu propiedad de Google Analytics, de modo que los recuentos de usuarios, la anulación de duplicaciones y el modelado de datos se alineen con el espacio de identidad elegido (como Mixto, Observado o Basado en el dispositivo) en la configuración de tu propiedad.

Para obtener más información sobre cómo los diferentes espacios de identidad pueden afectar tus informes, consulta Identidad para los informes.

Comenzar

Para comenzar a usar una biblioteca cliente en Java, Python, Node.js, PHP, C#, Go o Ruby, consulta la guía de inicio rápido de la biblioteca cliente. Para aprender a crear consultas, filtrar dimensiones y leer respuestas, consulta Crea un informe o prueba consultas de forma interactiva en el Explorador de consultas.

Ejemplo de solicitud y respuesta de runReport

Para consultar datos de eventos a través de REST, envía una solicitud POST al extremo runReport con un cuerpo JSON RunReportRequest que especifique tu dateRanges, dimensions y metrics:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [
    { "startDate": "7daysAgo", "endDate": "yesterday" }
  ],
  "dimensions": [
    { "name": "country" }
  ],
  "metrics": [
    { "name": "activeUsers" }
  ]
}

O ejecuta el comando curl equivalente con las credenciales predeterminadas de la aplicación:

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

La API devuelve un RunReportResponse que contiene encabezados de columna y filas de datos:

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

Métodos disponibles

Esta es una lista de los métodos de la API de datos. Para obtener más detalles, consulta la documentación de referencia.

  • runReport Este método devuelve un informe personalizado de tus datos de eventos de Google Analytics y es el método preferido para las consultas de informes simples.
  • batchRunReports Esta es una versión por lotes del método runReport que te permite generar varios informes con una sola llamada a la API.
  • runPivotReport Este método devuelve un informe de tabla dinámica personalizado de tus datos de eventos de Google Analytics. Los informes dinámicos son formatos más avanzados y expresivos que los informes normales. Cada tabla dinámica describe las columnas y filas de dimensiones visibles en la respuesta del informe.
  • batchRunPivotReports Esta es una versión por lotes del método runPivotReport que te permite generar varios informes con una sola llamada a la API.
  • getMetadata Este método devuelve metadatos para las dimensiones y métricas disponibles en los métodos de informes. Se usa para explorar las dimensiones y las métricas. La respuesta de este método también incluye las dimensiones y métricas personalizadas disponibles para la propiedad de Google Analytics especificada.
  • checkCompatibility Este método enumera las dimensiones y métricas que se pueden agregar a una solicitud de informe y mantener la compatibilidad.
  • runRealtimeReport Este método devuelve un informe personalizado de datos de eventos en tiempo real para tu propiedad. Los eventos aparecen en los informes en tiempo real segundos después de que se envían a Google Analytics. Los informes En tiempo real muestran los eventos y los datos de uso de los períodos que van desde el momento actual hasta 30 minutos atrás (hasta 60 minutos para las propiedades de Google Analytics 360).
  • properties.audienceExports Es un grupo de métodos que te permiten generar exportaciones de públicos, que incluyen una instantánea de los usuarios de un público.
  • properties.recurringAudienceLists (Versión preliminar anticipada) Es un grupo de métodos que te permiten administrar las exportaciones de públicos recurrentes. Una exportación de público recurrente produce listas de público nuevas cada día.
  • runFunnelReport (Versión preliminar anticipada) Este método devuelve un informe de embudo personalizado de tus datos de eventos de Google Analytics. La exploración de embudo te permite visualizar los pasos que siguen los usuarios para completar una tarea y ver rápidamente si tienen éxito o no en cada paso.
  • properties.chat (Versión preliminar anticipada) Este método proporciona acceso conversacional programático a Ask Advisor en Google Analytics. Puedes hacer preguntas en lenguaje natural sobre tus datos de eventos, diagnosticar cambios en el rendimiento y recibir estadísticas narrativas y tabulares estructuradas.

Dimensiones y métricas admitidas

Para obtener una lista de todas las dimensiones y métricas que admite la API de datos, consulta la documentación del esquema de la API.