Sur cette page : configurez votre système de données pour envoyer les événements vers les API Streaming Ingestion afin que les événements que vous avez configurés atteignent Journey Optimizer et déclenchent vos parcours.
Pour configurer les événements qui doivent être envoyés aux API d’ingestion en flux continu et utilisés dans Journey Optimizer, procédez comme suit :
- Récupérez l’URL d’inlet à partir des API Adobe Experience Platform. En savoir plus sur Présentation des API d’ingestion en flux continu.
- Copiez la payload depuis son aperçu dans le menu Événement. En savoir plus sur cette page.
Vous devez ensuite configurer le système de données qui envoie les événements vers les API d’ingestion en flux continu à l’aide de la payload que vous avez copiée :
- Configurez un appel d’API POST à l’URL des API d’ingestion en flux continu (désignée sous le nom « inlet »).
- Utilisez la payload que vous avez copiée depuis Journey Optimizer, dans le corps (« section de données ») de l’appel d’API, vers les API d’ingestion en flux continu. Reportez-vous à l’exemple ci-dessous.
- Déterminez où obtenir toutes les variables présentes dans la payload. Exemple : si l’événement est censé transmettre l’adresse, la payload collée indique “address”: “string”. “string” doit être remplacé par la variable qui renseigne automatiquement la valeur appropriée, c’est-à-dire l’adresse e-mail du destinataire du message. Notez que dans la section En-tête de l’aperçu de la payload, de nombreuses valeurs sont renseignées automatiquement afin de vous faciliter la tâche.
- Sélectionnez “application/json” comme type de corps.
- Transmettez votre identifiant d’organisation dans l’en-tête à l’aide de la clé « x-gw-ims-org-id ». Pour cette valeur, utilisez votre identifiant d’organisation (« XXX@AdobeOrg »).
Voici un exemple d’événement d’API d’ingestion en flux continu :
{
"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"
}
}
}
}
}
}
Pour identifier plus facilement l’endroit où coller la partie « données », vous pouvez utiliser un outil de visualisation JSON tel que le formateur JSON.
Pour résoudre les problèmes liés aux API d’ingestion en streaming, consultez la documentation 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.