ドキュメントExperience Platform宛先ガイド

ソーススキーマに基づくサンプルプロファイルの生成 sample-profile-api-operations

Last update: Wed Nov 01 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • 管理者
  • ユーザー
IMPORTANT
API エンドポイント：https://platform.adobe.io/data/core/activation/authoring/sample-profiles

このページでは、/authoring/sample-profiles API エンドポイントを使用して実行できるすべての API の操作について説明します。

異なる API 用の異なるプロファイルタイプの生成 different-profiles-different-apis

IMPORTANT
この API エンドポイントを使用して、2 つの個別のユースケース用にサンプルプロファイルを生成します。以下のいずれかを実行できます。

Adobe XDM ソーススキーマ（宛先をテストする際に使用）または宛先でサポートされているターゲットスキーマ（テンプレートを作成する際に使用）のどちらかに基づいて、サンプルプロファイルを生成できます。Adobe XDM ソーススキーマとターゲットスキーマの違いを理解するには、メッセージ形式記事の概要の節を参照してください。

サンプルプロファイルを使用可能な目的は、入れ替えられないことに注意してください。宛先 ID に基づいて生成されたプロファイルは、メッセージ変換テンプレートを作成するためにのみ使用でき、宛先インスタンス ID に基づいて生成されたプロファイルは、宛先エンドポイントをテストするためにのみ使用できます。

サンプルプロファイル生成 API 操作の概要 get-started

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

宛先をテストする際に使用する、ソーススキーマに基づいたサンプルプロファイルの生成 generate-sample-profiles-source-schema

IMPORTANT
宛先をテストする際に、ここで生成したサンプルプロファイルを HTTP 呼び出しに追加します。

authoring/sample-profiles/ エンドポイントに対して GET リクエストを行い、テストしたい宛先設定に基づいて作成した宛先インスタンスの ID を指定することで、ソーススキーマに基づいてサンプルプロファイルを生成できます。

宛先インスタンスの ID を取得するために、最初に Experience Platform UI で宛先への接続を作成してから、宛先をテストしてみる必要があります。宛先のアクティブ化チュートリアルおよびこの API に使用する宛先インスタンス ID の取得方法に関する以下のヒントを参照してください。

IMPORTANT

API 形式

GET authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={COUNT}
クエリパラメーター
説明
{DESTINATION_INSTANCE_ID}
サンプルプロファイルの生成元となる宛先インスタンスの ID。
{COUNT}
オプション。生成しているサンプルプロファイルの数。このパラメーターは、1 - 1000 の値を取ることができます。
count パラメーターが指定されていない場合、生成されたプロファイルのデフォルトの数は、宛先サーバー設定の maxUsersPerRequest 値によって決まります。このプロパティが定義されていない場合は、アドビが 1 つのサンプルプロファイルを生成します。

リクエスト

以下のリクエストは、{DESTINATION_INSTANCE_ID} および {COUNT} クエリパラメーターで設定された、サンプルプロファイルを生成します。

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--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: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

応答

応答が成功すると、HTTP ステータス 200 が、指定された数のサンプルプロファイル（ソース XDM スキーマに対応するオーディエンスメンバーシップ、ID およびプロファイル属性を含む）と共に返されます。

TIP
応答は、宛先インスタンスで使用されたオーディエンスメンバーシップ、ID およびプロファイル属性のみを返します。ソーススキーマに他のフィールドがあっても、それらは無視されます。
[
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-7VEsJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Y55JJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Nd9GK"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    }
]
プロパティ
説明
segmentMembership
個人のオーディエンスメンバーシップを記述するマップオブジェクト。segmentMembership について詳しくは、オーディエンスメンバーシップの詳細を参照してください。
lastQualificationTime
前回、このプロファイルがセグメントに選定された際のタイムスタンプ。
xdm:status

オーディエンスメンバーシップが現在のリクエストの一環として実現されたかどうかを示す文字列フィールド。以下の値を使用できます。

  • realized：プロファイルは、セグメントの一部です。
  • exited：プロファイルは、現在のリクエストの一環としてオーディエンスから外れています。
identityMap
個人の様々な ID 値を、関連する名前空間と共に記述するマップタイプフィールド。identityMap について詳しくは、スキーマ構成の基本を参照してください。

メッセージ変換テンプレートを作成する際に使用する、ターゲットスキーマに基づいたサンプルプロファイルの生成 generate-sample-profiles-target-schema

IMPORTANT
テンプレートのレンダリング手順でテンプレートを作成する際に、ここで生成したサンプルプロファイルを使用します。

authoring/sample-profiles/ エンドポイントに対して GET リクエストを行い、作成しているテンプレートに基づいて宛先設定の宛先 ID を指定すると、ターゲットスキーマに基づいたサンプルプロファイルを生成できます。

TIP
  • ここで使用する必要がある宛先 ID は、宛先設定に対応した instanceId で、/destinations エンドポイントを使用して作成されています。詳しくは、宛先設定の取得を参照してください。

API 形式

GET authoring/sample-profiles?destinationId={DESTINATION_ID}&count={COUNT}
クエリパラメーター
説明
{DESTINATION_ID}
サンプルプロファイルの生成元となる宛先設定の ID。
{COUNT}
オプション。生成しているサンプルプロファイルの数。このパラメーターは、1 - 1000 の値を取ることができます。
count パラメーターが指定されていない場合、生成されたプロファイルのデフォルトの数は、宛先サーバー設定の maxUsersPerRequest 値によって決まります。このプロパティが定義されていない場合は、アドビが 1 つのサンプルプロファイルを生成します。

リクエスト

以下のリクエストは、{DESTINATION_ID} および {COUNT} クエリパラメーターで設定された、サンプルプロファイルを生成します。

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--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: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

応答

応答が成功すると、HTTP ステータス 200 が、指定された数のサンプルプロファイル（ターゲット XDM スキーマに対応するオーディエンスメンバーシップ、ID およびプロファイル属性を含む）と共に返されます。

[
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609326Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-vizii"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-adKYs"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-t4sKv"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-C3enB"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-bfnbs"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609626Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-6YjGc"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-SfJ21"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-eQMWS"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-d3WzP"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-eWfFn"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609823Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-2PMjZ"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-3aLez"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-D2H1J"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-i6PsF"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-VPUtZ"
                }
            ]
        }
    }
]

API エラー処理 api-error-handling

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

次の手順

このドキュメントでは、メッセージ変換テンプレートをテストする場合や宛先が正しく設定されているかどうかをテストする場合に使用される、サンプルプロファイルの生成方法を確認しました。

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6