マーケティングアクションエンドポイント

マーケティングアクションは、(Adobe Experience Platform データガバナンスのコンテキストでは)Experience Platform データ利用者が実行するアクションを表し、データ使用ポリシーの違反をチェックする必要があります。

Policy Service API の /marketingActions エンドポイントを使用して、組織のマーケティングアクションを管理できます。

はじめに

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

マーケティングアクションのリストの取得

コアマーケティングアクションとカスタムマーケティングアクションのリストは、/marketingActions/core/marketingActions/custom のそれぞれに GET リクエストをおこなうことで取得できます。

API 形式

GET /marketingActions/core
GET /marketingActions/custom

リクエスト

次のリクエストは、組織が管理するカスタムマーケティングアクションのリストを取得します。

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

応答

応答が成功すると、取得した各マーケティングアクションの詳細(namehref を含む)が返されます。href 値は、データ使用ポリシーを作成する際のマーケティングアクションの識別に使用されます。

{
    "_page": {
        "count": 2
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io/marketingActions/custom?{?limit,start,property}",
            "templated": true
        }
    },
    "children": [
        {
            "name": "sampleMarketingAction",
            "description": "Marketing Action description.",
            "imsOrg": "{IMS_ORG}",
            "created": 1550714012088,
            "createdClient": "string",
            "createdUser": "string",
            "updated": 1550714012088,
            "updatedClient": "string",
            "updatedUser": "string",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/sampleMarketingAction"
                }
            }
        },
        {
            "name": "newMarketingAction",
            "description": "Another marketing action.",
            "imsOrg": "{IMS_ORG}",
            "created": 1550793833224,
            "createdClient": "string",
            "createdUser": "string",
            "updated": 1550793833224,
            "updatedClient": "string",
            "updatedUser": "string",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/newMarketingAction"
                }
            }
        }
    ]
}
プロパティ 説明
_page.count 返されたマーケティングアクションの合計数。
children 取得したマーケティングアクションの詳細を含むオブジェクトの配列。
name マーケティングアクションの名前。特定のマーケティングアクションを検索する際に一意の ID として機能します。
_links.self.href マーケティングアクションの URI 参照。データ使用ポリシーを作成する際に marketingActionsRefs 配列を完了するのに使用できます。

特定のマーケティングアクションの検索

GET リクエストのパスにマーケティングアクションの name プロパティを含めて、特定のマーケティングアクションの詳細を調べます。

API 形式

GET /marketingActions/core/{MARKETING_ACTION_NAME}
GET /marketingActions/custom/{MARKETING_ACTION_NAME}
パラメーター 説明
{MARKETING_ACTION_NAME} 検索するマーケティングアクションの name プロパティ。

リクエスト

次のリクエストは、combineData という名前のカスタムマーケティングアクションを取得します。

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

応答

応答オブジェクトには、マーケティングアクションの詳細が含まれています。これには、データ使用ポリシーを定義する際にマーケティングアクションの参照(marketingActionsRefs)に必要なパス(_links.self.href)が含まれます。

{
    "name": "combineData",
    "description": "Combine multiple data sources together.",
    "imsOrg": "{IMS_ORG}",
    "created": 1550793805590,
    "createdClient": "string",
    "createdUser": "string",
    "updated": 1550793805590,
    "updatedClient": "string",
    "updatedUser": "string",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/combineData"
        }
    }
}

カスタムマーケティングアクションの作成または更新

PUT リクエストのパスにマーケティングアクションの既存の名前または目的の名前を含めることで、新しいカスタムマーケティングアクションを作成したり、既存のマーケティングアクションを更新したりできます。

API 形式

PUT /marketingActions/custom/{MARKETING_ACTION_NAME}
パラメーター 説明
{MARKETING_ACTION_NAME} 作成または更新するマーケティングアクションの名前。指定した名前のマーケティングアクションがシステム内に既に存在する場合は、そのマーケティングアクションが更新されます。存在しない場合は、指定した名前に対して新しいマーケティングアクションが作成されます。

リクエスト

次のリクエストは、同じ名前のマーケティングアクションがシステムにまだ存在しない場合に、crossSiteTargeting という名前の新しいマーケティングアクションを作成します。crossSiteTargeting マーケティングアクションが存在する場合は、この呼び出しによって、ペイロードに指定されたプロパティに基づいてそのマーケティングアクションが更新されます。

curl -X PUT \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting \
  -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}' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "crossSiteTargeting",
        "description": "Perform targeting on information obtained across multiple web sites."
      }'
プロパティ 説明
name 作成または更新するマーケティングアクションの名前。

重要:このプロパティはパスの {MARKETING_ACTION_NAME} と一致する必要があります。一致しない場合は、HTTP 400(無効なリクエスト)エラーが発生します。つまり、マーケティングアクションを作成した後で、その name プロパティを変更することはできません。
description マーケティングアクションの詳細なコンテキストを提供する説明(オプション)。

応答

成功した応答は、マーケティングアクションの詳細を返します。既存のマーケティングアクションが更新された場合、応答は HTTP ステータス 200(OK)を返します。新しいマーケティングアクションが作成された場合、応答は HTTP ステータス 201(作成済み)を返します。

{
    "name": "crossSiteTargeting",
    "description": "Perform targeting on information obtained across multiple web sites.",
    "imsOrg": "{IMS_ORG}",
    "created": 1550713341915,
    "createdClient": "string",
    "createdUser": "string",
    "updated": 1550713856390,
    "updatedClient": "string",
    "updatedUser": "string",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting"
        }
    }
}

カスタムマーケティングアクションの削除

カスタムマーケティングアクションを削除するには、DELETE リクエストのパスにその名前を含めます。

メモ

既存のポリシーで参照されているマーケティングアクションは削除できません。これらのマーケティングアクションの 1 つを削除しようとすると、HTTP 400(無効なリクエスト)エラーと、マーケティングアクションを参照するすべてのポリシーの ID を含むメッセージが表示されます。

API 形式

DELETE /marketingActions/custom/{MARKETING_ACTION_NAME}
パラメーター 説明
{MARKETING_ACTION_NAME} 削除するマーケティングアクションの名前。

リクエスト

curl -X DELETE \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting \
  -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)を返します。

マーケティングアクションを検索することで、削除を確認できます。マーケティングアクションがシステムから削除された場合は、HTTP 404 (見つかりません)エラーが返されます。

このページ