Entregar ofertas usando a API Batch Decisioning
- Tópicos:
- Gestão de decisões
- API
Criado para:
- Experiente
- Desenvolvedor
A API Batch Decisioning permite que as organizações usem a funcionalidade de decisão para todos os perfis em um determinado público-alvo através de uma única chamada. O conteúdo da oferta de cada perfil no público-alvo é colocado em um conjunto de dados do Adobe Experience Platform, onde ele estará disponível para fluxos de trabalho em lote personalizados.
Com a API Batch Decisioning, você pode preencher um conjunto de dados com as melhores ofertas para todos os perfis em um público-alvo da Adobe Experience Platform para escopos de decisão. Por exemplo, uma organização pode querer executar Batch Decisioning para enviar ofertas a um fornecedor de entrega de mensagens. Essas ofertas são usadas como conteúdo enviado para entrega de mensagens em lote para o mesmo público-alvo de usuários.
Para fazer isso, a organização deve:
-
Execute a API Batch Decisioning, que contém duas solicitações:
-
Uma Solicitação POST de lote para iniciar uma carga de trabalho para processar em lote as seleções de ofertas.
-
Uma Solicitação de GET em lote para obter o status da carga de trabalho em lote.
-
-
Exportar o conjunto de dados para a API do fornecedor de delivery de mensagens.
- O número de trabalhos em lotes em execução por conjunto de dados: até cinco trabalhos em lotes podem ser executados de cada vez, por conjunto de dados. Quaisquer outras solicitações em lote com o mesmo conjunto de dados de saída são adicionadas à fila. Uma tarefa em fila será processada assim que a tarefa anterior terminar de ser executada.
- Limite de frequência: um lote é executado fora do instantâneo de perfil que ocorre uma vez por dia. A API Batch Decisioning limita a frequência e sempre carrega perfis do instantâneo mais recente.
Introdução
Antes de usar essa API, verifique se você concluiu as seguintes etapas de pré-requisitos.
Preparar a decisão
Para preparar uma ou mais decisões, verifique se você criou um conjunto de dados, um público-alvo e uma decisão. Esses pré-requisitos estão detalhados em esta seção.
Requisitos da API
Todas as solicitações Batch Decisioning exigem os seguintes cabeçalhos, além dos mencionados no Guia do desenvolvedor da API de Gestão de Decisões:
Content-Type
:application/json
x-request-id
: uma cadeia de caracteres exclusiva que identifica a solicitação.x-sandbox-name
: O nome da sandbox.
Iniciar um processo em lote
Para iniciar uma carga de trabalho para tomar decisões de processo em lote, faça uma solicitação POST para o ponto de extremidade /workloads/decisions
.
Formato da API
POST {ENDPOINT_PATH}/workloads/decisions
{ENDPOINT_PATH}
https://platform.adobe.io/data/core/dwm
Solicitação
curl -X POST 'https://platform.adobe.io/data/core/dwm/workloads/decisions' \
-H 'x-request-id: f671a589-eb7b-432f-b6b9-23d5b796b4dc' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-sandbox-id: {SANDBOX_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-d '{
"xdm:segmentIds": [
"609028e4-e66c-4776-b0d9-c782887e2273"
],
"xdm:dataSetId": "6196b4a1a63bd118dafe093c",
"xdm:propositionRequests": [
{
"xdm:activityId": "xcore:offer-activity:1410cdcda196707b",
"xdm:placementId": "xcore:offer-placement:1410c4117306488a",
"xdm:itemCount": 1
}
],
"xdm:includeContent": false
}'
xdm:activityId
xdm:dataSetId
6196b4a1a63bd118dafe093c
xdm:enrichedAudience
true
xdm:includeContent
false
por padrão. Se true
, o conteúdo da oferta será incluído nos eventos de decisão do conjunto de dados.false
xdm:itemCount
1
xdm:placementId
xcore:offer-placement:1410c4117306488a
xdm:propositionRequests
placementId
e activityId
xdm:segmentIds
609028e4-e66c-4776-b0d9-c782887e2273
Consulte a documentação do Gerenciamento de decisões para obter uma visão geral dos principais conceitos e propriedades.
Resposta
{
"@id": "47efef25-4bcf-404f-96e2-67c4f784a1f5",
"xdm:imsOrgId": "9GTO98D5F@AdobeOrg",
"ode:createDate": 1648078924834,
"ode:status": "QUEUED"
}
@id
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
9GTO98D5F@AdobeOrg
ode:createDate
1648078924834
ode:status
ode:status: "QUEUED"
Recuperar informações sobre uma decisão em lote
Para recuperar informações sobre uma decisão específica, faça uma solicitação GET para o ponto de extremidade /workloads/decisions
enquanto fornece o valor da ID da carga de trabalho correspondente para a sua decisão.
Formato da API
GET {ENDPOINT_PATH}/workloads/decisions/{WORKLOAD_ID}
{ENDPOINT_PATH}
https://platform.adobe.io/data/core/dwm
{WORKLOAD_ID}
47efef25-4bcf-404f-96e2-67c4f784a1f5
Solicitação
curl -X GET 'https://platform.adobe.io/data/core/dwm/workloads/decisions/f395ab1f-dfaf-48d4-84c9-199ad6354591' \
-H 'x-request-id: 7832a42a-d4e5-413b-98e8-e49bef056436' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H'x-sandbox-id: {SANDBOX_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}'
Resposta
{
"@id": "f395ab1f-dfaf-48d4-84c9-199ad6354591",
"xdm:imsOrgId": "{IMS_ORG}",
"ode:createDate": 1648076994405,
"ode:status": "COMPLETED"
}
@id
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
9GTO98D5F@AdobeOrg
ode:createDate
1648076994405
ode:status
ode:status: "COMPLETED"
ode:statusDetail
Próximas etapas
Ao seguir este guia de API, você verificou o status da carga de trabalho e entregou ofertas usando a API Batch Decisioning. Para obter mais informações, consulte a visão geral sobre a Gestão de Decisões.