Com os públicos-alvo no Google Analytics 4, você pode segmentar os usuários das maneiras mais relevantes para sua empresa. Com os públicos-alvo, você pode agrupar usuários do seu site ou aplicativo com base em atributos compartilhados.
É possível exportar seus públicos-alvo, incluindo um resumo dos usuários, usando a API Data.
Consulte o guia Expectativas de dados de exportação de público-alvo para informações importantes sobre os dados que você vê nas exportações.
Visão geral
Faça as seguintes solicitações da API Data para criar e consultar uma exportação de público-alvo:
- Chame o método
audienceExports.createpara criar uma exportação de público-alvo. - Chame o método
audienceExports.querypara 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.
Selecione uma entidade de relatórios
Todos os métodos da API Data exigem que o identificador de propriedade do Google Analytics 4 seja especificado dentro de um caminho de solicitação de URL, no formato properties/GA4_PROPERTY_ID. Veja um exemplo:
POST https://analyticsdata.googleapis.com/v1beta/properties/GA4_PROPERTY_ID/audienceExports
O relatório é gerado com base nos dados de eventos do Google Analytics coletados na propriedade especificada do GA4.
Se você estiver usando uma das bibliotecas de cliente da API Data, não será necessário alterar o caminho do URL da solicitação.
A maioria dos clientes de API fornece um parâmetro property que espera uma string na forma de properties/GA4_PROPERTY_ID.
Consulte o Guia de início rápido para ver 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 campo
audience, formatado comoproperties/{propertyId}/audiences/{audienceId}. Você pode usar o métodoaudiences.listda API Admin v1 do Google Analytics para receber esse valor. O campoAudience.nameda respostaaudiences.listcontém o nome do público-alvo. - Uma lista válida de dimensões no
campo
dimensions. 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 neste campo são incluídos em uma exportação de público-alvo.
Este é 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"
}
}
É possível usar name para consultar os usuários da exportação de público-alvo.
Consultar o estado de prontidã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 chamada
audienceExports.create.
É possível verificar o estado de prontidão de uma exportação de público-alvo chamando o
método
audienceExports.get.
Use o nome da exportação de público-alvo de uma resposta audienceExports.create para
especificar a exportação de público-alvo em sua solicitação.
Este é um exemplo de solicitação:
Solicitação HTTP
GET https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123
O estado de prontidão de uma exportação de público-alvo é retornado no campo
state
da resposta. Quando a geração da exportação do 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"
}
É possível conferir o estado de todas as exportações de público-alvo chamando o
método
audienceExports.list.
Recuperar usuários de uma exportação de público-alvo
Depois que a exportação de público-alvo for gerada, chame o método
audienceExports.query
e especifique o name da exportação de público-alvo na solicitação.
Este é 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
}