Visualizações e estimativas de endpoints
À medida que desenvolve uma definição de segmento, você pode usar as ferramentas de estimativa e visualização no Adobe Experience Platform para exibir informações de nível de resumo e ajudar a garantir que esteja isolando o público-alvo que espera.
-
As Visualizações fornecem listas paginadas de perfis qualificados para uma definição de segmento, permitindo que você compare os resultados com o que espera.
-
Estimativas fornecem informações estatísticas sobre uma definição de segmento, como o tamanho do público projetado, o intervalo de confiança e o desvio padrão de erro.
Introdução
Os pontos de extremidade usados neste guia fazem parte da API Adobe Experience Platform Segmentation Service. Antes de continuar, consulte o guia de introdução para obter informações importantes que você precisa saber para fazer chamadas com êxito para a API, incluindo os cabeçalhos necessários e como ler as chamadas de exemplo da API.
Como as estimativas são geradas
Quando a assimilação de registros no armazenamento de Perfil aumenta ou diminui a contagem total de perfis em mais de 5%, um trabalho de amostragem é acionado para atualizar a contagem. A maneira como a amostragem de dados é acionada depende do método de assimilação:
- Assimilação em lote: Para assimilação em lote, em 15 minutos após a assimilação bem-sucedida de um lote no repositório de perfis, se o limite de aumento ou diminuição de 5% for atingido, um trabalho será executado para atualizar a contagem.
- Assimilação de streaming: Para fluxos de trabalho de dados de streaming, uma verificação é feita a cada hora para determinar se o limite de aumento ou diminuição de 5% foi atingido. Se tiver sido, uma tarefa será automaticamente acionada para atualizar a contagem.
O tamanho da amostra da verificação depende do número geral de entidades no armazenamento de perfis. Esses tamanhos de amostra são representados na tabela a seguir:
Criar uma nova visualização create-preview
Você pode criar uma nova visualização fazendo uma solicitação POST para o ponto de extremidade /preview
.
Formato da API
POST /preview
Solicitação
curl -X POST https://platform.adobe.io/data/core/ups/preview \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '
{
"predicateExpression": "xEvent.metrics.commerce.abandons.value > 0",
"predicateType": "pql/text",
"predicateModel": "_xdm.context.profile",
"graphType": "none"
}'
predicateExpression
predicateType
predicateExpression
. Atualmente, o único valor aceito para esta propriedade é pql/text
.predicateModel
graphType
none
(não executa compilação de identidade) e pdg
(executa compilação de identidade com base em seu gráfico de identidade privado).Resposta
Uma resposta bem-sucedida retorna o status HTTP 201 (Criado) com detalhes da visualização recém-criada.
{
"state": "NEW",
"previewQueryId": "e890068b-f5ca-4a8f-a6b5-af87ff0caac3",
"previewQueryStatus": "NEW",
"previewId": "MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow",
"previewExecutionId": 0
}
state
previewId
Recuperar os resultados de uma visualização específica get-preview
Você pode recuperar informações detalhadas sobre uma visualização específica fazendo uma solicitação GET para o ponto de extremidade /preview
e fornecendo a ID de visualização no caminho da solicitação.
Formato da API
GET /preview/{PREVIEW_ID}
{PREVIEW_ID}
previewId
da visualização que você deseja recuperar.Solicitação
curl -X GET https://platform.adobe.io/data/core/ups/preview/MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com informações detalhadas sobre a visualização especificada.
{
"results": [{
"XID_ADOBE-MARKETING-CLOUD-ID-1": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1",
"endCustomerIds": {
"XID_COOKIE_ID_1": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_1"
},
"XID_PROFILE_ID_1": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_1"
}
}
}
},
{
"XID_COOKIE-ID-2": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE-ID-2",
"endCustomerIds": {
"XID_COOKIE_ID_2-1": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_2-1"
},
"XID_PROFILE_ID_2": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_2"
}
}
},
"XID_ADOBE-MARKETING-CLOUD-ID-3": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1000"
}
}],
"state": "RESULT_READY",
"links": {
"_self": "https://platform.adobe.io/data/core/ups/preview?expression=<expr-1>&limit=1000",
"next": "",
"prev": ""
},
"page": {
"offset": 0,
"size": 3
}
}
results
Recuperar os resultados de um trabalho de estimativa específico get-estimate
Depois de criar um trabalho de visualização, você pode usar seu previewId
no caminho de uma solicitação GET para o ponto de extremidade /estimate
para exibir informações estatísticas sobre a definição do segmento, incluindo tamanho do público projetado, intervalo de confiança e desvio padrão de erro.
Formato da API
GET /estimate/{PREVIEW_ID}
{PREVIEW_ID}
previewId
retornado quando o trabalho de visualização foi criado.Solicitação
A solicitação a seguir recupera os resultados de um trabalho de estimativa específico.
curl -X GET https://platform.adobe.io/data/core/ups/estimate/MDoyOjRhNDVlODUzLWFjOTEtNGJiNy1hNDI2LTE1MDkzN2I2YWY1Yzo0Mg \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com detalhes do trabalho estimado.
{
"estimatedSize": 4275,
"numRowsToRead": 4275,
"estimatedNamespaceDistribution": [
{
"namespaceId": "4",
"profilesMatchedSoFar": 35
},
{
"namespaceId": "6",
"profilesMatchedSoFar": 4275
}
],
"state": "RESULT_READY",
"profilesReadSoFar": 4275,
"standardError": 0,
"error": {
"description": "",
"traceback": ""
},
"profilesMatchedSoFar": 4275,
"totalRows": 4275,
"confidenceInterval": "95%",
"_links": {
"preview": "https://platform.adobe.io/data/core/ups/preview/app-32be0328-3f31-4b64-8d84-acd0c4fbdad3/execution/0?previewQueryId=e890068b-f5ca-4a8f-a6b5-af87ff0caac3"
}
}
estimatedNamespaceDistribution
state
_links.preview
state
é "RESULT_READY", este campo fornece uma URL para exibir a estimativa.Próximas etapas
Depois de ler este guia, você terá uma melhor compreensão de como trabalhar com visualizações e estimativas usando a API de segmentação. Para saber como acessar métricas relacionadas aos seus dados de Perfil do cliente em tempo real, como o número total de fragmentos de perfil e perfis mesclados em namespaces específicos ou o armazenamento de dados do perfil como um todo, visite o manual de ponto de extremidade de visualização de perfil (/previewsamplestatus
).