イベントを送信するための手順 additional-steps-to-send-events

このページ:​ストリーミング取得 API にイベントをプッシュするデータシステムを設定して、設定したイベントが実際に Journey Optimizer に到達し、ジャーニーをトリガーするようにします。

イベントを​ ストリーミング取得 API ​に送信し、Journey Optimizer で使用するように設定するには、次の手順に従う必要があります。

  1. Adobe Experience Platform API からインレット URL を取得します。 詳しくは、ストリーミング取得 API の概要を参照してください。
  2. イベント​メニューのペイロードプレビューから、ペイロードをコピーします。 詳しくは、このページを参照してください。
IMPORTANT
イベントの要件と制限事項(ストリーミング、クエリサービス、バッチ取り込み)について詳しくは、ジャーニーガードレール - イベントを参照してください。

次に、コピーしたペイロードを使用してイベントをストリーミング取得 API にプッシュするデータシステムを設定する必要があります。

  1. ストリーミング取得 API URL(インレットと呼びます) に対する POST API 呼び出しを設定します。
  2. ストリーミング取得 API への API 呼び出しの本文(“data section”)で、Journey Optimizer からコピーしたペイロードを使用します。 以下に例を示します
  3. ペイロードに存在するすべての変数を取得する場所を決定します。 例:イベントがアドレスを伝えることになっている場合、貼り付けられたペイロードには “address”: “string” と表示されます。 “string” は、正しい値(メッセージを送信する相手のメール)を自動的に入力する変数に置き換える必要があります。 ペイロードプレビューの​ ヘッダー ​セクションでは、作業を容易にするために多くの値が自動的に入力されます。
  4. 本文タイプとして “application/json” を選択します。
  5. 「x-gw-ims-org-id」キーを使用して、ヘッダーに組織 ID を渡します。 値には、組織 ID(「XXX@AdobeOrg」)を使用します。

以下にストリーミング取得 API イベントの例を示します。

{
    "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"
                    }
                }
            }
        }
    }
}

「data」 部分をどこに貼り付けるかを特定しやすくするために、JSON フォーマッターなどの JSON ビジュアライゼーションツールを使用できます。

Streaming Ingestion API のトラブルシューティングについて詳しくは、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
  • 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.
recommendation-more-help
journey-optimizer-help