ドキュメント Experience Platform リアルタイム顧客プロファイルガイド

エンティティエンドポイント（プロファイルアクセス）

最終更新日： 2026年1月27日

トピック：
{"id":"c132d929-fa62-4271-803e-b823be07b914"},{"id":"ed0d8d0e-04b9-4326-be72-a0fbca265377"}

作成対象：

{"id":"ff6a42d2-313e-452e-93a6-792e4fad9ff8"}

IMPORTANT

Real-Time CDP Ultimateをお持ちの場合は、これらのエンドポイントのみを使用できます。

Real-Time CDP Primeをお持ちの場合は、引き続きパーソナライズのユースケースにエクスペリエンスイベントを取り込んで使用したり、Experience Platform UI内でイベントを表示したりできますが、notはAPIを使用してエクスペリエンスイベントをプログラムで検索できます。

Real-Time CDP Ultimateがあり、現在 not 件のイベントをプログラムで検索している場合は、Adobe カスタマーケアにお問い合わせいただき、この機能を有効にしてください。

Adobe Experience Platformでは、RESTful APIまたはユーザーインターフェイスを使用してReal-Time Customer Profile データにアクセスできます。このガイドでは、API を使用してエンティティ（より一般的には「プロファイル」として知られています）にアクセスする方法について説明します。 Experience Platform UIを使用してプロファイルにアクセスする方法について詳しくは、プロファイルユーザーガイドを参照してください。

はじめに

このガイドで使用する API エンドポイントは、Real-Time Customer Profile API の一部です。先に進む前に、はじめる前にのガイドを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API の呼び出しを成功させるのに必要なヘッダーに関する重要な情報を確認してください。

エンティティ解決

アーキテクチャのアップグレードの一環として、Adobeでは、最新のデータにもとづく決定論的ID照合を利用して、アカウントとオポチュニティのエンティティ解決を導入します。エンティティ解決ジョブは、B2B属性を持つマルチエンティティオーディエンスを評価する前に、バッチセグメント化の間、毎日実行されます。

この機能強化により、Experience Platformでは、同じエンティティを表す複数のレコードを識別して統合できるようになり、データの一貫性が向上し、より正確なオーディエンスセグメンテーションが可能になります。

以前は、アカウントとオポチュニティは、すべての過去の取り込みを含む、IDをつなぎ合わせたID グラフベースの解決に依存していました。新しいエンティティ解決アプローチでは、IDは最新のデータのみに基づいてリンクされます。

アカウントと商談は、時間優先ベースのマージで解決されます。
- アカウント：b2b_account名前空間を使用するID。
- 商談：b2b_opportunity名前空間を使用するID。
その他のすべてのエンティティは単純に統合され、プライマリ IDの重複のみが時間優先ベースの結合と結合されます。

NOTE

エンティティ解決はb2b_accountとb2b_opportunityのみをサポートします。他の名前空間のIDは、エンティティ解決では使用されません。カスタム名前空間を使用している場合は、アカウントと商談を見つけることができません。

エンティティ解決の仕組み？

前: Data Universal Numbering System （DUNS）番号が追加IDとして使用され、アカウントのDUNS番号がCRMなどのソースシステムで更新された場合、アカウント IDは古いDUNS番号と新しいDUNS番号の両方にリンクされます。
後: DUNS番号が追加IDとして使用され、アカウントのDUNS番号がCRMなどのソースシステムで更新された場合、アカウント IDは新しいDUNS番号にのみリンクされるため、現在のアカウントの状態をより正確に反映できます。

この更新の結果、Profile Access APIは、エンティティ解決ジョブサイクルの完了後に最新の結合プロファイルビューを反映するようになりました。さらに、一貫性のあるデータは、セグメンテーション、アクティベーション、分析などのユースケースにおいて、データの正確性と一貫性を向上させます。

エンティティの取得 retrieve-entity

IMPORTANT

次のB2B エンティティは、API経由のルックアップリクエストでサポートされなくなりました。アカウントと人物の関係、商談と人物の関係、キャンペーン、キャンペーンメンバー、マーケティングリスト、マーケティングリストメンバー。

これらのエンティティのサポートは廃止されました。これらのエンティティへのアクセスに依存する既存の統合またはワークフローがある場合は、サポートされているエンティティタイプを使用して機能を維持するようにアップデートしてください。

プロファイルエンティティを取得するには、必要なクエリパラメーターと共に/access/entities エンドポイントにGET リクエストを行います。

プロファイルエンティティ

API 形式

code language-http
`GET /access/entities?{QUERY_PARAMETERS}`

クエリパスに指定されたデータパラメーターで、アクセスするデータを指定します。複数のパラメーターをアンパサンド（&）で区切って含めることができます。

プロファイルエンティティにアクセスするには、次のクエリパラメーターを指定する必要があります。

schema.name: エンティティのXDM スキーマの名前。この使用例では、schema.name=_xdm.context.profileです。
entityId：取得しようとしているエンティティのID。
entityIdNS：取得しようとしているエンティティの名前空間。この値は、entityIdが not でXIDの場合に指定する必要があります。

さらに、次のクエリパラメーターの使用は highly をお勧めします。

mergePolicyId: データをフィルタリングする結合ポリシーのID。結合ポリシーが指定されていない場合は、組織のデフォルトの結合ポリシーが使用されます。

有効なリストの完全なパラメーターは、付録の「クエリパラメータ」の節に記載されています。

リクエスト

次のリクエストは、IDを使用して顧客の電子メールと名前を取得します。

accordion

IDを使用してエンティティを取得するサンプルリクエスト

code language-shell

curl -X GET 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.profile&entityId=janedoe@example.com&entityIdNS=email&fields=identities,person.name,workEmail' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答が成功すると、リクエストされたエンティティのHTTP ステータス 200が返されます。

accordion

リクエストされたエンティティを含むサンプル応答

code language-json

{
    "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA": {
        "entityId": "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316601",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "johnsmith@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316604",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "58832431024964181144308914570411162539",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316602",
                    "namespace": {
                        "code": "ecid"
                    },
                    "primary": true
                }
            ],
            "person": {
                "name": {
                    "firstName": "Jane",
                    "middleName": "F",
                    "lastName": "Doe"
                }
            },
            "workEmail": {
                "primary": true,
                "address": "janedoe@example.com",
                "label": "Jane Doe",
                "type": "work",
                "status": "active"
            }
        },
        "lastModifiedAt": "2018-08-28T20:57:24Z"
    }
}

note
NOTE
関連するグラフが 50 個を超える ID をリンクする場合、このサービスは HTTP ステータス 422（処理できないエンティティ）と「関連 ID が多すぎます」というメッセージを返します。このエラーが表示される場合は、検索を絞り込むためにクエリパラメータを追加することを検討してください。

B2B アカウント

API 形式

code language-http
`GET /access/entities?{QUERY_PARAMETERS}`

B2B アカウントデータにアクセスするには、次のクエリパラメーターを指定する必要があります。

schema.name: エンティティのXDM スキーマの名前。この使用例では、この値はschema.name=_xdm.context.accountです。
entityId：取得しようとしているエンティティのID。
entityIdNS：取得しようとしているエンティティの名前空間。この値は、entityIdが not でXIDの場合に指定する必要があります。

さらに、次のクエリパラメーターの使用は highly をお勧めします。

mergePolicyId: データをフィルタリングする結合ポリシーのID。結合ポリシーが指定されていない場合は、組織のデフォルトの結合ポリシーが使用されます。

有効なリストの完全なパラメーターは、付録の「クエリパラメータ」の節に記載されています。

リクエスト

accordion

B2B アカウントを取得するためのサンプルリクエスト

code language-shell

curl -X GET 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.account&entityIdNs=b2b_account&entityId=2334262' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答が成功すると、リクエストされたエンティティのHTTP ステータス 200が返されます。

accordion

リクエストされたエンティティを含むサンプル応答

code language-json

{
    "GuQ-AUFjgjaeIw": {
        "entityId": "GuQ-AUFjgjaeIw",
        "mergePolicy": {
            "id": "a6150f47-a94f-4c9d-bfa0-958a370020ee"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "{SOURCE_ID}",
                    "sourceKey": "{SOURCE_KEY}",
                    "sourceInstanceID": "{SOURCE_INSTANCE_ID}",
                    "sourceType": "{SOURCE_TYPE}"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_account": [
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    },
                    {
                        "id": "{SOURCE_ID}"
                    }
                ]
            },
            "isDeleted": false,
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    }
}

B2B商談

API 形式

code language-http
`GET /access/entities?{QUERY_PARAMETERS}`

B2B商談エンティティにアクセスするには、次のクエリパラメーターを指定する必要があります。

schema.name: エンティティのXDM スキーマの名前。この使用例では、schema.name=_xdm.context.opportunityです。
entityId：取得しようとしているエンティティのID。
entityIdNS：取得しようとしているエンティティの名前空間。この値は、entityIdが not でXIDの場合に指定する必要があります。

さらに、次のクエリパラメーターの使用は highly をお勧めします。

mergePolicyId: データをフィルタリングする結合ポリシーのID。結合ポリシーが指定されていない場合は、組織のデフォルトの結合ポリシーが使用されます。

有効なリストの完全なパラメーターは、付録の「クエリパラメータ」の節に記載されています。

リクエスト

accordion

B2B商談エンティティを取得するためのサンプルリクエスト

code language-shell

curl -X GET 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.opportunity&entityIdNs=b2b_opportunity&entityId=2334262' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答が成功すると、リクエストされたエンティティのHTTP ステータス 200が返されます。

accordion

リクエストされたエンティティを含むサンプル応答

code language-json

{
  "Ggw_AUFjgjaeIw": {
        "entityId": "Ggw_AUFjgjaeIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    },
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    }
}

複数のエンティティの取得 retrieve-entities

/access/entities エンドポイントにPOST リクエストを行い、ペイロードにIDを指定することで、複数のプロファイルエンティティを取得できます。

プロファイルエンティティ

API 形式

code language-http
`POST /access/entities`

リクエスト

次のリクエストは、IDのリストによって複数の顧客の名前とメールアドレスを取得します。

accordion

複数のエンティティを取得するためのサンプルリクエスト

code language-shell

curl -X POST https://platform.adobe.io/data/core/ups/access/entities \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "schema":{
            "name":"_xdm.context.profile"
        },
        "fields":[
            "identities",
            "person.name",
            "workEmail"
        ],
        "identities":[
            {
                "entityId":"89149270342662559642753730269986316601",
                "entityIdNS":{
                    "code":"ECID"
                }
            },
            {
                "entityId":"89149270342662559642753730269986316900",
                "entityIdNS":{
                    "code":"ECID"
                }
            },
            {
                "entityId":"89149270342662559642753730269986316602",
                "entityIdNS":{
                    "code":"ECID"
                }
            }
        ],
        "timeFilter": {
            "startTime": 1539838505,
            "endTime": 1539838510
        },
        "limit": 10,
        "orderby": "-timestamp"
      }'

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3
プロパティ	タイプ	説明
`schema.name`	文字列	（必須）エンティティが属する XDM スキーマの名前。
`fields`	配列	返される XDM フィールド（文字列の配列）。デフォルトでは、すべてのフィールドが返されます。
`identities`	配列	（必須）アクセスするエンティティの ID のリストを含む配列。
`identities.entityId`	文字列	アクセスするエンティティの ID。
`identities.entityIdNS.code`	文字列	アクセスするエンティティ ID の名前空間。
`timeFilter.startTime`	整数	プロファイルエンティティをフィルタリングする開始時間をミリ秒単位で指定します。デフォルトでは、この値は使用可能な時間の先頭として設定されます。
`timeFilter.endTime`	整数	プロファイルエンティティをフィルタリングする終了時間をミリ秒単位で指定します。デフォルトでは、この値は使用可能な時間の最後に設定されます。
`limit`	整数	返されるレコードの最大数。デフォルトでは、この値は 1000 に設定されています。
`orderby`	文字列	取得したエクスペリエンスイベントをタイムスタンプ別に並べ替える順序です。デフォルトは `+timestamp` で、`(+/-)timestamp` として記述されます。

応答

応答が成功すると、リクエスト本文で指定されたエンティティのリクエストされたフィールドを含むHTTP ステータス 200が返されます。

accordion

リクエストされたエンティティを含むサンプル応答

code language-json

{
    "A29cgveD5y64ezlhxjUXNzcm": {
        "entityId": "A29cgveD5y64ezlhxjUXNzcm",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316601",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "05DD23564EC4607F0A490D44",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316603",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janesmith@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316604",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316700",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316701",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "58832431024964181144308914570411162539",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316602",
                    "namespace": {
                        "code": "ecid"
                    },
                    "primary": true
                }
            ],
            "person": {
                "name": {
                    "firstName": "Jane",
                    "middleName": "F",
                    "lastName": "Doe"
                }
            },
            "workEmail": {
                "primary": true,
                "address": "janedoe@example.com",
                "label": "Jane Doe",
                "type": "work",
                "status": "active"
            }
        },
        "lastModifiedAt": "2018-08-28T20:57:24Z"
    },
    "A29cgveD5y64e2RixjUXNzcm": {
        "entityId": "A29cgveD5y64e2RixjUXNzcm",
        "sources": [
            ""
        ],
        "entity": {},
        "lastModifiedAt": "1970-01-01T00:00:00Z"
    },
    "A29cgveD5y64ezphxjUXNzcm": {
        "entityId": "A29cgveD5y64ezphxjUXNzcm",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316602",
                    "namespace": {
                        "code": "ecid"
                    },
                    "primary": true
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                }
            ],
            "person": {
                "name": {
                    "firstName": "Jane",
                    "middleName": "F",
                    "lastName": "Doe"
                }
            },
            "workEmail": {
                "primary": true,
                "address": "janedoe@example.com",
                "label": "Jane Doe",
                "type": "work",
                "status": "active"
            }
        },
        "lastModifiedAt": "2018-08-27T23:25:52Z"
    }
}

B2B アカウント

API 形式

code language-http
`POST /access/entities`

リクエスト

次のリクエストは、リクエストされたB2B アカウントを取得します。

accordion

複数のエンティティを取得するためのサンプルリクエスト

code language-shell

curl -X POST https://platform.adobe.io/data/core/ups/access/entities \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "schema":{
            "name":"_xdm.context.account"
        },
        "identities": [
            {
                "entityId": "2334262",
                "entityIdNS": {
                    "code":"b2b_account"
                }
            },
            {
                "entityId": "2334263",
                "entityIdNS": {
                    "code":"b2b_account"
                }
            },
            {
                "entityId": "2334264",
                "entityIdNS": {
                    "code":"b2b_account"
                }
            }
        ]
    }'

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3
プロパティ	タイプ	説明
`schema.name`	文字列	（必須）エンティティが属する XDM スキーマの名前。
`identities`	配列	（必須）アクセスするエンティティの ID のリストを含む配列。
`identities.entityId`	文字列	アクセスするエンティティの ID。
`identities.entityIdNS.code`	文字列	アクセスするエンティティ ID の名前空間。

応答

応答が成功すると、要求されたエンティティを含むHTTP ステータス 200が返されます。

accordion

リクエストされたエンティティを含むサンプル応答

code language-json

{
    "GuQ-AUFjgjeeIw": {
        "requestedIdentity": {
            "entityId": "2334263",
            "entityIdNS": {
                "code": "b2b_account"
            }
        },
        "entityId": "GuQ-AUFjgjeeIw",
        "mergePolicy": {
            "id": "a6150f47-a94f-4c9d-bfa0-958a370020ee"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_account": [
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    },
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    }
                ]
            },
            "isDeleted": false,
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    },
    "GuQ-AUFjgjaeIw": {
        "requestedIdentity": {
            "entityId": "2334262",
            "entityIdNS": {
                "code": "b2b_account"
            }
        },
        "entityId": "GuQ-AUFjgjaeIw",
        "mergePolicy": {
            "id": "a6150f47-a94f-4c9d-bfa0-958a370020ee"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_account": [
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    },
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    }
                ]
            },
            "isDeleted": false,
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    },
    "GuQ-AUFjgjmeIw": {
        "requestedIdentity": {
            "entityId": "2334265",
            "entityIdNS": {
                "code": "b2b_account"
            }
        },
        "entityId": "GuQ-AUFjgjmeIw",
        "mergePolicy": {
            "id": "a6150f47-a94f-4c9d-bfa0-958a370020ee"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0054c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334265",
            "identityMap": {
            "b2b_account": [
                {
                    "id": "0054c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                },
                {
                    "id": "2334265"
                }
            ]
        },
        "isDeleted": false,
        "accountKey": {
            "sourceID": "2334265",
            "sourceKey": "2334265",
            "sourceInstanceID": "2334265",
            "sourceType": "Random"
        }
    }
}

B2B商談

API 形式

code language-http
`POST /access/entities`

リクエスト

次のリクエストは、リクエストされたB2B商談を取得します。

accordion

複数のエンティティを取得するためのサンプルリクエスト

code language-shell

curl -X POST https://platform.adobe.io/data/core/ups/access/entities \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "schema":{
            "name":"_xdm.context.opportunity"
        },
        "identities": [
            {
                "entityId": "2334262",
                "entityIdNS": {
                    "code":"b2b_opportunity"
                }
            },
            {
                "entityId": "2334263",
                "entityIdNS": {
                    "code":"b2b_opportunity"
                }
            },
            {
                "entityId": "2334264",
                "entityIdNS": {
                    "code":"b2b_opportunity"
                }
            },
            {
                "entityId": "2334265",
                "entityIdNS": {
                    "code":"b2b_opportunity"
                }
            }
        ]
    }'

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3
プロパティ	タイプ	説明
`schema.name`	文字列	（必須）エンティティが属する XDM スキーマの名前。
`identities`	配列	（必須）アクセスするエンティティの ID のリストを含む配列。
`identities.entityId`	文字列	アクセスするエンティティの ID。
`identities.entityIdNS.code`	文字列	アクセスするエンティティ ID の名前空間。

応答

応答が成功すると、要求されたエンティティを含むHTTP ステータス 200が返されます。

accordion

リクエストされたエンティティを含むサンプル応答

code language-json

{
    "Ggw_AUFjgjaeIw": {
        "requestedIdentity": {
            "entityId": "2334262",
            "entityIdNS": {
                "code": "b2b_opportunity"
            }
        },
        "entityId": "Ggw_AUFjgjaeIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    },
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    },
    "Ggw_AUFjgjieIw": {
        "requestedIdentity": {
            "entityId": "2334264",
            "entityIdNS": {
                "code": "b2b_opportunity"
            }
        },
        "entityId": "Ggw_AUFjgjieIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0041c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334264",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "2334264"
                    },
                    {
                        "id": "0041c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334264",
                "sourceKey": "2334264",
                "sourceInstanceID": "2334264",
                "sourceType": "Salesforce"
            }
        }
    },
    "Ggw_AUFjgjeeIw": {
        "requestedIdentity": {
            "entityId": "2334263",
            "entityIdNS": {
                "code": "b2b_opportunity"
            }
        },
        "entityId": "Ggw_AUFjgjeeIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    },
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    },
    "Ggw_AUFjgjmeIw": {
        "requestedIdentity": {
            "entityId": "2334265",
            "entityIdNS": {
                "code": "b2b_opportunity"
            }
        },
        "entityId": "Ggw_AUFjgjmeIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0054c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334265",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "2334265"
                    },
                    {
                        "id": "0054c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334265",
                "sourceKey": "2334265",
                "sourceInstanceID": "2334265",
                "sourceType": "Random"
            }
        }
    }
}

結果の後続ページへのアクセス

時系列イベントを取得すると、結果はページ付けされます。結果の後続のページがある場合、_page.next プロパティには ID が含まれます。また、_links.next.href プロパティは次のページを取得するためのリクエスト URI を提供します。結果を取得するには、/access/entities エンドポイントに別のGET リクエストを行い、/entitiesを指定されたURIの値に置き換えます。

NOTE

リクエストパスで/entities/を誤って繰り返さないようにしてください。これは一度だけ /access/entities?start=... のように存在するべきです。

API 形式

GET /access/{NEXT_URI}

パラメーター

説明

{NEXT_URI}

_links.next.href から取得した URI 値。

リクエスト

次のリクエストでは、_links.next.href URI をリクエストパスとして使用して、次のページの結果を取得します。

結果の次のページにアクセスするためのサンプルリクエスト

code language-shell

curl -X GET \
  'https://platform.adobe.io/data/core/ups/access/entities?start=c8d11988-6b56-4571-a123-b6ce74236037&orderby=timestamp&schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=89149270342662559642753730269986316900&relatedEntityIdNS=ECID&fields=endUserIDs,web,channel&startTime=1531260476000&endTime=1531260480000&limit=1' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

正常な応答は、結果の次のページを返します。この応答には、_page.next および _links.next.href の空の文字列値で示される結果の後続ページはありません。

エンティティの次のページを含むサンプル応答

code language-json

{
    "_page": {
        "orderby": "timestamp",
        "start": "c8d11988-6b56-4571-a123-b6ce74236037",
        "count": 1,
        "next": ""
    },
    "children": [
        {
            "relatedEntityId": "A29cgveD5y64e2RixjUXNzcm",
            "entityId": "c8d11988-6b56-4571-a123-b6ce74236037",
            "timestamp": 1531260477000,
            "entity": {
                "endUserIDs": {
                    "_experience": {
                        "ecid": {
                            "id": "89149270342662559642753730269986316900",
                            "namespace": {
                                "code": "ecid"
                            }
                        }
                    }
                },
                "channel": {
                    "_type": "web"
                },
                "web": {
                    "webPageDetails": {
                        "name": "Fernie Snow",
                        "pageViews": {
                            "value": 1
                        }
                    }
                }
            },
            "lastModifiedAt": "2018-08-21T06:50:01Z"
        }
    ],
    "_links": {
        "next": {
            "href": ""
        }
    }
}

エンティティの削除 delete-entity

IMPORTANT

エンティティの削除エンドポイントは、2025年10月末までに非推奨（廃止予定）になります。レコード削除操作を実行する場合は、代わりにデータライフサイクルレコード削除API ワークフローまたはデータライフサイクルレコード削除UI ワークフローを使用できます。

さらに、次のB2B エンティティの削除要求は既に廃止されています。

アカウント
アカウントと人物の関係
Opportunity
商談と人物の関係
Campaign
キャンペーンメンバー
マーケティングリスト
マーケティングリストメンバー

プロファイルストアからエンティティを削除するには、必要なクエリパラメーターと共に/access/entities エンドポイントにDELETE リクエストを行います。

API 形式

DELETE /access/entities?{QUERY_PARAMETERS}

エンティティを削除するには、次のクエリパラメーターを指定する必要があります。

schema.name: エンティティのXDM スキーマの名前。この使用例では、のみでschema.name=_xdm.context.profileを使用できます。
entityId：取得しようとしているエンティティのID。
entityIdNS：取得しようとしているエンティティの名前空間。この値は、entityIdが not でXIDの場合に指定する必要があります。
mergePolicyId: エンティティの結合ポリシーID。結合ポリシーには、ID ステッチとキー値XDM オブジェクトの結合に関する情報が含まれます。この値を指定しない場合は、デフォルトの結合ポリシーが使用されます。

リクエスト

次のリクエストは、指定されたエンティティを削除します。

エンティティを削除するサンプルリクエスト

code language-shell

curl -X DELETE 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.profile&entityId=janedoe@example.com&entityIdNS=email' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答が成功すると、HTTP ステータス 202が空の応答本文で返されます。

次の手順

このガイドに従うことで、Real-Time Customer Profile個のデータフィールド、プロファイル、時系列データに正常にアクセスできます。 Experience Platformに保存されているその他のデータリソースにアクセスする方法については、データアクセスの概要を参照してください。

付録 appendix

次の節では、APIを使用したProfile データへのアクセスに関する補足情報を提供します。

クエリパラメーター query-parameters

次のパラメーターは、/access/entities エンドポイントに対する GET リクエストのパスで使用されます。アクセスするプロファイルエンティティを識別し、応答で返されるデータをフィルターします。必須パラメーターはラベル付けされますが、残りはオプションです。

パラメーター

説明

例

schema.name

（必須） エンティティのXDM スキーマの名前。

schema.name=_xdm.context.profile

relatedSchema.name

schema.nameが_xdm.context.experienceeventの場合、この値 は、時系列イベントが関連するプロファイルエンティティのスキーマを 指定する必要があります。

relatedSchema.name=_xdm.context.profile

entityId

（必須） エンティティのID。このパラメーターの値がXIDでない場合は、ID名前空間パラメーター（entityIdNS）も指定する必要があります。

entityId=janedoe@example.com

entityIdNS

entityIdがXIDとして指定されていない場合、このフィールド はID名前空間を指定する必要があります。

entityIdNS=email

relatedEntityId

schema.nameが_xdm.context.experienceeventの場合、この値は関連するプロファイルエンティティのIDを指定する必要があります。この値は、entityId と同じ規則に従います。

relatedEntityId=69935279872410346619186588147492736556

relatedEntityIdNS

schema.name が「_xdm.context.experienceevent」の場合、この値は relatedEntityId で指定したエンティティの ID 名前空間を指定する必要があります。

relatedEntityIdNS=CRMID

fields

応答で返されるデータをフィルターします。取得したデータに含めるスキーマフィールドの値を指定します。複数のフィールドの場合は、値をコンマで区切り、間にスペースを入れないようにします。

fields=personalEmail,person.name,person.gender

mergePolicyId

推奨返されるデータを管理する結合ポリシーを特定します。呼び出しで指定されていない場合は、組織のデフォルトのスキーマが使用されます。要求するスキーマにデフォルトの結合ポリシーが定義されていない場合、APIはHTTP 422 エラーステータスコードを返します。

mergePolicyId=5aa6885fcf70a301dabdfa4a

orderBy

取得したエンティティのタイムスタンプによる並べ替え順序。これは(+/-)timestampと書かれており、デフォルトは+timestampです。

orderby=-timestamp

startTime

エンティティをフィルタリングする開始時間（ミリ秒単位）を指定します。

startTime=1539838505

endTime

エンティティをフィルタリングする終了時間（ミリ秒単位）を指定します。

endTime=1539838510

limit

返すエンティティの最大数を指定します。デフォルトでは、この値は 1000 に設定されています。

limit=100

property

プロパティ値でフィルタリングします。このクエリパラメーターは、次の評価子をサポートしています：=、!=、<、<=、>、>=。これはエクスペリエンスイベントでのみ使用でき、最大3つのプロパティがサポートされています。

property=webPageDetails.isHomepage=true&property=localTime<="2020-07-20"

recommendation-more-help

experience-platform-help-profile