In questa pagina: Configura il sistema di dati per inviare eventi alle API Streaming Ingestion in modo che gli eventi configurati raggiungano effettivamente Journey Optimizer e attivino i tuoi percorsi.
Per configurare gli eventi da inviare alle API Streaming Ingestion e da utilizzare in Journey Optimizer, è necessario eseguire la procedura seguente:
- Ottieni l’URL di ingresso dalle API di Adobe Experience Platform. Ulteriori informazioni sono disponibili in Panoramica delle API Streaming Ingestion.
- Copia il payload dall’anteprima del payload nel menu Evento. Ulteriori informazioni sono disponibili in questa pagina.
Quindi devi configurare il sistema di dati che invia gli eventi alle API Streaming Ingestion utilizzando il payload copiato:
- Imposta una chiamata API POST all’URL delle API Streaming Ingestion (chiamata entrata).
- Utilizza il payload copiato da Journey Optimizer nel corpo (“sezione dati”) della chiamata API alle API Streaming Ingestion. Vedi di seguito per un esempio
- Determina dove ottenere tutte le variabili presenti nel payload. Esempio: se l’evento deve trasmettere l’indirizzo, il payload incollato mostrerà “address”: “string”. “string” deve essere sostituito dalla variabile che compilerà automaticamente il valore corretto, l’e-mail della persona a cui inviare un messaggio. Tieni presente che nell’anteprima del payload, nella sezione Intestazione, vengono compilati automaticamente molti valori che dovrebbero facilitare il tuo lavoro.
- Seleziona “application/json” come tipo di corpo.
- Passa l’ID organizzazione nell’intestazione utilizzando la chiave “x-gw-ims-org-id”. Per il valore, utilizza l’ID organizzazione (“XXX@AdobeOrg”).
Ecco un esempio di evento Streaming Ingestion APIs:
{
"header": {
"msgType": "xdmEntityCreate",
"msgId": "c25585b9-252e-431d-b562-e73da70c04e7",
"msgVersion": "1.0",
"xactionId": "f5995abe-c49d-4848-9577-a7a4fc2996fb",
"datasetId": "string - required if you want the data to land in a specific dataset - not mandatory",
"imsOrgId": "XXX@AdobeOrg",
"schemaRef": {
"id": "XXX",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
},
"source": {
"name": "Journeys"
}
},
"body": {
"xdmMeta": {
"schemaRef": {
"id": "XXX",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"xdmEntity": {
"_instance_name": {
"person": {
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthYear": 10,
"emailAddress": "string"
}
},
"identityMap": {
"Email": [
{
"id": "string"
}
]
},
"_id": "string",
"timestamp": "2023-05-29T00:00:00.000Z",
"_experience": {
"campaign": {
"orchestration": {
"eventID": "XXX"
}
}
}
}
}
}
Per facilitare l’identificazione della posizione in cui incollare la parte “data”, puoi utilizzare uno strumento di visualizzazione JSON come JSON formatter.
Per risolvere i problemi relativi alle API Streaming Ingestion, consulta la documentazione di Experience Platform.
This section contains structured knowledge intended to support interpretation, retrieval, and question answering related to this topic.
For complete understanding, this information should be combined with the documentation on this page. Neither source is intended to stand alone; the page describes the feature, while this section provides additional context that helps disambiguate terminology, intent, applicability, and constraints.
- TL;DR: This page explains the additional steps to set up a data system that pushes events to the Streaming Ingestion APIs, using the payload copied from the payload preview, so configured events actually reach Journey Optimizer and trigger journeys.
Intents:
- Get the inlet URL from Adobe Experience Platform APIs
- Copy the payload from the payload preview in the Event menu
- Set up a POST API call to the Streaming Ingestion APIs inlet using the copied payload
- Map the payload variables to the values that should populate them
- Configure the request body type and the organization ID header for the call
Glossary:
- Streaming Ingestion APIs: The Adobe Experience Platform APIs to which events must be pushed so they reach Journey Optimizer (product-specific)
- Inlet: The Streaming Ingestion APIs URL to which the POST API call is sent (product-specific)
- Payload preview: The view in the Event menu from which you copy the payload to use in the body of the API call (product-specific)
- x-gw-ims-org-id: The header key used to pass your organization ID in the API call (product-specific)
Guardrails:
- Set up a POST API call to the Streaming Ingestion APIs URL (the inlet) and place the copied payload in the body, the data section, of the call.
- Select application/json as the body type.
- Pass the organization ID in the header using the key x-gw-ims-org-id, with the organization ID value in the form XXX@AdobeOrg.
- In the payload preview Header section, many expected values are autofilled to facilitate the work.
Terminology:
- Canonical name: Streaming Ingestion APIs — Acronym: n/a — variants: inlet, inlet URL
- Synonyms: “inlet” = “Streaming Ingestion APIs URL”
- Do not confuse: “header” (section carrying values such as x-gw-ims-org-id) ≠ “body” (the data section carrying the payload)
FAQ:
- Q: Where do I get the payload to send? — Copy it from the payload preview in the Event menu.
- Q: What body type should the API call use? — application/json.
- Q: How do I pass the organization ID? — In the header, using the key x-gw-ims-org-id with the value in the form XXX@AdobeOrg.
- Q: What kind of API call is used to send events? — A POST API call to the Streaming Ingestion APIs URL, called an inlet.