メッセージ変換テンプレートの作成とテスト

概要

宛先 SDK の一部として、Adobeには、宛先の設定とテストを支援する開発者ツールが用意されています。 このページでは、メッセージ変換テンプレートの作成およびテスト方法について説明します。 宛先のテスト方法について詳しくは、 宛先設定のテスト を参照してください。

Adobe Experience Platformのターゲットスキーマと、宛先でサポートされるメッセージ形式との間にメッセージ変換テンプレート を作成してテストするには、後述の テンプレートオーサリングツール を使用します。 ソースとターゲットのスキーマ間でのデータ変換について詳しくは、 メッセージ形式のドキュメント を参照してください。

次の図に、宛先 SDK の 宛先設定ワークフロー に適合するメッセージ変換テンプレートの作成とテスト方法を示します。

メッセージ変換テンプレートの作成とテストが必要な理由

宛先 SDK での宛先を作成する最初の手順の 1 つは、セグメントのメンバーシップ、ID、プロファイル属性のデータ形式が、Adobe Experience Platformから宛先に書き出される際にどのように変換されるかを考えることです。 AdobeXDM スキーマと宛先スキーマの変換に関する情報を、 メッセージ形式のドキュメント で確認します。

変換を正常に実行するには、次の例のような変換テンプレートを指定する必要があります。 セグメント、ID およびプロファイル属性を送信するテンプレートを作成します 。

Adobeは、AdobeXDM 形式のデータを、宛先でサポートされる形式に変換するメッセージテンプレートを作成およびテストできるテンプレートツールを提供します。 このツールには、次の 2 つの API エンドポイントを使用できます。

• サンプルテンプレート API を使用して、サンプルテンプレートを取得します。
• レンダリングテンプレート API を使用してサンプルテンプレートをレンダリングし、結果と宛先の予想されるデータ形式を比較できます。 書き出されたデータを、宛先で予想されるデータ形式と比較した後、テンプレートを編集できます。 これにより、書き出されたデータは、宛先で予想されるデータ形式と一致します。

サンプルテンプレート API とレンダリングテンプレート API を使用して、宛先のテンプレートを作成する方法

テンプレートを取得してテストするプロセスは反復的です。 書き出されたプロファイルが宛先の期待されるデータ形式と一致するまで、以下の手順を繰り返します。

1. まず、 サンプルテンプレート を取得します。
2. サンプルテンプレートを基に、独自のドラフトを作成します。
3. 独自のテンプレートで レンダリングテンプレート API エンドポイント を呼び出します。 Adobeは、スキーマに基づいてサンプルプロファイルを生成し、結果または発生したエラーを返します。
4. 書き出されたデータと、宛先で予想されるデータ形式を比較します。 必要に応じて、テンプレートを編集します。
5. 書き出されたプロファイルが宛先の期待されるデータ形式と一致するまで、このプロセスを繰り返します。

テンプレートを作成する前に完了する手順

テンプレートを作成する準備が整う前に、次の手順を実行してください。

1. 宛先サーバー設定の作成を参照してください。生成するテンプレートは、maxUsersPerRequest パラメーターに指定した値に基づいて異なります。
   • 宛先への API 呼び出しに単一のプロファイルと、そのセグメント認定、ID、プロファイル属性を含める場合は、 maxUsersPerRequest=1 を使用します。
   • 宛先への API 呼び出しに複数のプロファイルと、そのセグメント認定、ID、プロファイル属性を含める場合は、 maxUsersPerRequest を 1 より大きい値で使用します。
2. 宛先設定を作 成し、で宛先サーバー設定の ID を追加しま destinationDelivery.destinationServerIdす。
3. 作成した宛先設定の ID を取得し、テンプレート作成ツールで使用できるようにします。

サンプルテンプレート API を使用したサンプルテンプレートの取得

以下に示すように、呼び出しに宛先 ID を追加すると、応答は宛先 ID に対応するテンプレートの例を返します。

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/testing/template/sample/5114d758-ce71-43ba-b53e-e2a91d67b67f' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

指定した宛先 ID が、集計ポリシーの ベストエフォートの集計 と maxUsersPerRequest=1 を使用した宛先設定に対応している場合、リクエストは次のようなサンプルテンプレートを返します。

{#- THIS is an example template for a single profile -#}
{#- A '-' at the beginning or end of a tag removes all whitespace on that side of the tag. -#}
{
    "identities": [
    {%- for idMapEntry in input.profile.identityMap -%}
    {%- set namespace = idMapEntry.key -%}
        {%- for identity in idMapEntry.value %}
        {
            "type": "{{ namespace }}",
            "id": "{{ identity.id }}"
        }{%- if not loop.last -%},{%- endif -%}
        {%- endfor -%}{%- if not loop.last -%},{%- endif -%}
    {% endfor %}
    ],
    "AdobeExperiencePlatformSegments": {
        "add": [
        {%- for segment in input.profile.segmentMembership.ups | added %}
            "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
        {% endfor %}
        ],
        "remove": [
        {#- Alternative syntax for filtering segments by status: -#}
        {% for segment in removedSegments(input.profile.segmentMembership.ups) %}
            "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
        {% endfor %}
        ]
    }
}

指定した宛先 ID が、 構成可能な集計 または ベストエフォート集計 が 1 より大きい宛先サーバーテンプレートに対応する場合、リクエストは次のようなサンプルテンプレートを返します。maxUsersPerRequest

{#- THIS is an example template for multiple profiles -#}
{#- A '-' at the beginning or end of a tag removes all whitespace on that side of the tag. -#}
{
    "profiles": [
    {%- for profile in input.profiles %}
        {
            "identities": [
            {%- for idMapEntry in profile.identityMap -%}
            {%- set namespace = idMapEntry.key -%}
                {%- for identity in idMapEntry.value %}
                {
                    "type": "{{ namespace }}",
                    "id": "{{ identity.id }}"
                }{%- if not loop.last -%},{%- endif -%}
                {%- endfor -%}{%- if not loop.last -%},{%- endif -%}
            {% endfor %}
            ],
            "AdobeExperiencePlatformSegments": {
                "add": [
                {%- for segment in profile.segmentMembership.ups | added %}
                    "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
                {% endfor %}
                ],
                "remove": [
                {#- Alternative syntax for filtering segments by status: -#}
                {% for segment in removedSegments(profile.segmentMembership.ups) %}
                    "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
                {% endfor %}
                ]
            }
        }{%- if not loop.last -%},{%- endif -%}
    {% endfor %}
    ]
}

テンプレートの文字エスケープ

テンプレートを使用して宛先の想定される形式に一致するプロファイルをレンダリングする前に、テンプレートを文字エスケープする必要があります（下の画面の記録を参照）。

オンラインの文字エスケープツールを使用できます。 上記のデモでは、JSON エスケープフォーマッター を使用しています。

レンダリングテンプレート API

サンプルテンプレート API を使用してメッセージ変換テンプレートを作成したら、 テンプレートをレンダリングして 、テンプレートに基づいて書き出されたデータを生成できます。 これにより、Adobe Experience Platformが宛先に書き出すプロファイルが、目的の宛先の形式と一致するかどうかを確認できます。

実行できる呼び出しの例については、 API リファレンスを参照してください。

• 本文でプロファイルを送信しないテンプレートのレンダリング
• 本文で送信したプロファイルを使用したテンプレートのレンダリング

テンプレートを編集し、書き出されたプロファイルが宛先の予想されるデータ形式と一致するまで、レンダーテンプレート API エンドポイントを呼び出します。

文字エスケープテンプレートを宛先サーバーの設定に追加する

メッセージ変換テンプレートの設定が完了したら、 httpTemplate.requestBody.value の 宛先サーバー設定 に追加します。