Crea una exportación de público

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

Para exportar tus públicos, incluida una instantánea de sus usuarios, puedes usar la API de datos.

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

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. La llamada al método audienceExports.query se usa para recuperar los usuarios del público.

Si deseas 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úblicos de una propiedad específica.

Seleccionar una entidad denunciante

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

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

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

Si usas una de las bibliotecas cliente de la API de datos, no necesitas cambiar la ruta de 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/GA4_PROPERTY_ID. Consulta la Guía de inicio rápido para obtener ejemplos del uso de las bibliotecas cliente.

Crea una exportación de público

Para crear una exportación de públicos, 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 versión 1 de la API de Google Analytics Admin 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 La lista de dimensiones compatibles con este método se puede encontrar en la documentación 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 incluye una solicitud de ejemplo para crear una exportación de públicos:

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 name para consultar a los usuarios en la exportación de públicos.

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

Es posible que la exportación de públicos tarde varios minutos 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 exportación de público de una respuesta audienceExports.create para especificar la exportación de público en tu solicitud.

A continuación, se incluye una solicitud de ejemplo:

Solicitud HTTP

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úblicos, 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"
}

Puedes obtener el estado de todas las exportaciones de públicos llamando al método audienceExports.list.

Recupera usuarios de una exportación de público

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

A continuación, se incluye una solicitud de ejemplo:

Solicitud HTTP

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 en el 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
}