標籤端點
資料使用標籤可讓您根據可能適用於該資料的使用原則來分類資料。 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要求。
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"
}
}
}
834e0cae-2761-454a-be4d-62f0fd4b4456