ポリシーエンドポイント

データ使用ポリシーは、Experience Platform 内のデータに対して実行を許可または制限するマーケティングアクションの種類を記述するルールです。Policy Service API の /policies エンドポイントを使用すると、組織のデータ使用ポリシーをプログラムによって管理できます。

はじめに

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

ポリシーのリストの取得

/policies/core または /policies/custom に対して GET リクエストをおこなうと、すべての core または custom ポリシーをリストできます。

API 形式

GET /policies/core
GET /policies/custom

リクエスト

次のリクエストは、組織で定義されたカスタムポリシーのリストを取得します。

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom \
  -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}'

応答

正常な応答には children 配列が含まれ、id 値など、取得された各ポリシーの詳細がリストされています。特定のポリシーの id フィールドを使用して、そのポリシーの検索更新、および削除リクエストを実行できます。

{
    "_page": {
        "start": "5c6dacdf685a4913dc48937c",
        "count": 2
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io/policies/custom?{?limit,start,property}",
            "templated": true
        }
    },
    "children": [
        {
            "name": "Export Data to Third Party",
            "status": "DRAFT",
            "marketingActionRefs": [
                "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
            ],
            "description": "Conditions under which data cannot be exported to a third party",
            "deny": {
                "operator": "AND",
                "operands": [
                    {
                        "label": "C1"
                    },
                    {
                        "operator": "OR",
                        "operands": [
                            {
                                "label": "C3"
                            },
                            {
                                "label": "C7"
                            }
                        ]
                    }
                ]
            },
            "imsOrg": "{ORG_ID}",
            "created": 1550691551888,
            "createdClient": "{CLIENT_ID}",
            "createdUser": "{USER_ID}",
            "updated": 1550701472910,
            "updatedClient": "{CLIENT_ID}",
            "updatedUser": "{USER_ID}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
                }
            },
            "id": "5c6dacdf685a4913dc48937c"
        },
        {
            "name": "Combine Data",
            "status": "ENABLED",
            "marketingActionRefs": [
                "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/combineData"
            ],
            "description": "Data that meets these conditions cannot be combined.",
            "deny": {
                "operator": "AND",
                "operands": [
                    {
                        "label": "C3"
                    },
                    {
                        "label": "I1"
                    }
                ]
            },
            "imsOrg": "{ORG_ID}",
            "created": 1550703519823,
            "createdClient": "{CLIENT_ID}",
            "createdUser": "{USER_ID}",
            "updated": 1550714340335,
            "updatedClient": "{CLIENT_ID}",
            "updatedUser": "{USER_ID}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6ddb9f5c404513dc2dc454"
                }
            },
            "id": "5c6ddb9f5c404513dc2dc454"
        }
    ]
}
プロパティ 説明
_page.count 取得したポリシーの合計数です。
name ポリシーの表示名です。
status ポリシーの現在のステータスです。DRAFTENABLEDDISABLED の 3 つのステータスが考えられます。デフォルトでは、ENABLED ポリシーのみが評価に使用されます。詳細情報については、ポリシーの評価に関する概要を参照してください。
marketingActionRefs ポリシーに適用されるすべてのマーケティングアクションの URI をリストする配列です。
description ポリシーのユースケースに関する詳細なコンテキストを提供する、オプションの説明です。
deny ポリシーの関連付けられたマーケティングアクションの実行を制限する、特定のデータ使用ラベルを表すオブジェクトです。このプロパティの詳細については、ポリシーの作成の節を参照してください。

ポリシーの検索

GET リクエストのパスに特定のポリシーの id プロパティを含めると、そのポリシーを検索できます。

API 形式

GET /policies/core/{POLICY_ID}
GET /policies/custom/{POLICY_ID}
パラメーター 説明
{POLICY_ID} 検索するポリシーの id です。

リクエスト

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
  -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}'

応答

応答が成功すると、ポリシーの詳細が返されます。

{
    "name": "Export Data to Third Party",
    "status": "DRAFT",
    "marketingActionRefs": [
        "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
    ],
    "description": "Conditions under which data cannot be exported to a third party",
    "deny": {
        "operator": "AND",
        "operands": [
            {
                "label": "C1"
            },
            {
                "operator": "OR",
                "operands": [
                    {
                        "label": "C3"
                    },
                    {
                        "label": "C7"
                    }
                ]
            }
        ]
    },
    "imsOrg": "{ORG_ID}",
    "created": 1550703519823,
    "createdClient": "{CLIENT_ID}",
    "createdUser": "{USER_ID}",
    "updated": 1550714340335,
    "updatedClient": "{CLIENT_ID}",
    "updatedUser": "{USER_ID}",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
        }
    },
    "id": "5c6dacdf685a4913dc48937c"
}
プロパティ 説明
name ポリシーの表示名です。
status ポリシーの現在のステータスです。DRAFTENABLEDDISABLED の 3 つのステータスが考えられます。デフォルトでは、ENABLED ポリシーのみが評価に使用されます。詳細情報については、ポリシーの評価に関する概要を参照してください。
marketingActionRefs ポリシーに適用されるすべてのマーケティングアクションの URI をリストする配列です。
description ポリシーのユースケースに関する詳細なコンテキストを提供する、オプションの説明です。
deny ポリシーの関連付けられたマーケティングアクションの実行を制限する、特定のデータ使用ラベルを表すオブジェクトです。このプロパティの詳細については、ポリシーの作成の節を参照してください。

カスタムポリシーの作成

Policy Service API では、ポリシーは以下によって定義されます。

  • 特定のマーケティングアクションへの参照
  • マーケティングアクションの実行が制限されているデータ使用ラベルを表す式

後者の要件を満たすには、ポリシー定義に、データ使用ラベルの存在に関するブール式を含める必要があります。この式はポリシー式と呼ばれます。

ポリシー式は、各ポリシー定義内で deny プロパティの形式で指定されます。単一のラベルの存在のみをチェックする単純な deny オブジェクトの例は、次のようになります。

"deny": {
    "label": "C1"
}

ただし、多くのポリシーでは、データ使用ラベルの存在に関して、より複雑な条件を指定しています。これらのユースケースをサポートするために、ポリシー式を表すためのブール演算を含めることもできます。ポリシー式オブジェクトには、ラベルまたは演算子およびオペランドのいずれかを含める必要がありますが、両方を含めることはできません。また、各演算値もポリシー式オブジェクトです。

例えば、C1 OR (C3 AND C7) ラベルが存在するデータに対してマーケティングアクションを実行できないようにするポリシーを定義する場合、ポリシーの deny プロパティは次のように指定します。

"deny": {
  "operator": "OR",
  "operands": [
    {"label": "C1"},
    {
      "operator": "AND",
      "operands": [
        {"label": "C3"},
        {"label": "C7"}
      ]
    }
  ]
}
プロパティ 説明
operator 兄弟 operands 配列に指定されたラベル間の条件付き関係を示します。使用できる値は次のとおりです。
  • OR:式は、operands 配列のラベルが存在する場合は true に解決されます。
  • AND:式は、operands 配列のすべてのラベルが存在する場合にのみ true に解決されます。
operands オブジェクトの配列。各オブジェクトは、1 つのラベル、または operator プロパティと operands プロパティの追加ペアを表します。operands 配列内のラベルや操作の存在は、兄弟 operator プロパティの値に基づいて true または false に解決されます。
label ポリシーに適用される単一のデータ使用ラベルの名前です。

/policies/custom エンドポイントに POST リクエストを実行することで、新しいカスタムポリシーを作成できます。

API 形式

POST /policies/custom

リクエスト

次のリクエストは、C1 OR (C3 AND C7) ラベルを含むデータに対するマーケティングアクション exportToThirdParty の実行を制限する新しいポリシーを作成します。

curl -X POST \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "name": "Export Data to Third Party",
        "status": "DRAFT",
        "marketingActionRefs": [
          "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
        ],
        "description": "Conditions under which data cannot be exported to a third party",
        "deny": {
          "operator": "OR",
          "operands": [
            {"label": "C1"},
            {
              "operator": "AND",
              "operands": [
                {"label": "C3"},
                {"label": "C7"}
              ]
            }
          ]
        }
      }'
プロパティ 説明
name ポリシーの表示名です。
status ポリシーの現在のステータスです。DRAFTENABLEDDISABLED の 3 つのステータスが考えられます。デフォルトでは、ENABLED ポリシーのみが評価に使用されます。詳細情報については、ポリシーの評価に関する概要を参照してください。
marketingActionRefs ポリシーに適用されるすべてのマーケティングアクションの URI をリストする配列です。マーケティングアクションの URIは、マーケティングアクションの検索に対する応答として _links.self.href の下に提供されます。
description ポリシーのユースケースに関する詳細なコンテキストを提供する、オプションの説明です。
deny ポリシーの関連付けられたマーケティングアクションの実行が制限されている、特定のデータ使用ラベルを表すポリシー式です。

応答

応答が成功すると、id など、新しく作成されたポリシーの詳細が返されます。この値は読み取り専用で、ポリシーの作成時に自動的に割り当てられます。

{
    "name": "Export Data to Third Party",
    "status": "DRAFT",
    "marketingActionRefs": [
        "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
    ],
    "description": "Conditions under which data cannot be exported to a third party",
    "deny": {
        "operator": "OR",
        "operands": [
            {
                "label": "C1"
            },
            {
                "operator": "AND",
                "operands": [
                    {
                        "label": "C3"
                    },
                    {
                        "label": "C7"
                    }
                ]
            }
        ]
    },
    "imsOrg": "{ORG_ID}",
    "created": 1550691551888,
    "createdClient": "{CLIENT_ID}",
    "createdUser": "{USER_ID}",
    "updated": 1550691551888,
    "updatedClient": "{CLIENT_ID}",
    "updatedUser": "{USER_ID}",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
        }
    },
    "id": "5c6dacdf685a4913dc48937c"
}

カスタムポリシーの更新

重要

更新できるのは、カスタムポリシーのみです。コアポリシーを有効または無効にする場合は、有効なコアポリシーのリストの更新の節を参照してください。

既存のカスタムポリシーを更新するには、更新後のポリシー全体が含まれるペイロードを使用して、ポリシーの ID を PUT リクエストのパスに指定します。つまり、PUT リクエストは基本的にポリシーを書き換えます。

メモ

ポリシーを上書きするのではなく、1 つ以上のフィールドのみを更新する場合は、カスタムポリシーの一部を更新の節を参照してください。

API 形式

PUT /policies/custom/{POLICY_ID}
パラメーター 説明
{POLICY_ID} 更新するポリシーの id

リクエスト

この例では、データをサードパーティにエクスポートするための条件が変更されたため、C1 AND C5 データラベルが存在する場合にこのマーケティングアクションを拒否する、作成済みのポリシーが必要です。

次のリクエストは、既存のポリシーを更新して新しいポリシー式を含めます。このリクエストは基本的にポリシーを書き換えるので、値の一部が更新されない場合でも、すべてのフィールドをペイロードに含める必要があります。

curl -X PUT \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "name": "Export Data to Third Party",
        "status": "DRAFT",
        "marketingActionRefs": [
          "../marketingActions/custom/exportToThirdParty"
        ],
        "description": "Conditions under which data cannot be exported to a third party",
        "deny": {
          "operator": "AND",
          "operands": [
            {"label": "C1"},
            {"label": "C5"}
          ]
        }
      }'
プロパティ 説明
name ポリシーの表示名です。
status ポリシーの現在のステータスです。DRAFTENABLEDDISABLED の 3 つのステータスが考えられます。デフォルトでは、ENABLED ポリシーのみが評価に使用されます。詳細情報については、ポリシーの評価に関する概要を参照してください。
marketingActionRefs ポリシーに適用されるすべてのマーケティングアクションの URI をリストする配列です。マーケティングアクションの URIは、マーケティングアクションの検索に対する応答として _links.self.href の下に提供されます。
description ポリシーのユースケースに関する詳細なコンテキストを提供する、オプションの説明です。
deny ポリシーの関連付けられたマーケティングアクションの実行が制限されている、特定のデータ使用ラベルを表すポリシー式です。このプロパティの詳細については、ポリシーの作成の節を参照してください。

応答

応答が成功すると、更新されたポリシーの詳細が返されます。

{
    "name": "Export Data to Third Party",
    "status": "DRAFT",
    "marketingActionRefs": [
        "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/core/exportToThirdParty"
    ],
    "description": "Conditions under which data cannot be exported to a third party",
    "deny": {
        "operator": "AND",
        "operands": [
            {
                "label": "C1"
            },
            {
                "label": "C5"
            }
        ]
    },
    "imsOrg": "{ORG_ID}",
    "created": 1550691551888,
    "createdClient": "{CLIENT_ID}",
    "createdUser": "{USER_ID}",
    "updated": 1550701472910,
    "updatedClient": "{CLIENT_ID}",
    "updatedUser": "{USER_ID}",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
        }
    },
    "id": "5c6dacdf685a4913dc48937c"
}

カスタムポリシーの一部を更新

重要

更新できるのは、カスタムポリシーのみです。コアポリシーを有効または無効にする場合は、有効なコアポリシーのリストの更新の節を参照してください。

ポリシーの特定の部分を更新するには、PATCH リクエストを使用します。ポリシーを書き換える PUT リクエストとは異なり、PATCH リクエストでは、リクエスト本文で指定したプロパティのみが更新されます。適切なプロパティ(/status)とその値(ENABLED または DISABLED)へのパスを指定するだけで済むので、ポリシーを有効化または無効化する場合に特に便利です。

メモ

PATCH リクエストのペイロードは、JSON パッチの形式に従います。使用可能な構文の詳細については、API の基本原則のガイドを参照してください。

Policy Service API は、JSON パッチ操作 addremovereplace をサポートし、以下の例に示すように、複数の更新を 1 回の呼び出しに統合することができます。

API 形式

PATCH /policies/custom/{POLICY_ID}
パラメーター 説明
{POLICY_ID} プロパティを更新するポリシーの id

リクエスト

次のリクエストは、2 つの replace 操作を使用して、ポリシーのステータスを DRAFT から ENABLED に変更し、description フィールドを新しい説明で更新します。

重要

1 回のリクエストで複数の PATCH 操作を送信すると、配列に表示される順に処理されます。必要に応じて、リクエストを正しい順序で送信していることを確認します。

curl -X PATCH \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d ' [
          {
            "op": "replace",
            "path": "/status",
            "value": "ENABLED"
          },
          {
            "op": "replace",
            "path": "/description",
            "value": "New policy description."
          }
        ]'

応答

応答が成功すると、更新されたポリシーの詳細が返されます。

{
    "name": "Export Data to Third Party",
    "status": "ENABLED",
    "marketingActionRefs": [
        "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
    ],
    "description": "New policy description.",
    "deny": {
        "operator": "AND",
        "operands": [
            {
                "label": "C1"
            },
            {
                "operator": "OR",
                "operands": [
                    {
                        "label": "C3"
                    },
                    {
                        "label": "C7"
                    }
                ]
            }
        ]
    },
    "imsOrg": "{ORG_ID}",
    "created": 1550703519823,
    "createdClient": "{CLIENT_ID}",
    "createdUser": "{USER_ID}",
    "updated": 1550712163182,
    "updatedClient": "{CLIENT_ID}",
    "updatedUser": "{USER_ID}",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
        }
    },
    "id": "5c6dacdf685a4913dc48937c"
}

カスタムポリシーの削除

DELETE リクエストのパスに id を含めることで、カスタムポリシーを削除できます。

警告

削除したポリシーは復元できません。最初に参照(GET)リクエストを実行してポリシーを表示し、それが削除するポリシーであるかどうかを確認することをお勧めします。

API 形式

DELETE /policies/custom/{POLICY_ID}
パラメーター 説明
{POLICY_ID} 削除するポリシーの ID。

リクエスト

curl -X DELETE \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6ddb56eb60ca13dbf8b9a8 \
  -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)をもう一度試みます。ポリシーが正常に削除された場合は、HTTP 404 (見つかりません)エラーが表示されます。

有効なコアポリシーのリストを取得

デフォルトでは、有効なデータ使用ポリシーのみが評価に使用されます。/enabledCorePolicies エンドポイントに GET リクエストをおこなうことで、組織で現在有効になっているコアポリシーのリストを取得できます。

API 形式

GET /enabledCorePolicies

リクエスト

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/enabledCorePolicies \
  -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}'

応答

応答が成功すると、policyIds 配列の下に有効なコアポリシーのリストが返されます。

{
  "policyIds": [
    "corepolicy_0001",
    "corepolicy_0002",
    "corepolicy_0003",
    "corepolicy_0004",
    "corepolicy_0005",
    "corepolicy_0006",
    "corepolicy_0007",
    "corepolicy_0008"
  ],
  "imsOrg": "{ORG_ID}",
  "created": 1529696681413,
  "createdClient": "{CLIENT_ID}",
  "createdUser": "{USER_ID}",
  "updated": 1529697651972,
  "updatedClient": "{CLIENT_ID}",
  "updatedUser": "{USER_ID}",
  "_links": {
    "self": {
      "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
    }
  }
}

有効なコアポリシーのリストの更新

デフォルトでは、有効なデータ使用ポリシーのみが評価に使用されます。/enabledCorePolicies エンドポイントに PUT リクエストを送信すると、1 回の呼び出しで、組織で有効になっているコアポリシーのリストを更新できます。

メモ

このエンドポイントで有効または無効にできるのは、コアポリシーのみです。カスタムポリシーを有効または無効にする方法については、ポリシーの一部の更新の節を参照してください。

API 形式

PUT /enabledCorePolicies

リクエスト

次のリクエストは、ペイロードで指定された ID に基づいて、有効なコアポリシーのリストを更新します。

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/enabledCorePolicies \
  -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 '{
        "policyIds": [
          "corepolicy_0001",
          "corepolicy_0002",
          "corepolicy_0007",
          "corepolicy_0008"
        ]
      }'
プロパティ 説明
policyIds 有効にするコアポリシー ID のリストです。リストに含まれないコアポリシーは DISABLED ステータスに設定され、評価には使用されません。

応答

応答が成功すると、有効なコアポリシーの更新リストが policyIds 配列の下に返されます。

{
  "policyIds": [
    "corepolicy_0001",
    "corepolicy_0002",
    "corepolicy_0007",
    "corepolicy_0008"
  ],
  "imsOrg": "{ORG_ID}",
  "created": 1529696681413,
  "createdClient": "{CLIENT_ID}",
  "createdUser": "{USER_ID}",
  "updated": 1595876052649,
  "updatedClient": "{CLIENT_ID}",
  "updatedUser": "{USER_ID}",
  "_links": {
    "self": {
      "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
    }
  }
}

次の手順

新しいポリシーを定義するか、既存のポリシーを更新したら、Policy Service API を使用して、特定のラベルやデータセットに対するマーケティングアクションをテストし、想定どおりにポリシーで違反が発生しているかどうかを確認できます。詳しくは、ポリシー評価エンドポイントに関するガイドを参照してください。

このページ