Listas de público recurrentes

En este documento, se describen las listas de público recurrentes, que son una función avanzada de la API de datos de Google Analytics v1. Para obtener una introducción a la función de exportación de listas de público, consulta la guía de conceptos básicos de la exportación de públicos.

Las listas de público recurrentes producen listas de público a diario a medida que cambian las membresías del público para garantizar que estés trabajando con los datos más recientes.

Las listas de público normales (no recurrentes) son listas estáticas de usuarios del público en el momento en que se genera la lista.

Crea una lista de público nueva a diario

El procesamiento de los datos del público de un día y la actualización de la membresía pueden tardar un tiempo variable. No hay forma de asegurarse de que los datos de la lista de público se actualicen en 24 horas.

Por ejemplo, incluso si solicitas una lista de público a la misma hora todos los días, algunos días la lista de público será la misma que la del día anterior y, en otros días, será diferente y contendrá un día adicional de cambios de membresía.

Cómo crear una lista de público nueva a diario

Las listas de público se basan en los datos de eventos del día anterior a los cambios de membresía más recientes. Si creas una lista de público antes de que se produzcan las actualizaciones diarias de membresías, se usarán los datos de los dos días anteriores. Si creas una lista de público después de que se produzcan las actualizaciones diarias de membresías, se usarán los datos del día anterior.

Cómo sondear periódicamente una lista de público recurrente

Las listas de público recurrentes solo producen listas de público cuando hay datos de un día adicional disponibles. Esto elimina las conjeturas de decidir cuándo crear nuevas listas de público. En su lugar, puedes sondear la lista de público recurrente a bajo costo durante el día para ver si hay datos adicionales disponibles.

Consultar periódicamente una lista de público recurrente durante el día

Cómo crear una lista de público recurrente

Para crear una lista de público recurrente, llama al método recurringAudienceLists.create con el objeto RecurringAudienceList en una solicitud. Se requieren los siguientes parámetros:

  • Un nombre de público válido en el campo audience con el formato properties/{propertyId}/audiences/{audienceId} Puedes usar el método audiences.list de la API de Google Analytics Admin v1 para obtener este valor. El campo Audience.name de la respuesta audiences.list contiene el nombre del público.
  • Es una lista válida de dimensiones en el campo dimensions. Puedes encontrar la lista de dimensiones compatibles con este método en la documentación del esquema de exportación de públicos. Solo los datos de las dimensiones mencionadas en este campo se incluyen en una lista de público.

A continuación, se muestra una solicitud de creación de lista de público recurrente de ejemplo:

Solicitud HTTP

POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/recurringAudienceLists
{
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

Una respuesta del método recurringAudienceLists.create contiene el nombre en el campo name (como properties/1234567/recurringAudienceLists/123), que se puede usar en consultas posteriores para recuperar los metadatos de configuración de esta lista de público recurrente. Además, los metadatos de configuración contienen los nombres de recursos para las instancias de la lista de público que se crearon para esta lista de público recurrente.

Respuesta HTTP

{
  "name": "properties/1234567/recurringAudienceLists/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "activeDaysRemaining": 180,
  "audienceLists": [
    "properties/1234567/audienceLists/45678"
  ]
}

Metadatos de configuración de sondeos

Usa el método recurringAudienceLists.get para recuperar los metadatos de configuración de una lista de público recurrente específica. Los metadatos de configuración contienen los nombres de recursos para las instancias de la lista de público que se crearon para esta lista de público recurrente.

Por ejemplo:

Solicitud HTTP

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

Se muestra una instancia de RecurringAudienceList en la respuesta. Contiene los metadatos de configuración, que incluyen los nombres de recursos para las instancias de la lista de público que se crearon para esta lista de público recurrente.

Respuesta HTTP

{
  "name": "properties/1234567/recurringAudienceLists/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "activeDaysRemaining": 180,
  "audienceLists": [
    "properties/1234567/audienceLists/45678"
  ]
}

Puedes usar recurringAudienceLists.list para enumerar todas las listas de público recurrentes de una propiedad.

Usa webhooks para recibir notificaciones asíncronas sobre listas de público nuevas

En lugar de sondear periódicamente los metadatos de configuración sobre una lista de público recurrente específica con el método recurringAudienceLists.get, puedes recibir notificaciones de webhook de forma asíncrona cuando una lista de público esté disponible.

Para configurar las notificaciones de webhook, especifica el campo webhookNotification cuando crees una nueva lista de público recurrente.

Sigue la guía de Async audience lists with webhooks para obtener más información sobre el uso de losWebhooks en la API de datos de Google Analytics v1.

Cómo recuperar usuarios en una exportación de público

Para recuperar usuarios en una exportación de público, llama al método audienceExports.query y especifica el nombre de la exportación de público recuperado de los metadatos de configuración que proporcionan recurringAudienceLists.get o recurringAudienceLists.list.

Solicitud HTTP

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123:query

Si la exportación de público está lista, se muestra una respuesta que contiene la lista de usuarios de un público:

Respuesta HTTP

{
  "audienceExport": {
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  },
  "audienceRows": [
    {
      "dimensionValues": [
        {
          "value": "1000276123.1681742376"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000374452.1668627377"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000391956.1652750758"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000410539.1682018694"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000703969.1666725875"
        }
      ]
    }
  ],
  "rowCount": 5
}