Crea una exportación de público

Los públicos en Google Analytics te permiten segmentar a los usuarios de formas significativas 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 Data.

Consulta la guía de expectativas de 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 Data para crear y consultar una exportación de público:

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

Para obtener más información, puedes llamar a audienceExports.get para recuperar los metadatos de configuración sobre una exportación de público específica y a audienceExports.list para enumerar todas las exportaciones de público de 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 de Google Analytics dentro de una ruta de acceso de URL, en el formato 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 Data, no necesitas cambiar la ruta de acceso de la URL de la solicitud. La mayoría de los clientes de la API proporcionan un parámetro property que espera una cadena con el formato properties/GA_PROPERTY_ID. Consulta la guía de inicio rápido para ver ejemplos de cómo usar 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 AudienceExport objeto en tu solicitud. Se requieren los siguientes parámetros:

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

Esta es una solicitud de ejemplo para crear una exportación de público:

Solicitud HTTP

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:

Respuesta HTTP

{
  "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 el name para consultar a los usuarios de la exportación de público.

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

Es posible que la exportación de público tarde varios minutos en generarse después de la audienceExports.create llamada.

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

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:

Solicitud HTTP

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

El estado de preparación de 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:

Respuesta HTTP

{
  "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 audienceExports.list método.

Recupera usuarios de una exportación de público

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

Esta es una solicitud de ejemplo:

Solicitud HTTP

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

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

Esta es una respuesta de ejemplo:

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
}