文档 Experience Platform Data Governance 指南

标签端点

Last update: Thu Aug 01 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
数据管理

创建对象：

开发人员

数据使用标签允许您根据可能应用于数据的使用策略将数据分类。 Policy Service API中的/labels端点允许您以编程方式管理体验应用程序中的数据使用标签。

NOTE

/labels端点仅用于检索、创建和更新数据使用标签。您无法删除标签。但是，您可以使用API调用向数据集和字段添加或删除标签。有关说明，请参阅管理数据集标签文档。

快速入门

本指南中使用的API终结点是Policy Service API的一部分。在继续之前，请查看快速入门指南，以获取相关文档的链接、此文档中示例API调用的阅读指南，以及有关成功调用任何Experience Platform API所需的所需标头的重要信息。

检索标签列表 list

您可以通过分别向/labels/core或/labels/custom发出GET请求来列出所有core或custom标签。

API格式

GET /labels/core
GET /labels/custom

请求

以下请求列出了在您的组织下创建的所有自定义标签。

curl -X GET \
  'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

成功的响应将返回从系统中检索到的自定义标签列表。由于上述示例请求是向/labels/custom发出的，因此下面的响应只显示自定义标签。

{
    "_page": {
        "count": 2
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom?{?limit,start,property}",
            "templated": true
        }
    },
    "children": [
        {
            "name": "L1",
            "category": "Custom",
            "friendlyName": "Banking Information",
            "description": "Data containing banking information for a customer.",
            "imsOrg": "{ORG_ID}",
            "sandboxName": "{SANDBOX_NAME}",
            "created": 1594396718731,
            "createdClient": "{CLIENT_ID}",
            "createdUser": "{USER_ID}",
            "updated": 1594396718731,
            "updatedClient": "{CLIENT_ID}",
            "updatedUser": "{USER_ID}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L1"
                }
            }
        },
        {
            "name": "L2",
            "category": "Custom",
            "friendlyName": "Purchase History Data",
            "description": "Data containing information on past transactions",
            "imsOrg": "{ORG_ID}",
            "sandboxName": "{SANDBOX_NAME}",
            "created": 1594397415663,
            "createdClient": "{CLIENT_ID}",
            "createdUser": "{USER_ID}",
            "updated": 1594397728708,
            "updatedClient": "{CLIENT_ID}",
            "updatedUser": "{USER_ID}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L2"
                }
            }
        }
    ]
}

查找标签 look-up

通过在Policy Service API的GET请求路径中包含特定标签的name属性，您可以查找该标签。

API格式

GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}

参数

描述

{LABEL_NAME}

要查找的自定义标签的name属性。

请求

以下请求检索自定义标签L2，如路径中所示。

curl -X GET \
  'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom/L2' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

成功的响应将返回自定义标签的详细信息。

{
    "name": "L2",
    "category": "Custom",
    "friendlyName": "Purchase History Data",
    "description": "Data containing information on past transactions",
    "imsOrg": "{ORG_ID}",
    "sandboxName": "{SANDBOX_NAME}",
    "created": 1594397415663,
    "createdClient": "{CLIENT_ID}",
    "createdUser": "{USER_ID}",
    "updated": 1594397728708,
    "updatedClient": "{CLIENT_ID}",
    "updatedUser": "{USER_ID}",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L2"
        }
    }
}

创建或更新自定义标签 create-update

要创建或更新自定义标签，您必须向Policy Service API发出PUT请求。

NOTE

如果要从数据集中删除标签，可以对数据集服务API🔗执行PUT请求，或者使用数据集UI。

API格式

PUT /labels/custom/{LABEL_NAME}

参数

描述

{LABEL_NAME}

自定义标签的name属性。如果不存在具有此名称的自定义标签，则会创建新标签。如果存在，则将更新该标签。

请求

以下请求将创建一个新标签L3，该标签旨在描述包含与客户的选定付款计划相关的信息的数据。

curl -X PUT \
  'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom/L3' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "name": "L3",
        "category": "Custom",
        "friendlyName": "Payment Plan",
        "description": "Data containing information on selected payment plans."
      }'

属性

描述

name

标签的唯一字符串标识符。此值用于查找目的，并将标签应用于数据集和字段，因此建议该值简短明了。

category

标签的类别。虽然您可以为自定义标签创建自己的类别，但如果您希望标签显示在UI中，强烈建议您使用Custom。

friendlyName

标签的友好名称，用于显示目的。

description

（可选）提供进一步上下文的标签描述。

响应

成功的响应会返回自定义标签的详细信息，如果更新了现有标签，则返回HTTP代码为200 （确定）；如果创建了新标签，则返回201 （创建）。

{
  "name": "L3",
  "category": "Custom",
  "friendlyName": "Payment Plan",
  "description": "Data containing information on selected payment plans.",
  "imsOrg": "{ORG_ID}",
  "sandboxName": "{SANDBOX_NAME}",
  "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/labels/custom/L3"
    }
  }
}

后续步骤

本指南介绍了策略服务API中/labels端点的使用。有关如何将标签应用于数据集和字段的步骤，请参阅数据集标签API指南。

recommendation-more-help

834e0cae-2761-454a-be4d-62f0fd4b4456