サンプルテンプレート API 操作の取得

重要

API エンドポイント: https://platform.adobe.io/data/core/activation/authoring/testing/template/sample

このページでは、/authoring/testing/template/sample API エンドポイントを使用して、宛先の メッセージ変換テンプレート を生成するために実行できるすべての API 操作について説明します。 このエンドポイントでサポートされる機能の説明については、 テンプレートの作成 を参照してください。

サンプルテンプレート API 操作の概要

続行する前に、 はじめに を参照して、必要な宛先オーサリング権限や必要なヘッダーの取得方法など、API を正しく呼び出すために知っておく必要がある重要な情報を確認してください。

サンプルテンプレートの取得

サンプルテンプレートを取得するには、authoring/testing/template/sample/ エンドポイントにGETリクエストを送信し、テンプレートを作成する場所に基づいて宛先設定の宛先 ID を指定します。

ヒント
  • ここで使用する宛先 ID は、/destinations エンドポイントを使用して作成された、宛先設定に対応する instanceId です。 宛先設定 API リファレンス を参照してください。

API 形式

GET authoring/testing/template/sample/{DESTINATION_ID}
パラメーター 説明
{DESTINATION_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}' \

応答

正常な応答は、HTTP ステータス 200 と、期待されるデータ形式に合わせて編集できるサンプルテンプレートを返します。

指定した宛先 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 %}
    ]
}

API エラー処理

宛先 SDK API エンドポイントは、一般的なExperience PlatformAPI エラーメッセージの原則に従います。 Platform トラブルシューティングガイドの API ステータスコード および リクエストヘッダーのエラー を参照してください。

次の手順

このドキュメントを読むと、 /authoring/testing/template/sample API エンドポイントを使用してメッセージ変換テンプレートを生成する方法がわかります。 次に、 レンダリングテンプレート API エンドポイント を使用して、テンプレートに基づいて書き出されたプロファイルを生成し、宛先で予想されるデータ形式と比較します。

このページ