- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de autorización
- Pruébalo
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 en la API son una tabla con columnas para las dimensiones y métricas solicitadas. Las métricas son mediciones individuales de la actividad de los usuarios en tu propiedad, como la cantidad de usuarios activos o de eventos. Las dimensiones desglosan las métricas en función de 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 de acceso
Parámetros | |
---|---|
property |
Es un identificador de propiedad de Google Analytics cuyos eventos se registran. 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. Dentro de 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 ( |
Campos | |
---|---|
dimensions[] |
Las dimensiones solicitadas y mostradas |
metrics[] |
Las métricas solicitadas y mostradas |
date |
Son los períodos de los datos que se deben leer. 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 de eventos de los días superpuestos se incluyen en las filas de respuesta de ambos períodos. En una solicitud de cohorte, este |
dimension |
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 obtén ejemplos. No se pueden usar métricas en este filtro. |
metric |
Es la cláusula de filtro de las métricas. Se aplica después de agregar las filas del informe, de manera similar a la cláusula having de SQL. No se pueden usar dimensiones en este filtro. |
offset |
Es el recuento de filas de la fila inicial. 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 Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
limit |
Es la cantidad de filas que se mostrarán. 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. La API también puede mostrar menos filas que el Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
metric |
Agregación de métricas. Los valores de las métricas agregadas se mostrarán en las filas en las que los dimensionValues estén configurados como "RESERVED_(MetricAggregation)". Los agregados que incluyan comparaciones y varios períodos se agregarán en función de los períodos. |
order |
Especifica cómo se ordenan las filas en la respuesta. Las solicitudes que incluyan comparaciones y varios períodos tendrán órdenes aplicados en las comparaciones. |
currency |
Un código de moneda en formato ISO 4217, como "AED", "USD" o "JPY". Si el campo está vacío, el informe usará la moneda predeterminada de la propiedad. |
cohort |
Es el grupo de cohorte asociado con esta solicitud. Si hay un grupo de cohortes en la solicitud, la dimensión "cohort" debe estar presente. |
keep |
Si es falso o no se especifica, no se mostrará cada fila con todas las métricas iguales a 0. Si es verdadero, se mostrarán estas filas si no se quitan por separado con un filtro. Independientemente de este parámetro de configuración Por ejemplo, si una propiedad nunca registra un evento |
return |
Activa o desactiva si se debe mostrar el estado actual de la cuota de esta propiedad de Google Analytics. La cuota se muestra en PropertyQuota. |
comparisons[] |
Opcional. 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