Crea una exportación de público

Los públicos de Google Analytics te permiten segmentar a tus usuarios de formas importantes para tu empresa. Con los públicos, puedes agrupar a los usuarios de tu sitio o aplicación en función de atributos compartidos.

Puedes exportar tus públicos, incluida una instantánea de sus usuarios, con la API de datos.

Consulta la guía Expectativas de los datos de exportación de públicos para obtener información importante sobre los datos que ves en las exportaciones de públicos.

Descripción general

Realiza las siguientes solicitudes a la API de datos para crear y consultar una exportación de público:

1. Llama al método audienceExports.create para crear una exportación de público.
2. Se llama al método audienceExports.query para recuperar los usuarios del público.

Para obtener más información, puedes llamar a audienceExports.get para recuperar metadatos de configuración sobre una exportación de público específica y a audienceExports.list para enumerar todas tus exportaciones de público para una propiedad específica.

Selecciona una entidad de informes

Todos los métodos de la API de datos requieren que se especifique el identificador de la propiedad Google Analytics dentro de una ruta de solicitud de URL, en forma de properties/GA_PROPERTY_ID. Por ejemplo:

  POST  https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/audienceExports

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 que cambies la ruta de la URL de la solicitud. 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 del uso de las bibliotecas cliente.

Crea una exportación de público

Para crear una exportación de público, llama al método audienceExports.create con el objeto AudienceExport en tu 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.
• 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. En una exportación de público, solo se incluyen los datos de las dimensiones mencionadas en este campo.

A continuación, se muestra una solicitud de ejemplo para crear una exportación de público:

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

Una respuesta del método audienceExports.create contiene el nombre de la exportación de público en el campo name, por ejemplo, properties/1234567/audienceExports/123. Esta es una respuesta de ejemplo:

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceExport",
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "CREATING",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  }
}

Puedes usar name para consultar a los usuarios de la exportación del público.

Consulta el estado de preparación de la exportación de públicos

La exportación de público puede tardar varios minutos en generarse después de la llamada a audienceExports.create.

Para verificar el estado de preparación de una exportación de público, llama al método audienceExports.get.

Usa el nombre de la exportación de público de una respuesta audienceExports.create para especificar la exportación de público en tu solicitud.

Esta es una solicitud de ejemplo:

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

El estado de preparación para una exportación de público se muestra en el campo state de la respuesta. Una vez que se completa la generación de la exportación de público, su estado cambia de CREATING a ACTIVE.

Esta es una respuesta de ejemplo:

{
  "name": "properties/1234567/audienceExports/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "state": "CREATING",
  "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
}

Para obtener el estado de todas las exportaciones de público, llama al método audienceExports.list.

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

Una vez que se genere la exportación de público, llama al método audienceExports.query y especifica el name de la exportación de público en la solicitud.

Esta es una solicitud de ejemplo:

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

Si la exportación del público está lista, esta llamada muestra la lista de usuarios del público.

Esta es una respuesta de ejemplo:

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