Públicos-alvo no Google Analytics permitem que você segmente os usuários das maneiras mais relevantes para sua empresa. Com públicos-alvo, agrupe os usuários do seu site ou aplicativo com base atributos.
Você pode exportar seus públicos-alvo, incluindo um resumo dos usuários, usando o API Data.
Consulte as Expectativas de dados de exportação de público-alvo. para informações importantes sobre os dados exibidos nas exportações de públicos-alvo.
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.queryé usado para recuperar os usuários no público-alvo.
Para mais informações, ligue para
audienceExports.get para
recuperar metadados de configuração sobre uma exportação de público-alvo específica;
audienceExports.list para
Liste todas as exportações de públicos-alvo de uma propriedade específica.
Selecione uma entidade de relatórios
Todos os métodos da API Data exigem a propriedade do Google Analytics
identificador seja especificado em um caminho de solicitação de URL, na
forma de 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 no a propriedade especificada do Google Analytics.
Se você estiver usando uma das bibliotecas de cliente da API Data,
não é necessário alterar o caminho do URL da solicitação. A maioria dos clientes de API fornece um property
que espera uma string na forma de properties/GA_PROPERTY_ID. Consulte
Guia de início rápido com exemplos de uso da
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
AudienceExport
em sua solicitação. Os seguintes parâmetros são necessários:
- Um nome de público-alvo válido na
audiencecampo, formatado comoproperties/{propertyId}/audiences/{audienceId}. Você pode use o métodoaudiences.listda API Admin do Google Analytics v1 para receber esse valor. AAudience.nameda respostaaudiences.listcontém o nome do público-alvo. - Uma lista válida de dimensões no objeto
dimensions. A lista de dimensões suportadas por esse método pode ser encontrada no Documentação do esquema de exportação de públicos-alvo. Somente o os dados das dimensões mencionadas neste campo estão incluídos em um público-alvo exportar.
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 valor da
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
audienceExports.create
a chamada.
É possível verificar o estado de prontidão de uma exportação de público-alvo chamando
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 for concluída, o estado dela
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"
}
Para saber o estado de todas as exportações de público-alvo, chame 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
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, esta chamada retornará a lista de usuários na 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
}