Con las tareas de informes, puedes iniciar una solicitud asíncrona de larga duración para crear un informe personalizado de tus datos de eventos de Google Analytics.
El recurso de tarea de informe que se genera a partir de esta solicitud se puede usar para que todos los usuarios con acceso de lectura a tu propiedad de Google Analytics accedan a informes personalizados.
Los informes personalizados estarán disponibles durante 72 horas después de que estén listos. Después de este período, el recurso de tarea de informe correspondiente y su contenido se borrarán automáticamente.
Crea una tarea de informe
La API de Google Analytics Data v1 usa un enfoque asíncrono para crear tareas de informes. En primer lugar, es necesaria una solicitud al método reportTasks.create para crear una tarea de informe. Luego, se usa el método reportTasks.query para recuperar el informe personalizado generado.
Además, puedes usar reportTasks.get para recuperar metadatos de configuración sobre una tarea de informe específica y reportTasks.list para enumerar todas las tareas de informe de una propiedad.
Selecciona una entidad de informes
Todos los métodos de la API de Data v1 requieren que el
identificador de propiedad de Google Analytics
se especifique dentro de una ruta de solicitud de URL en forma de
properties/GA_PROPERTY_ID, como la siguiente:
POST https://analyticsdata.googleapis.com/v1alpha/properties/GA_PROPERTY_ID/reportTasks
El informe se genera en función de los datos de eventos de Google Analytics recopilados en la propiedad de Google Analytics especificada.
Si usas una de las bibliotecas cliente de la API de datos, no es necesario manipular la ruta de URL de la solicitud de forma manual.
La mayoría de los clientes de la API proporcionan un parámetro property que espera una cadena en forma de properties/GA_PROPERTY_ID.
Consulta la guía de inicio rápido para ver ejemplos de uso de las bibliotecas cliente.
Solicita la creación de la tarea de informe
Para crear una tarea de informe, llama al método reportTasks.create con el objeto ReportTask en una solicitud. Se requieren los siguientes parámetros:
- Campo
reportDefinitionque describe la definición de un informe personalizado. La estructura de este parámetro es similar a la definición de informes que usan los métodos de informes principales.
Ejemplo de solicitud de creación de tareas de informes:
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks
{
"reportDefinition": {
"dateRanges": [{ "startDate": "2024-05-01" ", "endDate": "2024-05-15 " }],
"dimensions": [{ "name": "country" }],
"metrics": [{ "name": "activeUsers" }]
}
}
Una respuesta del método reportTasks.create contiene el nombre de la tarea de informe en el campo name (como properties/1234567/reportTasks/123), que se puede usar en consultas posteriores para obtener el estado de una tarea de informe y recuperar el informe resultante.
{
"response": {
"@type": "type.googleapis.com/google.analytics.data.v1alpha.ReportTask",
"name": "properties/1234567/reportTasks/123",
"reportDefinition": {
"dimensions": [
{
"name": "country"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"dateRanges": [
{
"startDate": "2024-05-01",
"endDate": "2024-05-15"
}
]
},
"reportMetadata": {
"state": "CREATING",
"beginCreatingTime": "2024-05-16T00:00:01.133612336Z"
}
}
}
Obtén el estado de preparación de la tarea de informe
La generación de un informe puede tardar varios minutos después de la llamada a reportTasks.create. Para obtener el estado de preparación de una tarea de informe, llama al método reportTasks.get.
Usa el nombre de la tarea de informe (como properties/1234567/reportTasks/123) que recibiste de una respuesta reportTasks.create para especificar la tarea de informe.
Ejemplo:
GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123
El estado de preparación de una tarea de informe se muestra en el campo state de una respuesta. Una vez que se completa la generación de informes, el estado de una tarea de informe cambia de CREATING a ACTIVE.
El campo reportMetadata contiene la información de alto nivel sobre el informe generado, como el recuento de filas y la cantidad de tokens de cuota cobrados.
{
"reportDefinition": {
"dimensions": [
{
"name": "country"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"dateRanges": [
{
"startDate": "2024-05-01",
"endDate": "2024-05-15"
}
]
},
"reportMetadata": {
"state": "ACTIVE",
"beginCreatingTime": "2024-05-16T00:00:01.133612336Z",
"creationQuotaTokensCharged": 6,
"taskRowCount": 167,
"errorMessage": "",
"totalRowCount": 167
}
}
Para obtener el estado de todas las tareas de informes, llama al método reportTasks.list.
Recupera el informe generado
Una vez que se genere la tarea de informe creada con el método reportTasks.create, llama al método reportTasks.query y especifica el nombre de la tarea de informe (como properties/1234567/reportTasks/123).
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123:query
Si la tarea de informe está lista, se muestra una respuesta que contiene el informe generado:
{
"dimensionHeaders": [
{
"name": "country"
}
],
"metricHeaders": [
{
"name": "activeUsers",
"type": "TYPE_INTEGER"
}
],
"rows": [
...
],
"rowCount": 167,
"metadata": {
"currencyCode": "USD",
"timeZone": "America/Los_Angeles"
}
}