文件Experience Platform即時客戶輪廓指南

設定檔系統作業端點（刪除請求）

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

建立對象：

  • 開發人員

Adobe Experience Platform可讓您從多個來源擷取資料，並為個別客戶建立強大的設定檔。 擷取到Platform的資料儲存在Data Lake中，如果已為設定檔啟用資料集，則該資料也會儲存在Real-Time Customer Profile資料存放區中。 有時候，可能有必要從設定檔存放區中刪除與資料集相關聯的設定檔資料，以移除不再需要或錯誤新增的資料。 這需要使用Real-Time Customer Profile API來建立Profile系統作業，或delete request，如有必要，也可以修改、監視或移除這些作業。

NOTE
如果您嘗試從Data Lake刪除資料集或批次，請造訪目錄服務總覽以取得詳細資訊。

快速入門

本指南中使用的API端點是Real-Time Customer Profile API的一部分。 繼續之前，請先檢閱快速入門手冊，以取得相關檔案的連結、閱讀本檔案中範例API呼叫的手冊，以及有關成功呼叫任何Experience PlatformAPI所需必要標題的重要資訊。

檢視刪除請求

刪除請求是長期執行的非同步程式，這表示您的組織可能同時執行多個刪除請求。 若要檢視貴組織目前執行的所有刪除請求，您可以對/system/jobs端點執行GET請求。

您也可以使用選用的查詢引數，以篩選回應中傳回的刪除請求清單。 若要使用多個引數，請使用&符號(&)分隔每個引數。

API格式

GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}
參數
說明
start
根據請求的建立時間，位移傳回結果的頁面。 範例：start=4
limit
限制傳回的結果數。 範例：limit=10
page
根據請求的建立時間，傳回結果的特定頁面。 範例：page=2
sort
以遞增(asc)或遞減(desc)順序依特定欄位排序結果。 傳回多個結果頁面時，排序引數無法運作。 範例：sort=batchId:asc

要求

curl -X GET \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -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}' \

回應

回應中包含「children」陣列，針對每個包含該請求詳細資訊的刪除請求而提供一個物件。

{
  "_page": {
    "count": 100,
    "next": "K1JJRDpFaWc5QUwyZFgtMEpBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQVFBQWZBQUg0Ly9yL25PcmpmZndEZUR3QT0="
  },
  "children": [
    {
      "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
      "imsOrgId": "{ORG_ID}",
      "batchId": "8d075b5a178e48389126b9289dcfd0ac",
      "jobType": "DELETE",
      "status": "COMPLETED",
      "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
      "createEpoch": 1559026134,
      "updateEpoch": 1559026137
    },
    {
      "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
      "imsOrgId": "{ORG_ID}",
      "dataSetId": "5c802d3cd83fc114b741c4b5",
      "jobType": "DELETE",
      "status": "PROCESSING",
      "metrics": "{\"recordsProcessed\":0,\"timeTakenInSec\":15}",
      "createEpoch": 1559025404,
      "updateEpoch": 1559025406
    }
  ]
}
屬性
說明
_page.count
要求總數。 此回應已因空間而遭截斷。
_page.next
如果存在額外的結果頁面，請將查詢請求中的ID值取代為提供的"next"值，以檢視下一頁的結果。
jobType
正在建立的工作型別。 在此情況下，它一律會傳回"DELETE"。
status
刪除請求的狀態。 可能的值為"NEW"、"PROCESSING"、"COMPLETED"、"ERROR"。
metrics
物件包含已處理的記錄數("recordsProcessed")、要求已處理的秒數時間，或要求完成所需的時間("timeTakenInSec")。

建立刪除請求 create-a-delete-request

透過POST要求至/systems/jobs端點來起始新的刪除要求，其中要刪除的資料集或批次識別碼會提供在要求內文中。

刪除資料集和相關聯的設定檔資料

為了從設定檔存放區中刪除資料集以及與資料集相關聯的所有設定檔資料，資料集ID必須包含在POST請求內文中。 此動作將會刪除指定資料集的所有資料。 Experience Platform可讓您根據記錄和時間序列結構描述來刪除資料集。

API格式

POST /system/jobs

要求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -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 '{
        "dataSetId": "5c802d3cd83fc114b741c4b5"
      }'
屬性
說明
dataSetId
（必要） ​您要刪除的資料集識別碼。

回應

成功的回應會傳回新建立的刪除請求的詳細資料，包括請求的不重複、系統產生的唯讀ID。 這可用來查閱請求並檢查其狀態。 在建立時請求的status是"NEW"，直到它開始處理為止。 回應中的dataSetId應符合要求中傳送的dataSetId。

{
    "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
    "imsOrgId": "{ORG_ID}",
    "dataSetId": "5c802d3cd83fc114b741c4b5",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559025404,
    "updateEpoch": 1559025406
}
屬性
說明
id
系統產生的唯一刪除請求唯讀ID。
dataSetId
資料集的ID，如POST請求中所指定。

刪除批次

為了刪除批次，批次ID必須包含在POST請求正文中。 請注意，您無法刪除以記錄結構描述為基礎的資料集批次。 只能刪除以時間序列結構描述為基礎的資料集批次。

NOTE
您無法刪除根據記錄結構描述之資料集的批次，因為記錄型別資料集批次會覆寫先前的記錄，因此無法「復原」或刪除。 根據記錄結構描述移除資料集錯誤批次影響的唯一方法是，使用正確的資料重新內嵌批次，以覆寫不正確的記錄。

如需有關記錄和時間序列行為的詳細資訊，請檢閱XDM System總覽中有關XDM資料行為🔗的區段。

API格式

POST /system/jobs

要求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -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 '{
       "batchId": "8d075b5a178e48389126b9289dcfd0ac"
      }'
屬性
說明
batchId
（必要） ​您要刪除之批次的識別碼。

回應

成功的回應會傳回新建立的刪除請求的詳細資料，包括請求的不重複、系統產生的唯讀ID。 這可用來查閱請求並檢查其狀態。 在建立時請求的"status"是"NEW"，直到它開始處理為止。 回應中的"batchId"值應符合要求中傳送的"batchId"值。

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{ORG_ID}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559026131,
    "updateEpoch": 1559026132
}
屬性
說明
id
系統產生的唯一刪除請求唯讀ID。
batchId
批次的ID，如POST請求中所指定。

如果您嘗試起始記錄資料集批次的刪除請求，您將會遇到400層級的錯誤，類似以下情況：

{
    "requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
    "errors": {
        "400": [
            {
                "code": "500",
                "message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
            }
        ]
    }
}

檢視特定的刪除請求 view-a-specific-delete-request

若要檢視特定的刪除要求，包括其狀態等詳細資訊，您可以對/system/jobs端點執行查詢(GET)要求，並在路徑中包含刪除要求的識別碼。

API格式

GET /system/jobs/{DELETE_REQUEST_ID}
參數
說明
{DELETE_REQUEST_ID}
（必要） ​您要檢視之刪除要求的識別碼。

要求

curl -X GET \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -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}' \

回應

回應會提供刪除請求的詳細資訊，包括其更新狀態。 回應中的刪除要求ID （"id"值）應與要求路徑中傳送的ID相符。

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{ORG_ID}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "COMPLETED",
    "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
    "createEpoch": 1559026134,
    "updateEpoch": 1559026137
}
屬性
說明
jobType
正在建立的工作型別，在此情況下，一律會傳回"DELETE"。
status
刪除請求的狀態。 可能的值： "NEW"、"PROCESSING"、"COMPLETED"、"ERROR"。
metrics
陣列，包含已處理的記錄數("recordsProcessed")以及處理要求所需的秒數，或是完成要求所需的時間("timeTakenInSec")。

刪除請求狀態為"COMPLETED"後，您可以嘗試使用資料存取API存取已刪除的資料，以確認資料已刪除。 如需如何使用資料存取API存取資料集和批次的指示，請檢閱資料存取檔案。

移除刪除請求

Experience Platform可讓您刪除先前的請求，這可能對許多原因有用，包括刪除工作未完成或卡在處理階段中。 若要移除刪除請求，您可以對/system/jobs端點執行DELETE請求，並包含您要移除至請求路徑的刪除請求ID。

API格式

DELETE /system/jobs/{DELETE_REQUEST_ID}
參數
說明
您要移除之刪除請求的ID。

要求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -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}' \

回應

成功的刪除請求會傳回HTTP狀態200 （確定）和空白的回應內文。 您可以透過執行GET請求來確認請求已刪除，以按其ID檢視刪除請求。 這會傳回HTTP狀態404 （找不到），指出刪除請求已移除。

後續步驟

現在您已經知道從Experience Platform內的Profile store刪除資料集和批次所涉及的步驟，您可以安全地刪除已錯誤新增或您的組織不再需要的。 請注意，刪除請求無法復原，因此您應該僅刪除確信現在不需要且未來不需要的資料。

recommendation-more-help
54550d5b-f1a1-4065-a394-eb0f23a2c38b