模型API概述

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：

创建对象：

undefined

模型API(也称为阻止列表API)使用户能够查看和管理机器学习模型中用于Automated Personalization (AP)和Auto-Target (AT)活动的功能的列表。列入阻止列表如果用户希望排除模型用于AP或AT活动的功能，可以使用模型API将该功能添加到“”中。

blocklist 定义将由Adobe Target从其机器学习模型中排除的功能集。有关功能的详细信息，请参阅机器学习算法 Target 使用的数据。

可以按活动（活动级别）定义阻止列表，也可以为Target帐户内的所有活动（全局级别）定义活动。

模型API规范

在此处查看模型API规范。

先决条件

要使用模型API，必须使用Adobe Developer Console配置身份验证，就像使用Target管理员API一样。有关详细信息，请参阅如何配置身份验证。

模型API使用指南

如何管理阻止列表

步骤1： 查看活动的功能列表

步骤2： 检查活动的阻止列表

步骤3： 将功能添加到活动的阻止列表

步骤4：（可选）取消阻止

列入阻止列表 步骤5：（可选）管理全局

步骤1：查看活动的功能列表 step1

在列入阻止列表特征之前，查看当前包含在该活动模型中的特征列表。

请求

code language-json line-numbers
`GET https://mc.adobe.io/<tenant>/target/models/features/<campaignId>`

响应

code language-json line-numbers

code language-json line-numbers
{ "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> } }

{
    "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的活动在模型中使用的功能列表。

步骤 1

NOTE

要查找您活动的活动ID，请导航到Target UI中的活动列表。单击感兴趣的活动。活动ID将显示在生成的活动概述页面的正文中，以及此页面URL的末尾。

externalName 是某个功能的用户友好名称。它由Target创建，此值可能会随着时间的推移而改变。用户可以在Personalization Insights报表中查看这些用户友好的名称。

internalName 是功能的实际标识符。它也是由Target创建的，但无法更改。为了确定要阻止列表的特征，需要参照此值。

请注意，为了使功能列表填入值（即，为了使其非空），活动：

必须具有状态= Live，或者之前必须已激活
必须运行足够长的时间才能存在促销活动，以便模型具有要运行的数据。

步骤2：检查活动的阻止列表 step2

接下来，查看阻止列表。换言之，检查当前阻止将哪些功能（如果有）包含在此活动的模型中。

ERROR

请注意，/blockList/在请求中区分大小写。

请求

code language-json line-numbers
`GET https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>`

响应

code language-json line-numbers

在此处显示的示例中，用户正在检查其活动ID为260840的活动所阻止的功能列表。列入阻止列表结果为空，这意味着此活动当前没有任何功能。

步骤 2

NOTE

第一次检查完整阻止列表时，您可能会看到类似这样的空白结果，然后再向其中添加任何功能。但是，一旦从阻止列表列入阻止列表中添加（随后移除）特征，您可能会看到稍有不同的结果，其中返回空的特征数组。请继续阅读，以在步骤4中查看此示例。

步骤3：将功能添加到活动的阻止列表 step3

若要向PUT添加功能，请将请求从GET更改为阻止列表，并修改请求正文以根据需要指定blockedFeatureSources或blockedFeatures。

请求正文需要blockedFeatures或blockedFeatureSources。两者均可包括在内。
使用从internalName中标识的值填充blockedFeatures。请参阅步骤1。
使用下表中的值填充blockedFeatureSources。

请注意，blockedFeatureSources指示某个功能来自何处。为了进行列入阻止列表，它们用作功能组或功能类别，使用户能够一次阻止整个功能集。 blockedFeatureSources的值匹配功能标识符的第一个字符（blockedFeatures或internalName值）；因此它们也可能被视为“功能前缀”。

`blockedFeatureSources`值的表 table

前缀

描述

BOX

Mbox 参数

URL

自定义 — URL参数

环境

SES

访客个人资料

地域

地理位置

PRO

自定义 — 配置文件

SEG

自定义 — 报表区段

AAM

自定义 — Experience Cloud区段

暴徒

移动设备

CRS

自定义 — 客户属性

UPA

自定义 — RT-CDP配置文件属性

IAC

访客兴趣区域

请求

code language-json line-numbers
`PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId> { "blockedFeatureSources": ["AAM"], "blockedFeatures": ["SES_PREVIOUS_VISIT_COUNT", "SES_TOTAL_SESSIONS"] }`

响应

code language-json line-numbers
`{ "blockedFeatures": [ "SES_PREVIOUS_VISIT_COUNT", "SES_TOTAL_SESSIONS" ], "blockedFeatureSources": [ "AAM" ] }`

在此显示的示例中，用户阻止了SES_PREVIOUS_VISIT_COUNT和SES_TOTAL_SESSIONS这两项功能，他们之前通过查询活动ID为260480的活动完整功能列表来识别这些功能，如步骤1中所述。他们还阻止来自Experience Cloud区段的所有功能，这是通过阻止前缀为“AAM”的功能来实现的，如上面表中所述。

步骤 3

请注意，在列入阻止列表列入阻止列表功能后，建议您再次执行步骤2(GET列入阻止列表)来验证更新的。验证结果是否按预期显示(验证结果是否包含从最新PUT请求添加的功能)。

步骤4：（可选）取消阻止 step4

列入阻止列表要取消阻止所有的功能，请清除blockedFeatureSources或blockedFeatures中的值。

请求

code language-json line-numbers
`PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId> { "blockedFeatureSources": [], "blockedFeatures": [] }`

响应

code language-json line-numbers
`{ "blockedFeatures": [], "blockedFeatureSources": [] }`

列入阻止列表在此处的示例中，用户正在清除其Activity ID为260840的活动的。请注意，响应会确认被阻止的功能及其源（分别为blockedFeatureSources和blockedFeatures）的空数组。

步骤 4

列入阻止列表与往常一样，修改列表后，建议您再次执行步骤2(GET列入阻止列表列表以验证是否按预期包含功能)。在此处的示例中，用户正在验证其阻止列表现在是否为空。

步骤4b

问题：如何删除部分（但不是全部）阻止列表？

回答：要从多功能列入阻止列表列入阻止列表列入阻止列表列入阻止列表中移除功能的离散子集，用户只需在请求中发送要阻止的更新功能列表即可，而不是清除整个请求并重新添加所需功能。列入阻止列表换句话说，发送更新的功能列表（如步骤3中所示），确保从中排除您希望“删除”的功能。

步骤5：（可选）管理全局阻止列表 step5

以上示例均在单个活动的上下文中。列入阻止列表您还可以阻止整个给定客户端（租户）上所有活动的功能，而不必为每个活动单独指定。要执行全局阻止列表，请使用/blockList/global调用，而不是blockList/<campaignId>。

请求

code language-json line-numbers
`PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/global { "blockedFeatureSources": ["AAM", "PRO", "ENV"], "blockedFeatures": ["AAM_FEATURE_1", "AAM_FEATURE_2"] }`

响应

code language-json line-numbers
`{ "blockedFeatures": [ "AAM_FEATURE_1", "AAM_FEATURE_2" ], "blockedFeatureSources": [ "AAM", "PRO", "ENV" ] }`

在上面显示的请求示例中，用户在其Target帐户中的所有活动中阻止两项功能：“AAM_FEATURE_1”和“AAM_FEATURE_2”。这意味着无论活动如何，“AAM_FEATURE_1”和“AAM_FEATURE_2”都不会包含在此帐户的机器学习模型中。此外，用户还全局阻止前缀为“AAM”、“PRO”或“ENV”的所有功能。

问题：以上代码示例不是多余的吗？

回答：是。对于以“AAM”开头的值阻止功能，同时阻止源为“AAM”的所有功能，这是多余的。最终结果是所有源自AAM(Experience Cloud区段)的功能都将被阻止。因此，如果目标是阻止Experience Cloud区段中的所有功能，则在上例中，无需以“AAM”开头单独指定某些功能。

列入阻止列表最后步骤：无论是在活动级别还是全局级别，都建议您在修改活动后验证URL，以确保该URL包含所需的值。将PUT更改为GET以执行此操作。

下面显示的示例响应表明Target正在阻止两个单独的功能，以及源自“AAM”、“PRO”和“ENV”的所有功能。

步骤 5