使用API管理Recommendations目录

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

主题：

创建对象：

undefined

在确保您满足使用Recommendations API的要求时，您已了解如何使用JWT身份验证流生成访问令牌以使用Adobe Developer Console上的Adobe Target管理员API。

您现在可以使用Recommendations API添加、更新或删除推荐目录中的项目。与其他Adobe Target管理员API一样，Recommendations API需要身份验证。

NOTE

每当您需要刷新访问令牌以进行身份验证时，请发送 IMS: JWT Generate + Auth via User Token 请求，因为它在24小时后过期。有关说明，请参阅配置AdobeAPI身份验证。

JWT3ff

在继续之前，请获取Recommendations Postman收藏集。

使用保存实体API创建和更新项目

要使用API而不是CSV产品馈送或在产品页面上触发的Target请求填充您的Recommendations产品数据库，请使用保存实体API。此请求在单一Target环境中添加或更新项目。语法为：

POST https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities

例如，当满足某些阈值时（例如库存或价格的阈值），可以使用保存实体来更新项目，以便标记这些项目并阻止推荐它们。

导航到 Target > Setup > Hosts > CONTROL Environments，以获取要添加或更新项的目标环境ID。
验证TENANT_ID和API_KEY是否引用了之前建立的Postman环境变量。使用下图进行比较。如有必要，请修改API请求中的标头和路径，使其与下图中的标头和路径相匹配。

在正文中以原始代码的形式输入您的JSON。不要忘记使用environment变量指定环境ID。（在以下示例中，环境ID为6781。）

以下是将entity.id kit2001与Toaster Oven产品的关联实体值添加到环境6781中的示例JSON。

code language-none

code language-none
`{ "entities": [{ "name": "Toaster Oven", "id": "kit2001", "environment": 6781, "categories": [ "housewares:appliances" ], "attributes": { "inventory": 77, "margin": 23, "message": "crashing helicopter", "pageUrl": "www.foobar.foo.com/helicopter.html", "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg", "value": 19.2 } }] }`

    {
    "entities": [{
            "name": "Toaster Oven",
            "id": "kit2001",
            "environment": 6781,
            "categories": [
                "housewares:appliances"
            ],
            "attributes": {
                "inventory": 77,
                "margin": 23,
                "message": "crashing helicopter",
                "pageUrl": "www.foobar.foo.com/helicopter.html",
                "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
               "value": 19.2
            }
        }]
    }

单击 Send。您应会收到以下响应。

可以对JSON对象进行缩放以发送多个产品。例如，此JSON指定两个实体。

code language-none

code language-none
{ "entities": [{ "name": "Toaster Oven", "id": "kit2001", "environment": 6781, "categories": [ "housewares:appliances" ], "attributes": { "inventory": 89, "margin": 11, "message": "Toaster Oven", "pageUrl": "www.foobar.foo.com/helicopter.html", "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg", "value": 102.5 } }, { "name": "Blender", "id": "kit2002", "environment": 6781, "categories": [ "housewares:appliances" ], "attributes": { "inventory": 36, "margin": 5, "message": "Blender", "pageUrl": "www.foobar.foo.com/helicopter.html", "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg", "value": 54.5 } } ] }

    {
        "entities": [{
                "name": "Toaster Oven",
                "id": "kit2001",
                "environment": 6781,
                "categories": [
                    "housewares:appliances"
                ],
                "attributes": {
                    "inventory": 89,
                    "margin": 11,
                    "message": "Toaster Oven",
                    "pageUrl": "www.foobar.foo.com/helicopter.html",
                    "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                    "value": 102.5
                }
            },
            {
                "name": "Blender",
                "id": "kit2002",
                "environment": 6781,
                "categories": [
                    "housewares:appliances"
                ],
                "attributes": {
                    "inventory": 36,
                    "margin": 5,
                    "message": "Blender",
                    "pageUrl": "www.foobar.foo.com/helicopter.html",
                    "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                    "value": 54.5
                }
            }
        ]
    }

现在轮到你了！使用 Save Entities API将以下项目添加到您的目录。使用上面的JSON示例作为起点。（您需要扩展JSON以包含其他实体。）

似乎后两个项目不属于该组。让我们使用 Get Entity API检查这些实例，如有必要，请使用 Delete Entities API删除它们。

使用获取实体API获取项目详细信息

要检索现有项目的详细信息，请使用获取实体API。语法为：

GET https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities/[entity.id]

一次只能检索单个实体的实体详细信息。您可以使用获取实体来确认按预期在目录中进行了更新，或者审核目录的内容。

在API请求中使用变量entityId指定实体ID。以下示例将返回entityId=kit2004的实体的详细信息。
验证TENANT_ID和API_KEY是否引用了之前建立的Postman环境变量。使用下图进行比较。如有必要，请修改API请求中的标头和路径，使其与下图中的标头和路径相匹配。

发送请求。

GetEntity3
如果您收到错误消息指出未找到实体，如上面的示例所示，请验证您是否向正确的Target环境提交请求。

note note
NOTE
如果未明确指定任何环境，则获取实体仅尝试从默认环境获取实体。如果要从默认环境以外的任何环境提取，则必须指定环境ID。

如有必要，请添加environmentId参数，然后重新发送请求。
再次发送 Get Entity 请求，这次检查其entityId=kit2005的实体。

假设您决定需要从目录中删除这些实体。让我们使用 Delete Entities API。

使用删除实体API删除项目

若要从目录中删除项目，请使用删除实体API。语法为：

DELETE https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities?ids=[comma-delimited-entity-ids]&environment=[environmentId]

WARNING

删除实体API会删除由您指定的ID引用的实体。如果未提供实体ID，则给定环境中的所有实体都将被删除。如果未指定环境ID，将从所有环境中删除实体。请谨慎使用！

导航到 Target > Setup > Hosts > Environments，以获取要删除项目的目标环境ID。
在API请求中，使用语法&ids=[comma-delimited-entity-ids]（查询参数）指定要删除的实体的实体ID。删除多个实体时，使用逗号分隔ID。
使用语法&environment=[environmentId]指定环境ID，否则将删除所有环境中的实体。
验证TENANT_ID和API_KEY是否引用了之前建立的Postman环境变量。使用下图进行比较。如有必要，请修改API请求中的标头和路径，使其与下图中的标头和路径相匹配。
发送请求。
使用 Get Entity 验证您的结果，它现在应表示找不到已删除的实体。