Show Menu
トピック×

ポリシーエンドポイント

Data usage policies are rules that describe the kinds of marketing actions that you are allowed to, or restricted from, performing on data within Experience Platform. の /policies エンドポイント Policy Service API を使用すると、組織のデータ使用ポリシーをプログラムで管理できます。

はじめに

The API endpoint used in this guide is part of the Policy Service API . 先に進む前に、 はじめに Experience Platform 、関連ドキュメントへのリンク、このドキュメントのサンプルAPI呼び出しを読むためのガイド、APIの呼び出しを正常に行うために必要なヘッダーに関する重要な情報を確認してください。

Retrieve a list of policies

すべてのまたは core ポリシーをリストするには、それぞれに対してGETリクエストを行う custom か、ポリシーをリクエスト /policies/core /policies/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: {IMS_ORG}' \
  -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": "{IMS_ORG}",
            "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": "{IMS_ORG}",
            "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
ポリシーの現在のステータス。 次の3つのステータスが考えられます。 DRAFT ENABLED または DISABLED 。 By default, only ENABLED policies participate in evaluation. 詳しくは、 ポリシー評価の概要 を参照してください。
marketingActionRefs
ポリシーに適用されるすべてのマーケティングアクションのURIをリストする配列。
description
ポリシーの使用例に関する詳細なコンテキストを提供する、オプションの説明です。
deny
ポリシーに関連付けられたマーケティングアクションが実行されるのを制限する、特定のデータ使用ラベルを表すオブジェクトです。 このプロパティの詳細については、「ポリシーの 作成 」の節を参照してください。

ポリシーの検索

GET要求のパスにそのポリシーのプロパティを含めると、特定のポリシーを検索できます。 id
API 形式
GET /policies/core/{POLICY_ID}
GET /policies/custom/{POLICY_ID}

パラメーター
説明
{POLICY_ID}
The id of the policy you want to look up.
リクエスト
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: {IMS_ORG}' \
  -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": "{IMS_ORG}",
    "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
ポリシーの現在のステータス。 次の3つのステータスが考えられます。 DRAFT ENABLED または DISABLED 。 By default, only ENABLED policies participate in evaluation. 詳しくは、 ポリシー評価の概要 を参照してください。
marketingActionRefs
ポリシーに適用されるすべてのマーケティングアクションのURIをリストする配列です。
description
ポリシーの使用例に関する詳細なコンテキストを提供する、オプションの説明です。
deny
ポリシーに関連付けられたマーケティングアクションが実行されるのを制限する、特定のデータ使用ラベルを表すオブジェクトです。 このプロパティの詳細については、「ポリシーの 作成 」の節を参照してください。

Create a custom policy

この 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
ポリシーに適用される単一のデータ使用ラベルの名前です。
You can create a new custom policy by making a POST request to the /policies/custom endpoint.
API 形式
POST /policies/custom

リクエスト
次のリクエストは、ラベルを含むデータに対するマーケティング操作の実行を制限する新しいポリシー exportToThirdParty を作成 C1 OR (C3 AND C7) します。
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: {IMS_ORG}' \
  -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
ポリシーの現在のステータス。 次の3つのステータスが考えられます。 DRAFT ENABLED または DISABLED 。 By default, only ENABLED policies participate in evaluation. 詳しくは、 ポリシー評価の概要 を参照してください。
marketingActionRefs
ポリシーに適用されるすべてのマーケティングアクションのURIをリストする配列です。 マーケティングアクションのURIは、マーケティングアクション _links.self.href 検索するための応答の下に提供されます
description
ポリシーの使用例に関する詳細なコンテキストを提供する、オプションの説明です。
deny
ポリシーに関連付けられたマーケティングアクションの実行が制限されている特定のデータ使用ラベルを説明するポリシー式です。
応答  
A successful response returns the details of the newly created policy, including its 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": "{IMS_ORG}",
    "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"
}

カスタムポリシーの更新

更新できるのは、カスタムポリシーのみです。 コアポリシーを有効または無効にする場合は、有効になっているコアポリシーのリストの 更新に関する節を参照してください
既存のカスタムポリシーを更新するには、ポリシーの更新された形式全体を含むペイロードを、PUTリクエストのパスに指定します。 つまり、PUTリクエストは基本的にポリシーを 書き換えます
カスタムポリシーの一部を上書きするのではなく、ポリシーの1つ以上のフィールドのみを更新する場合は Update a portion of a custom policy 、カスタムポリシーの一部の更新に関するセクションを参照してください。
API 形式
PUT /policies/custom/{POLICY_ID}

パラメーター
説明
{POLICY_ID}
The id of the policy you want to update.
リクエスト
この例では、データをサードパーティにエクスポートするための条件が変更されたため、 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: {IMS_ORG}' \
  -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
ポリシーの現在のステータス。 次の3つのステータスが考えられます。 DRAFT ENABLED または DISABLED 。 By default, only ENABLED policies participate in evaluation. 詳しくは、 ポリシー評価の概要 を参照してください。
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": "{IMS_ORG}",
    "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"
}

Update a portion of a custom policy

更新できるのは、カスタムポリシーのみです。 コアポリシーを有効または無効にする場合は、有効になっているコアポリシーのリストの 更新に関する節を参照してください
ポリシーの特定の部分を更新するには、PATCH リクエストを使用します。ポリシーを書き換えるPUT要求とは異なり、PATCH要求では、要求本文で指定されたプロパティのみが更新されます。 これは、適切なプロパティ( /status )とその値(または ENABLED DISABLED )へのパスを指定するだけで済むので、ポリシーを有効または無効にする場合に特に便利です。
PATCH要求のペイロードは、JSONパッチの形式に従います。 受け入れられる構文の詳細については、 APIの基本的なガイド を参照してください。
この Policy Service APIは、JSONパッチの操作 add remove およびをサポートし replace 、以下の例に示すように、複数の更新を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: {IMS_ORG}' \
  -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": "{IMS_ORG}",
    "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"
}

カスタムポリシーの削除

You can delete a custom policy by including its id in the path of a DELETE request.
削除したポリシーは復元できません。It is best practice to perform a lookup (GET) request first to view the policy and confirm it is the correct policy you wish to remove.
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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答  
応答が成功すると、HTTPステータス200(OK)が空白の本文で返されます。
ポリシーを再度参照(GET)すると、削除を確認できます。 ポリシーが正常に削除された場合は、HTTP 404 (見つかりません)エラーが表示されます。

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

デフォルトでは、有効なデータ使用ポリシーのみが評価に関与します。 エンドポイントにGETリクエストを行うことで、組織で現在有効になっているコアポリシーのリストを取得でき /enabledCorePolicies ます。
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: {IMS_ORG}' \
  -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": "{IMS_ORG}",
  "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"
    }
  }
}

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

デフォルトでは、有効なデータ使用ポリシーのみが評価に関与します。 エンドポイントにPUTリクエストを行うと、1回の呼び出しで、組織で有効になっているコアポリシーのリストを更新でき /enabledCorePolicies ます。
このエンドポイントで有効または無効にできるのは、コアポリシーのみです。 カスタムポリシーを有効または無効にするには、ポリシーの一部の 更新に関する節を参照してください
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: {IMS_ORG}' \
  -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": "{IMS_ORG}",
  "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を使用して、特定のラベルやデータセットに対するマーケティングアクションをテストし、ポリシーで期待どおりの違反が発生しているかどうかを確認できます。 詳しくは、 ポリシー評価エンドポイントのガイドを参照してください