Criar uma exportação de público-alvo

Com os públicos-alvo no Google Analytics , você segmenta os usuários de um jeito que seja relevante para seus negócios. Com os públicos-alvo, é possível agrupar os usuários do seu site ou aplicativo com base em atributos compartilhados.

Você pode exportar seus públicos-alvo, incluindo um snapshot dos usuários, usando a API Data.

Consulte o guia de expectativas de dados de exportação de público-alvo para informações importantes sobre os dados que aparecem nas exportações de público-alvo.

Visão geral

Faça as seguintes solicitações da API Data para criar e consultar uma exportação de público-alvo:

  1. Chame o audienceExports.create método para criar uma exportação de público-alvo.
  2. O método audienceExports.query é usado para recuperar os usuários no público-alvo.

Para mais informações, chame audienceExports.get para recuperar metadados de configuração sobre uma exportação de público-alvo específica e audienceExports.list para listar todas as exportações de público-alvo de uma propriedade específica.

Selecionar uma entidade de relatórios

Todos os métodos da API Data exigem que o identificador da propriedade do Google Analytics seja especificado em um caminho de solicitação de URL, no formato properties/GA_PROPERTY_ID. Veja um exemplo:

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

O relatório é gerado com base nos dados de eventos do Google Analytics coletados na propriedade especificada do Google Analytics.

Se você estiver usando uma das bibliotecas de cliente da API Data, você não será necessário mudar o caminho do URL da solicitação. A maioria dos clientes da API fornece um parâmetro property que espera uma string no formato properties/GA_PROPERTY_ID. Consulte o guia de início rápido para exemplos de como usar as bibliotecas de cliente.

Criar uma exportação de público-alvo

Para criar uma exportação de público-alvo, chame o método audienceExports.create usando o objeto AudienceExport na solicitação. Os seguintes parâmetros são necessários:

  • Um nome de público-alvo válido no audience campo, formatado como properties/{propertyId}/audiences/{audienceId}. Você pode usar o audiences.list método da API Admin do Google Analytics v1 para receber esse valor. O campo Audience.name da resposta audiences.list contém o nome do público-alvo.
  • Uma lista válida de dimensões no dimensions campo. A lista de dimensões compatíveis com esse método pode ser encontrada na documentação do esquema de exportação de público-alvo. Somente os dados das dimensões mencionadas nesse campo são incluídos em uma exportação de público-alvo.

Confira um exemplo de solicitação para criar uma exportação de público-alvo:

Solicitação HTTP

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

Uma resposta do método audienceExports.create contém o nome da exportação de público-alvo no campo name, por exemplo, properties/1234567/audienceExports/123. Veja um exemplo de resposta:

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

Você pode usar o name para consultar os usuários da exportação de público-alvo.

Consultar o estado de preparação da exportação de público-alvo

Pode levar vários minutos para gerar a exportação de público-alvo após a audienceExports.create chamada.

Você pode verificar o estado de preparação de uma exportação de público-alvo chamando o audienceExports.get método.

Use o nome da exportação de público-alvo de uma resposta audienceExports.create para especificar a exportação de público-alvo na solicitação.

Confira um exemplo de solicitação:

Solicitação HTTP

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

O estado de preparação de uma exportação de público-alvo é retornado no state campo da resposta. Quando a geração da exportação de público-alvo é concluída, o estado muda de CREATING para ACTIVE.

Veja um exemplo de resposta:

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

Você pode receber o estado de todas as exportações de público-alvo chamando o audienceExports.list método.

Recuperar usuários de uma exportação de público-alvo

Depois que a exportação de público-alvo for gerada, chame o audienceExports.query método e especifique o nameda exportação de público-alvo na solicitação.

Confira um exemplo de solicitação:

Solicitação HTTP

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

Se a exportação de público-alvo estiver pronta, essa chamada vai retornar a lista de usuários no público-alvo.

Veja um exemplo de resposta:

Resposta 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
}