Models API の概要

ブロックリストに加える Models API （Create API とも呼ばれる）を使用すると、Automated Personalization （AP）と Auto-Target （AT）アクティビティの機械学習モデルで使用する機能のリストを表示および管理できます。 モデルが AP または AT アクティビティに使用する機能を除外する場合は、Models API を使用して、その機能を「ブロックリスト」に追加できます。

blocklist は、Adobe Target によって機械学習モデルから除外される一連の機能を定義します。 機能について詳しくは、 機械学習アルゴリズムで使用されるデータ Target 参照してください。

ブロックリストは、アクティビティ（アクティビティレベル）ごとに定義することも、Target アカウント内のすべてのアクティビティ（グローバルレベル）に対して定義することもできます。

モデル API の仕様

Models API の仕様を こちらで確認します。

前提条件

Models API を使用する場合、{Target Admin API🔗 を使用する場合と同様に、{0Adobe Developer Console を使用して認証を設定する必要があります。 詳しくは、 認証の設定方法を参照してください。

Models API 使用ガイドライン

ブロックリストの管理方法

手順 1: アクティビティの機能のリストを表示する

手順 2: アクティビティのブロックリストを確認する

手順 3: アクティビティのブロックリストに機能を追加する*

手順 4: （オプション）ブロック解除

手順 5: （オプション）グローバルブロックリストの管理

手順 1：アクティビティの機能のリストの表示 step1

機能をブロックリストに加えるする前に、そのアクティビティのモデルに現在含まれている機能のリストを表示します。

GET https://mc.adobe.io/<tenant>/target/models/features/<campaignId>

{
    "features": [
        {
            "externalName": "Visitor Profile - Total Visits to Activity",
            "internalName": "SES_PREVIOUS_VISIT_COUNT",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Total Visits",
            "internalName": "SES_TOTAL_SESSIONS",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Pages Seen Before Activity",
            "internalName": "SES_PREVIOUS_VISIT_COUNT",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Activity Lifetime Time on Site",
            "internalName": "SES_TOTAL_TIME",
            "type": "CONTINUOUS"
        }
    ],
    "reportParameters": {
        "clientCode": <tenant>,
        "campaignId": <campaignId>
    }
}

ここに示す例では、アクティビティ ID が 260840 のアクティビティについて、モデルで使用されている機能のリストを確認しています。

externalName は、機能のわかりやすい名前です。 Target によって作成され、この値は時間の経過と共に変化する可能性があります。 ユーザーは、Personalization Insights レポートでこれらの名前をわかりやすく表示できます。

internalName は、機能の実際の識別子です。 Target によっても作成されますが、変更することはできません。 この値を参照して、ブロックリストに加えるする機能を特定する必要があります。

機能リストに値を入力するには（つまり、null 以外にするには）、アクティビティに注意してください。

手順 2：アクティビティのブロックリストを確認する step2

次に、ブロックリストを表示します。 つまり、現在このアクティビティのモデルに含まれないようにブロックされている機能（ある場合）を確認します。

GET https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

次に示す例では、アクティビティ ID が 260840 のアクティビティについて、ブロックされる機能のリストを確認しています。 結果は空です。つまり、このアクティビティには現在、ブロックリストに加える機能がありません。

手順 3：アクティビティのブロックリストに機能を追加する step3

ブロックリストに機能を追加するには、リクエストをGETからPUTに変更し、リクエストの本文を必要に応じて blockedFeatureSources または blockedFeatures を指定します。

機能の元の場所 blockedFeatureSources 示されることに注意してください。 ブロックリストへの登録の目的では、機能のグループまたはカテゴリとして機能し、機能のセット全体を一度にブロックできます。 blockedFeatureSources の値は、機能の識別子の最初の文字（blockedFeatures または internalName の値）に一致するので、「機能プレフィックス」と見なすこともできます。

blockedFeatureSources 値テーブル table

PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

{
    "blockedFeatureSources": ["AAM"],
    "blockedFeatures": ["SES_PREVIOUS_VISIT_COUNT", "SES_TOTAL_SESSIONS"]
}

{
    "blockedFeatures": [
            "SES_PREVIOUS_VISIT_COUNT",
            "SES_TOTAL_SESSIONS"
        ],
    "blockedFeatureSources": [
            "AAM"
        ]
}

この例では、ユーザーは SES_PREVIOUS_VISIT_COUNT と SES_TOTAL_SESSIONS の 2 つの機能をブロックしています。これは、手順 1🔗 で説明したように、アクティビティ ID が 260480 のアクティビティの機能の完全なリストをクエリすることで、以前に識別されました。 また、前述の 表で説明されているように、「AAM」のプレフィックスで機能をブロックすることで達成される、Experience Cloudセグメントからのすべての機能もブロックします。

機能をブロックリストに加えるした後で、 手順 2 （GET ブロックリストに加える）を再度実行して、更新されたブロックリストを検証することをお勧めします。 結果が期待どおりに表示されることを確認します（結果に、最新のPUTリクエストから追加された機能が含まれていることを確認します）。

手順 4:（任意）ブロック解除 step4

すべてのブロックリストに加える集合体のブロックを解除するには、blockedFeatureSources または blockedFeatures の値を消去します。

PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

{
    "blockedFeatureSources": [],
    "blockedFeatures": []
}

{
    "blockedFeatures": [],
    "blockedFeatureSources": []
}

次の例では、アクティビティ ID が 260840 のアクティビティについて、ブロックリストがクリアされています。 応答では、ブロックされた機能とそのソース（それぞれ blockedFeatureSources と blockedFeatures）の両方で空の配列が確認されることに注意してください。

いつものように、ブロックリストを修正した後で、もう一度 手順 2 を実行することをお勧めします（リストを検証するためのGETブロックリストに加えるは、期待どおりに機能が含まれています）。 ここに示す例では、ユーザーは自分のブロックリストが空であることを確認しています。

質問：ブロックリストのすべてではなく、一部を削除するにはどうすればよいですか？

回答：マルチフィーチャーブロックリストに加えるからブロックリストに加えるされた機能のサブセットを個別に削除するには、 リクエストでブロックしたい機能の更新リストを送信するだけで、全ブロックリストブロックリストに加えるをクリアして必要な機能を追加し直すことはできなくなります。 つまり、更新した機能リストを送信し（ 手順 3 を参照）、「削除」する機能は必ずブロックリストから除外します。

手順 5:（オプション）グローバルブロックリストの管理 step5

上記の例はすべて、1 つのアクティビティのコンテキストに含まれていました。 各アクティビティにブロックリストを個別に指定する代わりに、特定のクライアント（テナント）にわたるすべてのアクティビティの機能をブロックすることもできます。 グローバルブロックリストを実行するには、blockList/<campaignId> の代わりに /blockList/global 呼び出しを使用します。

PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/global

{
    "blockedFeatureSources": ["AAM", "PRO", "ENV"],
    "blockedFeatures": ["AAM_FEATURE_1", "AAM_FEATURE_2"]
}

{
    "blockedFeatures": [
        "AAM_FEATURE_1",
        "AAM_FEATURE_2"
    ],
    "blockedFeatureSources": [
        "AAM",
        "PRO",
        "ENV"
    ]
}

上記のリクエストのサンプルでは、ユーザーが Target アカウント内のすべてのアクティビティで「AAM_FEATURE_1」と「AAM_FEATURE_2」という 2 つの機能をブロックしています。 つまり、アクティビティに関係なく、このアカウントの機械学習モデルには「AAM_FEATURE_1」と「AAM_FEATURE_2」は含まれません。 さらに、ユーザーは、プレフィックスが「AAM」、「PRO」または「ENV」のすべての機能をグローバルにブロックしています。

質問：上記のコードサンプルは冗長ではありませんか？

回答：はい。 「AAM」で始まる値を持つ機能をブロックし、ソースが「AAM」のすべての機能をブロックすることは冗長です。 最終的には、AAM（Experience Cloudセグメント）をソースとするすべての機能がブロックされます。 したがって、Experience Cloudセグメントからすべての機能をブロックすることを目的とする場合、上記の例では、「AAM」で始まる特定の機能を個別に指定する必要はありません。

最終手順：アクティビティレベルでもグローバルレベルでも、変更後にブロックリストを検証し、期待する値が含まれていることを確認することをお勧めします。 これを行うには、PUT を GET に変更します。

以下に示すサンプル応答では、2 つの個別の機能に加え、「AAM」、「PRO」および「ENV」から取得され Target すべての機能がブロックされています。