Aspectos básicos de las tareas relacionadas con informes

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 Report Task generado a partir de esta solicitud se puede usar para acceder informes personalizados de todos los usuarios con acceso de lectura a tus datos de Google Analytics propiedad.

Un informe personalizado estará disponible durante 72 horas una vez que esté listo. Después de esto de la tarea, el recurso de tarea del informe correspondiente y su contenido se se borran automáticamente.

Crear una tarea de informe

La API de datos de Google Analytics v1 usa un enfoque asíncrono para crear tareas de informes. En primer lugar, una solicitud a la reportTasks.create necesario para crear una tarea de informe. Luego, la reportTasks.query se usa para recuperar el informe personalizado que se generó.

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 informes de una propiedad.

Seleccionar una entidad denunciante

Todos los métodos de la API de datos v1 requieren la Identificador de propiedad de Google Analytics que se especificará dentro de una ruta de solicitud de URL con el formato properties/GA_PROPERTY_ID, por ejemplo:

  POST  https://analyticsdata.googleapis.com/v1alpha/properties/GA_PROPERTY_ID/reportTasks

El informe se genera en función del evento de Google Analytics. Los datos recopilados en la propiedad de Google Analytics especificada

Si usas una de las bibliotecas cliente de la API de datos, haz lo siguiente: no es necesario manipular la ruta de la URL de solicitud de forma manual. La mayoría de los clientes de la API proporcionan un parámetro property que espera un con el formato properties/GA_PROPERTY_ID. Consulta la Guía de inicio rápido para ver ejemplos del uso de las bibliotecas cliente.

Solicita la creación de la tarea de informes

Para crear una tarea de informe, llama al reportTasks.create con el ReportTask objeto de una solicitud. Se requieren los siguientes parámetros:

Ejemplo de solicitud de creación de tarea de informe:

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 informe. Nombre de la tarea en el campo name (p. ej., properties/1234567/reportTasks/123), que se puede utilizar en las consultas posteriores para obtener el estado de una tarea de informe y recuperar el 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

Generar un informe puede demorar varios minutos después de reportTasks.create llamada. Puedes obtener el estado de preparación de una tarea de informe llamando al reportTasks.get .

Usa el nombre de la tarea de informes (como properties/1234567/reportTasks/123). que recibiste de una respuesta reportTasks.create para especificar Denunciar tarea.

Ejemplo:

GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123

El estado de preparación de una tarea de informe se devuelve en state de una respuesta. Una vez completada la generación del informe, el estado de una tarea de informe cambia de CREATING a ACTIVE.

La reportMetadata contiene la información de alto nivel sobre el informe generado, como el recuento de filas y la cantidad de tokens de cuota que se cobran.

{
 
"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
 
}
}

Puedes obtener el estado de todas las tareas de informes llamando al reportTasks.list .

Cómo recuperar el informe generado

Una vez creada la tarea de informes con el comando reportTasks.create de red, llama al método reportTasks.query y especifica el nombre de la tarea del 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"
 
}
}