結合ポリシーエンドポイント

Adobe Experience Platform では、個々の顧客の全体像を把握するために、複数のソースから得られたデータフラグメントを統合し組み合わせることができます。結合ポリシーとは、データを統合する場合のデータの優先順位付け方法と、統合されたビューを作成するためにどのデータを組み合わせるかを決定するために Platform が使用するルールです。

例えば、顧客が複数のチャネルをまたがって自社のブランドとやり取りを行う場合、1 人の顧客に関連する複数のプロファイルフラグメントが複数のデータセットに表示されます。これらのフラグメントが Platform に取り込まれると、それらのフラグメントが結合され、その顧客用に単一のプロファイルが作成されます。複数のソースからのデータが競合する場合(例えば、1 つのフラグメントリストが顧客について「独身」、他のリストが「既婚」としている場合)、結合ポリシーが、個人のプロファイルに含める情報を決定します。

RESTful API またはユーザーインターフェイスを介すると、新しい結合ポリシーの作成、既存のポリシーの管理、組織のデフォルトの結合ポリシーの設定をおこなえます。このガイドでは、API を使用して結合ポリシーを操作する手順を説明します。

UI を使用して結合ポリシーを操作するには、 結合ポリシー UI ガイド. 一般的な結合ポリシーと、Experience Platform内での役割について詳しくは、まず 結合ポリシーの概要.

はじめに

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

結合ポリシーのコンポーネント

結合ポリシーは IMS 組織外には非公開であり、必要に応じてスキーマを結合するために異なるポリシーを作成できます。任意の API アクセス Profile データには結合ポリシーが必要ですが、明示的に指定されていない場合はデフォルトが使用されます。 Platform は、組織にデフォルトの結合ポリシーを提供します。または、特定の Experience Data Model(XDM) スキーマクラスの結合ポリシーを作成して、組織のデフォルトとして指定することもできます。

各組織はスキーマクラスごとに複数の結合ポリシーを持つことができますが、各クラスは 1 つのデフォルト結合ポリシーのみを持つことができます。 デフォルトとして設定された結合ポリシーは、スキーマクラスの名前が指定され、結合ポリシーが必要であるが指定されていない場合に使用されます。

メモ

新しい結合ポリシーをデフォルトとして設定すると、以前にデフォルトとして設定された既存の結合ポリシーは自動的にデフォルトとして使用されなくなります。

すべてのプロファイルコンシューマーがエッジで同じビューを使用していることを確認するために、結合ポリシーをエッジでアクティブとしてマークできます。セグメントをエッジでアクティブ化(エッジセグメントとしてマーク)するには、エッジでアクティブとマークされた結合ポリシーに結び付ける必要があります。セグメントがエッジでアクティブとしてマークされている結合ポリシーに結び付けられて​いない​場合、そのセグメントはエッジでアクティブとマークされず、ストリーミングセグメントとしてマークされます。

さらに、各 IMS 組織は、エッジでアクティブな結合ポリシーを 1 つ​だけ持つことができます。結合ポリシーがエッジでアクティブな場合、エッジプロファイル、エッジセグメント化、エッジ上の宛先など、エッジ上の他のシステムで使用できます。

完全な結合ポリシーオブジェクト

完全な結合ポリシーオブジェクトは、プロファイルフラグメントの結合の側面を制御する一連の設定を表します。

結合ポリシーオブジェクト

    {
        "id": "{MERGE_POLICY_ID}",
        "name": "{NAME}",
        "imsOrgId": "{ORG_ID}",
        "schema": {
            "name": "{SCHEMA_CLASS_NAME}"
        },
        "version": 1,
        "identityGraph": {
            "type": "{IDENTITY_GRAPH_TYPE}"
        },
        "attributeMerge": {
            "type": "{ATTRIBUTE_MERGE_TYPE}"
        },
        "isActiveOnEdge": "{BOOLEAN}",
        "default": "{BOOLEAN}",
        "updateEpoch": "{UPDATE_TIME}"
    }
プロパティ 説明
id 作成時に割り当てられる、システムで生成された一意の ID
name リスト表示で結合ポリシーを識別できるわかりやすい名前。
imsOrgId この結合ポリシーが属する組織 ID
schema.name の一部 schema オブジェクト、 name フィールドには、結合ポリシーが関連する XDM スキーマクラスが含まれます。 スキーマとクラスの詳細については、 XDM ドキュメント.
version Platform 結合ポリシーのバージョンが維持されます。 この読み取り専用の値は、結合ポリシーが更新されるたびに増加します。
identityGraph 関連 ID の取得元(ID)の ID グラフを示す ID グラフオブジェクト。関連するすべての ID で見つかったプロファイルフラグメントが結合されます。
attributeMerge 属性の結合 データの競合時に結合ポリシーがプロファイル属性に優先順位を付ける方法を示すオブジェクト。
isActiveOnEdge この結合ポリシーをエッジで使用できるかどうかを示すブール値。 デフォルトでは、この値は false.
default この結合ポリシーが指定されたスキーマのデフォルトかどうかを示すブール値。
updateEpoch 結合ポリシーの最後の更新日。

結合ポリシーの例

    {
        "id": "10648288-cda5-11e8-a8d5-f2801f1b9fd1",
        "name": "profile-default",
        "imsOrgId": "{ORG_ID}",
        "schema": {
            "name": "_xdm.context.profile"
        },
        "version": 1,
        "identityGraph": {
            "type": "none"
        },
        "attributeMerge": {
            "type": "timestampOrdered"
        },
        "isActiveOnEdge": false,
        "default": true,
        "updateEpoch": 1551660639
    }

ID グラフ

Adobe Experience Platform Identity Service は、グローバルに、およびの各組織で使用される id グラフを管理します。 Experience Platform. 結合ポリシーの identityGraph 属性は、ユーザーの関連 ID の決定方法を定義します。

ID グラフオブジェクト

    "identityGraph": {
        "type": "{IDENTITY_GRAPH_TYPE}"
    }

ここで、{IDENTITY_GRAPH_TYPE} は次のいずれかです。

  • none:ID を結合しません。
  • pdg:​個人の ID グラフに基づいて ID を結合します。

identityGraph

    "identityGraph": {
        "type": "pdg"
    }

属性の結合

プロファイルフラグメントとは、特定のユーザーに存在する ID のリストからの 1 つの ID のプロファイル情報のことです。使用される ID グラフタイプが複数の ID になる場合、プロファイル属性が競合する可能性があり、優先度を指定する必要があります。 使用 attributeMergeを使用すると、「キー値(レコードデータ) 」タイプのデータセット間で結合の競合が発生した場合に、優先するプロファイル属性を指定できます。

attributeMerge オブジェクト

    "attributeMerge": {
        "type": "{ATTRIBUTE_MERGE_TYPE}"
    }

ここで、{ATTRIBUTE_MERGE_TYPE} は次のいずれかです。

  • timestampOrdered:(デフォルト)最後に更新されたプロファイルを優先します。 この結合タイプを使用する場合、data 属性は不要です。
  • dataSetPrecedence:訪問者のデータセットに基づいて、プロファイルフラグメントを優先します。 これは、あるデータセットに存在する情報が別のデータセットのデータよりも優先または信頼されている場合に使用できます。この結合タイプを使用する場合、order 属性は優先順にデータセットをリストするので、必須です。
    • order:"dataSetPrecedence"を使用する場合、 order 配列は、データセットのリストと共に指定する必要があります。 データセットに含まれていないリストは結合されません。つまり、データセットをプロファイルに結合するには、データセットを明示的にリストする必要があります。order 配列は、データセットの ID を優先順にリストします。

attributeMerge 使用するオブジェクト dataSetPrecedence type

    "attributeMerge": {
        "type": "dataSetPrecedence",
        "order": [
            "dataSetId_2",
            "dataSetId_3",
            "dataSetId_1",
            "dataSetId_4"
        ]
    }

attributeMerge 使用するオブジェクト timestampOrdered type

    "attributeMerge": {
        "type": "timestampOrdered"
    }

スキーマ

スキーマオブジェクトは、この結合ポリシーを作成する Experience Data Model(XDM) スキーマクラスを指定します。

schemaオブジェクト

    "schema": {
        "name": "{SCHEMA_NAME}"
    }

name の値は、結合ポリシーに関連付けられたスキーマの基となる XDM クラスの名前です。

schema

    "schema": {
        "name": "_xdm.context.profile"
    }

XDM の詳細とExperience Platformでのスキーマの操作については、まず XDM システムの概要.

結合ポリシーへのアクセス

の使用 Real-time Customer Profile API、 /config/mergePolicies エンドポイントを使用すると、検索リクエストを実行して、ID で特定の結合ポリシーを表示したり、IMS 組織内のすべての結合ポリシーを、特定の条件でフィルターして表示したりできます。 また、 /config/mergePolicies/bulk-get エンドポイントを使用して、ID で複数の結合ポリシーを取得できます。 これらの各呼び出しを実行する手順について、以下の節で概要を説明します。

ID による単一の結合ポリシーへのアクセス

/config/mergePolicies エンドポイントに GET リクエストを送信し、リクエストパスに mergePolicyId を含めることで、ID を使用して 1 つの結合ポリシーにアクセスすることができます。

API 形式

GET /config/mergePolicies/{mergePolicyId}
パラメーター 説明
{mergePolicyId} 削除する結合ポリシーの識別子。

リクエスト

curl -X GET \
  'https://platform.adobe.io/data/core/ups/config/mergePolicies/10648288-cda5-11e8-a8d5-f2801f1b9fd1' \
  -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}

応答

正常な応答は、結合ポリシーの詳細を返します。

{
    "id": "10648288-cda5-11e8-a8d5-f2801f1b9fd1",
    "imsOrgId": "{ORG_ID}",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "version": 1,
    "identityGraph": {
        "type": "pdg"
    },
    "attributeMerge": {
        "type": "timestampOrdered"
    },
    "isActiveOnEdge": "false",
    "default": false,
    "updateEpoch": 1551127597
}

結合ポリシーを構成する個々の要素の詳細については、このドキュメントの最初にある「結合ポリシーのコンポーネント」の節を参照してください。

ID による複数の結合ポリシーの取得

複数の結合ポリシーを取得するには、 /config/mergePolicies/bulk-get エンドポイントを探し、取得する結合ポリシーの ID をリクエスト本文に含めます。

API 形式

POST /config/mergePolicies/bulk-get

リクエスト

リクエスト本文には、詳細を取得する各結合ポリシーの「id」を含む個々のオブジェクトを持つ「ids」配列が含まれます。

curl -X POST \
  'https://platform.adobe.io/data/core/ups/config/mergePolicies/bulk-get' \
  -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}' \
  -H 'Content-Type: application/json' \
  -d '{
        "ids": [
          {
            "id": "0bf16e61-90e9-4204-b8fa-ad250360957b"
          },
          {
            "id": "42d4a596-b1c6-46c0-994e-ca5ef1f85130"
          }
        ]
      }'

応答

正常な応答は、HTTP ステータス 207(マルチステータス)と、POSTリクエストで ID が提供された結合ポリシーの詳細を返します。

{
    "results": {
        "0bf16e61-90e9-4204-b8fa-ad250360957b": {
            "id": "0bf16e61-90e9-4204-b8fa-ad250360957b",
            "name": "Profile Default Merge Policy",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "schema": {
                "name": "_xdm.context.profile"
            },
            "version": 1,
            "identityGraph": {
                "type": "none"
            },
            "attributeMerge": {
                "type": "timestampOrdered"
            },
            "isActiveOnEdge": true,
            "default": true,
            "updateEpoch": 1552086578
        },
        "42d4a596-b1c6-46c0-994e-ca5ef1f85130": {
            "id": "42d4a596-b1c6-46c0-994e-ca5ef1f85130",
            "name": "Dataset Precedence Merge Policy",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "schema": {
                "name": "_xdm.context.profile"
            },
            "version": 1,
            "identityGraph": {
                "type": "pdg"
            },
            "attributeMerge": {
                "type": "dataSetPrecedence",
                "order": [
                    "5b76f86b85d0e00000be5c8b",
                    "5b76f8d787a6af01e2ceda18"
                ]
            },
            "isActiveOnEdge": false,
            "default": false,
            "updateEpoch": 1576099719
        }
    }
}

結合ポリシーを構成する個々の要素の詳細については、このドキュメントの最初にある「結合ポリシーのコンポーネント」の節を参照してください。

条件別の複数の結合ポリシーのリスト

/config/mergePolicies エンドポイントに GET リクエストを発行し、オプションのクエリーパラメーターを使用して応答をフィルター、並び替え、ページネートすることで、IMS 組織内で複数の結合ポリシーをリストできます。複数のパラメーターを含める場合は、アンパサンド(&)で区切ります。パラメーターを指定しないでこのエンドポイントを呼び出すと、組織で使用可能なすべての結合ポリシーが取得されます。

API 形式

GET /config/mergePolicies?{QUERY_PARAMS}
パラメーター 説明
default 結合ポリシーがフィルタークラスのデフォルトであるかどうかによって結果をスキーマするブール値。
limit ページに含める結果の数を制御するためのページサイズの制限を指定します。デフォルト値:20
orderBy 名前を昇順で並べ替えるには orderBy=name または orderBy=+name のように結果を並べ替えるフィールドを指定し、降順で並べ替えるには orderBy=-name を指定します。この値を省略すると、name のデフォルトの並べ替え順が昇順になります。
isActiveOnEdge 結合ポリシーがエッジでアクティブかどうかで結果をフィルタリングする boolean 値です。
schema.name 使用可能な結合スキーマを取得するポリシーの名前。
identityGraph.type フィルターは、ID グラフのタイプ別に表示されます。有効な値は、「none」と「pdg」(プライベートグラフ)です。
attributeMerge.type フィルターは、使用される属性の結合タイプ別に結果を返します。指定できる値は、「timestampOrdered」と「dataSetPrecedence」です。
start ページオフセット — 取得するデータの開始 ID を指定します。デフォルト値:0
version 特定のバージョンの結合ポリシーを使用する場合に指定します。デフォルトでは、最新バージョンが使用されます。

schema.nameidentityGraph.typeattributeMerge.type に関する詳細は、このガイドで前述した「結合ポリシーのコンポーネント」の節を参照してください。

リクエスト

次のリクエストは、特定のスキーマのすべての統合ポリシーをリストします。

curl -X GET \
  'https://platform.adobe.io/data/core/ups/config/mergePolicies?schema.name=_xdm.context.profile' \
  -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": {
        "totalCount": 2,
        "pageSize": 2
    },
    "children": [
        {
            "id": "0bf16e61-90e9-4204-b8fa-ad250360957b",
            "name": "Profile Default Merge Policy",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "schema": {
                "name": "_xdm.context.profile"
            },
            "version": 1,
            "identityGraph": {
                "type": "none"
            },
            "attributeMerge": {
                "type": "timestampOrdered"
            },
            "isActiveOnEdge": true,
            "default": true,
            "updateEpoch": 1552086578
        },
        {
            "id": "42d4a596-b1c6-46c0-994e-ca5ef1f85130",
            "name": "Dataset Precedence Merge Policy",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "schema": {
                "name": "_xdm.context.profile"
            },
            "version": 1,
            "identityGraph": {
                "type": "pdg"
            },
            "attributeMerge": {
                "type": "dataSetPrecedence",
                "order": [
                    "5b76f86b85d0e00000be5c8b",
                    "5b76f8d787a6af01e2ceda18"
                ]
            },
            "isActiveOnEdge": false,
            "default": false,
            "updateEpoch": 1576099719
        }
    ],
    "_links": {
        "next": {
            "href": "@/mergePolicies?start=K1JJRDpFaWc5QUpZWHY1c2JBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQldBQkVBQVBnaFFQLzM4VUIvL2tKQi8rLysvMUpBLzMrMi8wRkFmLzR4UUwvL0VrRC85em4zRTBEcmNmYi92Kzh4UUwvL05rQVgzRi8rMStqNS80WHQwN2NhUUVzQUFBUUFleGpLQ1JnVXRVcEFCQUFFQVBBRA==&orderBy=&limit=2"
        }
    }
}
プロパティ 説明
_links.next.href 結果の次のページの URI アドレス。この URI を、同じエンドポイントに対する別の API 呼び出しのリクエストパラメーターとして使用し、ページを表示します。次のページが存在しない場合、この値は空の文字列になります。

結合ポリシーの作成

/config/mergePoliciesエンドポイントに POST リクエストをおこなうことで、組織の新しい結合ポリシーを作成できます。

API 形式

POST /config/mergePolicies

リクエスト
次のリクエストは、ペイロードで指定された属性値によって設定される新しい結合ポリシーを作成します。

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/mergePolicies \
  -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}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Loyalty members ordered by ID",
    "identityGraph": {
        "type": "none"
    },
    "attributeMerge": {
        "type":"dataSetPrecedence",
        "order": [
            "5b76f86b85d0e00000be5c8b",
            "5b76f8d787a6af01e2ceda18"
        ]
    },
    "schema": {
        "name":"_xdm.context.profile"
    },
    "isActiveOnEdge": true,
    "default": true
}'
プロパティ 説明
name 結合ポリシーをリストビューで識別できる、わかりやすい名前。
identityGraph.type 結合する関連 ID を取得する ID グラフのタイプ。可能な値:「none」または「pdg」(プライベートグラフ)。
attributeMerge データの競合時にプロファイル属性値に優先順位を付ける方法。
schema 結合ポリシーに関連付けられた XDM スキーマクラス。
isActiveOnEdge この結合ポリシーがエッジでアクティブかどうかを指定します。
default この結合ポリシーがスキーマのデフォルトかどうかを指定します。

詳細は、「結合ポリシーのコンポーネント」の節を参照してください。

応答

正常な応答は、新しく作成された結合ポリシーの詳細を返します。

{
    "id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
    "name": "Loyalty members ordered by ID",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "schema": {
        "name": "_xdm.context.profile"
    },
    "version": 1,
    "identityGraph": {
        "type": "none"
    },
    "attributeMerge": {
        "type": "dataSetPrecedence",
        "order": [
            "5b76f86b85d0e00000be5c8b",
            "5b76f8d787a6af01e2ceda18"
        ]
    },
    "isActiveOnEdge": true,
    "default": true,
    "updateEpoch": 1551898378
}

結合ポリシーを構成する個々の要素の詳細については、このドキュメントの最初にある「結合ポリシーのコンポーネント」の節を参照してください。

結合ポリシーの更新

既存の結合ポリシーを変更するには、個々の属性を編集するか(PATCH)、結合ポリシー全体を新しい属性で上書きします(PUT)。それぞれの例を以下に示します。

個々の結合ポリシーフィールドの編集

/config/mergePolicies/{mergePolicyId} エンドポイントに PATCH リクエストをおこなうことで、結合ポリシーの個々のフィールドを編集できます。

API 形式

PATCH /config/mergePolicies/{mergePolicyId}
パラメーター 説明
{mergePolicyId} 削除する結合ポリシーの識別子。

リクエスト

次のリクエストは、default プロパティの値を true に変更することで、指定した結合ポリシーを更新します。

curl -X PATCH \
  https://platform.adobe.io/data/core/ups/config/mergePolicies/e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2 \
  -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}' \
  -H 'Content-Type: application/json' \
  -d '{
    "op": "add",
    "path": "/default",
    "value": "true"
  }'
プロパティ 説明
op 操作を指定します。その他のパッチ操作の例については、 JSON パッチのドキュメントを参照してください
path 更新するフィールドのパス。指定できる値は「/name」、「/identityGraph.type」、「/attributeMerge.type」、「/schema.name」、「/version」、「/default」です。, "/isActiveOnEdge"
value 指定したフィールドに設定する値。

詳細は、「結合ポリシーのコンポーネント」の節を参照してください。

応答

正常な応答は、新しく更新された結合ポリシーの詳細を返します。

{
    "id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
    "name": "Loyalty members ordered by ID",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "schema": {
        "name": "_xdm.context.profile"
    },
    "version": 1,
    "identityGraph": {
        "type": "none"
    },
    "attributeMerge": {
        "type": "dataSetPrecedence",
        "order": [
            "5b76f86b85d0e00000be5c8b",
            "5b76f8d787a6af01e2ceda18"
        ]
    },
    "isActiveOnEdge": true,
    "default": true,
    "updateEpoch": 1551898378
}

結合ポリシーの上書き

結合ポリシーを変更する別の方法は、結合ポリシー全体を上書きする PUT リクエストを使用することです。

API 形式

PUT /config/mergePolicies/{mergePolicyId}
パラメーター 説明
{mergePolicyId} 上書きする結合ポリシーの識別子。

リクエスト

次のリクエストは、指定された結合ポリシーを上書きし、その属性値をペイロードで提供されたものに置き換えます。このリクエストは既存の結合ポリシーを完全に置き換えるため、最初に結合ポリシーを定義するときに必要だったのと同じフィールドをすべて指定する必要があります。ただし、今回は、変更するフィールドの更新された値を指定します。

curl -X PUT \
  https://platform.adobe.io/data/core/ups/config/mergePolicies/e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2 \
  -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}' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "Loyalty members ordered by ID",
        "imsOrgId": "{ORG_ID}",
        "schema": {
            "name": "_xdm.context.profile"
        },
        "version": 1,
        "identityGraph": {
            "type": "none"
        },
        "attributeMerge": {
            "type": "dataSetPrecedence",
            "order": [
                "5b76f86b85d0e00000be5c8b",
                "5b76f8d787a6af01e2ceda18"
            ]
        },
        "isActiveOnEdge": true,
        "default": true,
        "updateEpoch": 1551898378
    }'
プロパティ 説明
name 結合ポリシーをリストビューで識別できる、わかりやすい名前。
identityGraph 結合する関連 ID を取得する ID グラフ。
attributeMerge データの競合時にプロファイル属性値に優先順位を付ける方法。
schema 結合ポリシーに関連付けられた XDM スキーマクラス。
isActiveOnEdge この結合ポリシーがエッジでアクティブかどうかを指定します。
default この結合ポリシーがスキーマのデフォルトかどうかを指定します。

詳細は、「結合ポリシーのコンポーネント」の節を参照してください。

応答

正常な応答は、更新された結合ポリシーの詳細を返します。

{
    "id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
    "name": "Loyalty members ordered by ID",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "schema": {
        "name": "_xdm.context.profile"
    },
    "version": 1,
    "identityGraph": {
        "type": "none"
    },
    "attributeMerge": {
        "type": "dataSetPrecedence",
        "order": [
            "5b76f86b85d0e00000be5c8b",
            "5b76f8d787a6af01e2ceda18"
        ]
    },
    "isActiveOnEdge": true,
    "default": true,
    "updateEpoch": 1551898378
}

結合ポリシーの削除

結合ポリシーを削除するには、/config/mergePolicies エンドポイントに DELETE リクエストをおこない、削除する結合ポリシーの ID をリクエストパスに含めます。

メモ

結合ポリシーに isActiveOnEdge true に設定すると、結合ポリシーが できません を削除します。 次のいずれかを使用します。 PATCH または PUT エンドポイントを使用して結合ポリシーを更新してから削除してください。

API 形式

DELETE /config/mergePolicies/{mergePolicyId}
パラメーター 説明
{mergePolicyId} 削除する結合ポリシーの識別子。

リクエスト

次のリクエストは、結合ポリシーを削除します。

curl -X DELETE \
  https://platform.adobe.io/data/core/ups/config/mergePolicies/e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2 \
  -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(OK)と空の応答本文が返されます。削除が成功したことを確認するには、GET リクエストを実行して、ID ごとに結合ポリシーを表示します。結合ポリシーが削除されている場合は、HTTP ステータス 404(不検知)エラーが表示されます。

次の手順

組織の結合ポリシーを作成および設定する方法がわかったので、それらを使用して Platform 内の顧客プロファイルの表示を調整し、 Real-time Customer Profile データ。

セグメントの定義と使用を開始するには、Adobe Experience Platform セグメント化サービスのドキュメントを参照してください。

このページ