Show Menu
主題×

使用API管理資料使用標籤

本檔案提供如何使用 Policy Service API和 Dataset Service API管理資料使用標籤的步驟。
它提 Policy Service API 供數個端點,可讓您為組織建立和管理資料使用標籤。
API可 Dataset Service 讓您套用和編輯資料集的使用標籤。 它是Adobe Experience Platform資料目錄功能的一部分,但與管理資料集中繼資料的 Catalog Service API不同。

快速入門

在閱讀本指南之前,請依照目錄開發人員指南 「快速入門」一節中概述的步驟,收集必要的認證以呼叫 Platform API。
若要呼叫本檔案所述的 Dataset Service 端點,您必須擁有特定資料集 id 的唯一值。 如果沒有此值,請參閱列出目錄對象 以查找現有資料集的ID 的指南。

列出所有標籤

使用 Policy Service API,您可以分別向或 core``custom 分別提出GET請求,以列 /labels/core 出所有或 /labels/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: {IMS_ORG}' \
  -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": "{IMS_ORG}",
            "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": "{IMS_ORG}",
            "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"
                }
            }
        }
    ]
}

查找標籤

您可以在GET請求到API的路徑中加入該標 name 簽的屬性,以尋找特定的標 Policy Service 簽。
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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

回應
成功的回應會傳回自訂標籤的詳細資訊。
{
    "name": "L2",
    "category": "Custom",
    "friendlyName": "Purchase History Data",
    "description": "Data containing information on past transactions",
    "imsOrg": "{IMS_ORG}",
    "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"
        }
    }
}

建立或更新自訂標籤

若要建立或更新自訂標籤,您必須對 Policy Service API提出PUT要求。
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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "name": "L3",
        "category": "Custom",
        "friendlyName": "Payment Plan",
        "description": "Data containing information on selected payment plans."
      }'

屬性
說明
name
標籤的唯一字串識別碼。 此值用於查閱,並將標籤套用至資料集和欄位,因此建議使用它簡短且簡明。
category
標籤的類別。 雖然您可以為自訂標籤建立自己的類別,但強烈建議您使用, Custom 如果您要讓標籤顯示在UI中。
friendlyName
標籤的好記名稱,用於顯示用途。
description
(可選)標籤的說明,以提供更多內容。
回應
成功的回應會傳回自訂標籤的詳細資訊,如果已更新現有標籤,HTTP程式碼為200(確定);如果已建立新標籤,則傳回201(已建立)。
{
  "name": "L3",
  "category": "Custom",
  "friendlyName": "Payment Plan",
  "description": "Data containing information on selected payment plans.",
  "imsOrg": "{IMS_ORG}",
  "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"
    }
  }
}

尋找資料集的標籤

您可以對 Dataset Service API提出GET要求,以尋找已套用至現有資料集的資料使用標籤。
API格式
GET /datasets/{DATASET_ID}/labels

參數
說明
{DATASET_ID}
您要 id 查找其標籤的資料集的唯一值。
請求
curl -X GET \
  'https://platform.adobe.io/data/foundation/dataset/datasets/5abd49645591445e1ba04f87/labels' \
  -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}'

回應
成功的回應會傳回已套用至資料集的資料使用標籤。
{
  "AEP:dataset:5abd49645591445e1ba04f87": {
    "imsOrg": "{IMS_ORG}",
    "labels": [ "C1", "C2", "C3", "I1", "I2" ],
    "optionalLabels": [
      {
        "option": {
          "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
          "contentType": "application/vnd.adobe.xed-full+json;version=1",
          "schemaPath": "/properties/repositoryCreatedBy"
        },
        "labels": [ "S1", "S2" ]
      }
    ]
  }
}

屬性
說明
labels
已套用至資料集的資料使用標籤清單。
optionalLabels
資料集內已套用資料使用標籤的個別欄位清單。

將標籤套用至資料集

您可以在POST或PUT要求的裝載中提供標籤給 Dataset Service API,為資料集建立標籤集。 使用其中一種方法會覆寫任何現有的標籤,並以裝載中提供的標籤來取代標籤。
API格式
POST /datasets/{DATASET_ID}/labels
PUT /datasets/{DATASET_ID}/labels

參數
說明
{DATASET_ID}
您正 id 在為其建立標籤的資料集的唯一值。
請求
下列POST要求會將一系列標籤新增至資料集,以及該資料集內的特定欄位。 裝載中提供的欄位與PUT請求所需的欄位相同。
curl -X POST \
  'https://platform.adobe.io/data/foundation/dataset/datasets/5abd49645591445e1ba04f87/labels' \
  -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 '{
        "labels": [ "C1", "C2", "C3", "I1", "I2" ],
        "optionalLabels": [
          {
            "option": {
              "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
              "contentType": "application/vnd.adobe.xed-full+json;version=1",
              "schemaPath": "/properties/repositoryCreatedBy"
            },
            "labels": [ "S1", "S2" ]
          }
        ]
      }'

屬性
說明
labels
您要新增至資料集的資料使用標籤清單。
optionalLabels
資料集中您想新增標籤的任何個別欄位清單。 此陣列中的每個項目都必須具有以下屬性:
option : 包含欄位 Experience Data Model (XDM)屬性的對象。 需要下列三個屬性:
  • id: 與欄位關聯的架構的URI $id值。
  • contentType: 架構的內容類型和版本號。 這應採用XDM查閱請求的有效「接 查找資源 受」標題 之一的形式。
  • schemaPath: 資料集結構中欄位的路徑。
labels : 您要新增至欄位的資料使用標籤清單。
回應
成功的回應會傳回已新增至資料集的標籤。
{
  "labels": [ "C1", "C2", "C3", "I1", "I2" ],
  "optionalLabels": [
    {
      "option": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
        "contentType": "application/vnd.adobe.xed-full+json;version=1",
        "schemaPath": "/properties/repositoryCreatedBy"
      },
      "labels": [ "S1", "S2" ]
    }
  ]
}

從資料集移除標籤

您可以對 Dataset Service API提出DELETE請求,移除套用至資料集的標籤。
API格式
DELETE /datasets/{DATASET_ID}/labels

參數
說明
{DATASET_ID}
您要 id 移除其標籤的資料集的唯一值。
請求
curl -X DELETE \
  'https://platform.adobe.io/data/foundation/dataset/datasets/5abd49645591445e1ba04f87/labels' \
  -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(確定),表示標籤已移除。 您可 以在個別呼叫中 ,尋找資料集的現有標籤以確認此點。

後續步驟

閱讀本檔案後,您便瞭解如何使用API管理資料使用標籤。
在資料集和欄位層級新增資料使用標籤後,您就可以開始將資料內嵌至 Experience Platform。 若要進一步瞭解,請先閱讀資料 擷取檔案
您現在也可以根據已套用的標籤來定義資料使用原則。 如需詳細資訊,請參閱資 料使用政策概觀
有關在中管理資料集的詳細信 Experience Platform息,請參 見資料集概述