Passaggi aggiuntivi per l’invio di eventi additional-steps-to-send-events

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:

  1. Ottieni l’URL di ingresso dalle API di Adobe Experience Platform. L’ingresso è l’URL della connessione in streaming che riceve gli eventi in Experience Platform. Ulteriori informazioni sono disponibili in Panoramica delle API Streaming Ingestion.
  2. Copia il payload dall’anteprima del payload nel menu Evento. Ulteriori informazioni sono disponibili in questa pagina.
IMPORTANT
Per i requisiti e le limitazioni degli eventi (streaming, Query Service, acquisizione batch), consulta Guardrail di Percorso - Eventi.

Quindi devi configurare il sistema di dati che invia gli eventi alle API Streaming Ingestion utilizzando il payload copiato:

  1. Imposta una chiamata API POST all’URL di ingresso ottenuto nella procedura precedente.
  2. Utilizza il payload copiato da Journey Optimizer nel corpo (“sezione dati”) della chiamata API alle API Streaming Ingestion. Vedi di seguito per un esempio
  3. Determina dove ottenere tutte le variabili presenti nel payload. Ad esempio, se l’evento deve trasmettere l’indirizzo e-mail della persona a cui inviare un messaggio, il payload incollato mostra "emailAddress": "string". Sostituisci "string" con la variabile che compila automaticamente il valore corretto, ad esempio l’indirizzo e-mail della persona. Nell’anteprima del payload, la sezione Intestazione è già stata riempita automaticamente con molti dei valori previsti. Intestazione significa l’oggetto header del payload (msgType, msgId, schemaRef e così via), non un’intestazione di richiesta HTTP.
  4. Seleziona “application/json” come tipo di corpo.
  5. 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.

AI Knowledge Reference

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
  • Determine where to get all the variables present in the payload
  • Configure the request body type and the organization ID header for the call

Glossary:

  • Streaming Ingestion APIs: The APIs to which the data system pushes events, using the payload copied from Journey Optimizer (product-specific)
  • Inlet: The URL of the streaming connection that receives your events in Experience Platform, to which the POST API call is sent (product-specific)
  • Header (payload preview): The header object of the payload (msgType, msgId, schemaRef and so on), not an HTTP request header (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, the Header section is already autofilled with many of the expected values; Header means the header object of the payload, not an HTTP request header.

Terminology:

  • Canonical name: Additional steps to send events
  • Synonyms: “inlet” = “URL of the streaming connection that receives events”
  • Do not confuse: the payload “header” object ≠ an HTTP request header (the organization ID goes in the HTTP header x-gw-ims-org-id)

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.

Personas:

  • developer: Can set up a POST API call to the Streaming Ingestion APIs inlet URL, using the payload copied from the Event menu payload preview. Can replace payload variables, such as the address field, with values like the recipient’s email. The page states that the organization ID is passed in the header using the key x-gw-ims-org-id. Where: “Additional steps to send events”.
  • admin: Can configure the data system that pushes events to the Streaming Ingestion APIs, using the payload copied from the Event menu payload preview. The page states that event requirements and limitations for streaming, Query Service, and batch ingestion appear in the Journey guardrails page. Where: “Guardrails”.

Onboarding:

  • Level: Intermediate, Experienced
  • First minimal step: Get the inlet URL from Adobe Experience Platform APIs.
  • Previous: Configure the event’s payload fields: Configure a unitary event (event/about-creating.md)
  • Next: Check event requirements and limitations for streaming, Query Service, and batch ingestion: Journey Optimizer guardrails and limitations (start/guardrails.md)
recommendation-more-help
journey-optimizer-help