Este documento descreve listas de público-alvo recorrentes, que são uma recurso avançado da API Google Analytics Data v1. Para conhecer o recurso de exportação de listas de público-alvo, consulte o guia básico de exportação de público-alvo.
As listas de público-alvo recorrentes produzem listas de público-alvo diariamente, as associações de público-alvo mudam para garantir que você esteja trabalhando com os dados mais recentes.
As listas de público-alvo regular (não recorrentes) são listas estáticas de usuários no público-alvo. no momento em que a lista é gerada.
Criar uma nova lista de público-alvo diariamente
O tempo de processamento e atualização dos dados de público-alvo de um dia é variável assinatura. Não é possível confirmar se os dados da lista de público-alvo estão atualizados 24 horas.
Por exemplo, mesmo que você solicite uma lista de público-alvo no mesmo horário todos os dias, em alguns dias, a lista de público-alvo será a mesma do dia anterior e, em outros dias, a lista de público-alvo será diferente e conter um dia adicional de alterações de associação.
As listas de público-alvo têm como base os dados de evento do dia anterior ao dia mais recente mudanças na associação. Se você criar uma lista de público-alvo antes da associação diária as atualizações ocorrerem, ele usará dados dos dois dias anteriores. Se você criar lista de público-alvo após as atualizações diárias da associação, ele usará dados de ontem.
Pesquisar periodicamente uma lista de público-alvo recorrente
As listas de público-alvo recorrentes só produzem listas de público-alvo quando há quando os dados estão disponíveis. Isso elimina a imprevisibilidade na hora de decidir quando criar Listas de público-alvo. Em vez disso, você pode pesquisar de maneira barata a lista de público-alvo recorrente ao longo do dia para ver se há dados adicionais disponíveis.
Criar uma lista de público-alvo recorrente
Para criar uma lista de público-alvo recorrente, chame o método
recurringAudienceLists.create
usando o método
RecurringAudienceList
em uma solicitação. Os seguintes parâmetros são necessários:
- Um nome de público-alvo válido no
audiencecampo, formatado comoproperties/{propertyId}/audiences/{audienceId}. Você pode usar oaudiences.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
dimensions. A lista de dimensões suportadas por esse método pode ser encontrada no Documentação do Esquema de exportação de público-alvo. Somente os dados das dimensões mencionadas neste campo estão incluídos no uma lista de público-alvo.
Este é um exemplo de solicitação de criação de lista de público-alvo recorrente:
Solicitação HTTP
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/recurringAudienceLists
{
"audience": "properties/1234567/audiences/12345",
"dimensions": [
{
"dimensionName": "deviceId"
}
]
}
Uma resposta do método recurringAudienceLists.create contém as
no campo name (como
properties/1234567/recurringAudienceLists/123), que podem ser usadas em
consultas subsequentes para recuperar os metadados de configuração
para esta lista de público-alvo recorrente. Além disso, os metadados de configuração contêm
nomes de recursos para instâncias de listas de público-alvo
criado para esta lista de público-alvo recorrente.
Resposta HTTP
{
"name": "properties/1234567/recurringAudienceLists/123",
"audience": "properties/1234567/audiences/12345",
"audienceDisplayName": "Purchasers",
"dimensions": [
{
"dimensionName": "deviceId"
}
],
"activeDaysRemaining": 180,
"audienceLists": [
"properties/1234567/audienceLists/45678"
]
}
Pesquisar metadados de configuração
Use o
recurringAudienceLists.get
para recuperar metadados de configuração sobre um determinado
lista de público-alvo recorrente. Os metadados de configuração contêm
nomes de recursos para instâncias de listas de público-alvo
criado para esta lista de público-alvo recorrente.
Veja um exemplo:
Solicitação HTTP
GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/recurringAudienceLists/123
Uma instância de RecurringAudienceList
é retornado em resposta. Ele contém os metadados de configuração, que incluem
nomes de recursos para instâncias de listas de público-alvo
criado para esta lista de público-alvo recorrente.
Resposta HTTP
{
"name": "properties/1234567/recurringAudienceLists/123",
"audience": "properties/1234567/audiences/12345",
"audienceDisplayName": "Purchasers",
"dimensions": [
{
"dimensionName": "deviceId"
}
],
"activeDaysRemaining": 180,
"audienceLists": [
"properties/1234567/audienceLists/45678"
]
}
Você pode usar
recurringAudienceLists.list
para listar todas as listas de público-alvo recorrentes de uma propriedade.
Usar webhooks para receber notificações assíncronas sobre novas listas de público-alvo
Em vez de consultar periodicamente os metadados de configuração sobre um
lista de público-alvo recorrente
recurringAudienceLists.get
é possível receber notificações de webhook de forma assíncrona quando um público-alvo
lista fica disponível.
Para configurar notificações de webhook, especifique o
webhookNotification
ao criar uma nova lista de público-alvo recorrente.
Siga o guia do Async audience lists with webhooks
para mais informações sobre como usar webhooks na API Data v1 do Google Analytics.
Recuperar usuários em uma exportação de público-alvo
Para recuperar usuários em uma exportação de público-alvo, chame o método
audienceExports.query
e especifique o nome da exportação de público-alvo
recuperados dos metadados de configuração fornecidos pelo
recurringAudienceLists.get
ou recurringAudienceLists.list.
Solicitação HTTP
POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123:query
Se a exportação de público-alvo estiver pronta, uma resposta com a lista de usuários em um público-alvo é retornado:
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
}