啟用資料集 Profile 和 Identity Service 使用API

本教學課程涵蓋啟用資料集以用於中的程式 Real-Time Customer Profile 和 Identity Service，分為下列步驟：

快速入門

若要參閱本教學課程，請先實際瞭解管理已啟用設定檔的資料集所牽涉到的多項Adobe Experience Platform服務。 開始進行本教學課程之前，請先檢閱相關檔案 Platform 服務：

以下章節提供您需瞭解的其他資訊，才能成功呼叫Platform API。

讀取範例 API 呼叫

本教學課程提供範例API呼叫，示範如何格式化您的請求。 這些包括路徑、必要的標頭和正確格式化的請求承載。 此外，也提供 API 回應中傳回的範例 JSON。 如需檔案中用於範例API呼叫的慣例相關資訊，請參閱以下章節： 如何讀取範例API呼叫 在 Experience Platform 疑難排解指南。

收集所需標頭的值

為了呼叫 Platform API，您必須先完成 驗證教學課程. 完成驗證教學課程會提供所有 Experience Platform API 呼叫中每個必要標頭的值，如下所示：

包含裝載(POST、PUT、PATCH)的所有請求都需要額外的 Content-Type 標頭。 必要時，此標頭的正確值會顯示在範例要求中。

中的所有資源 Experience Platform 會隔離至特定的虛擬沙箱。 所有要求至 Platform API需要 x-sandbox-name 標頭，指定執行作業的沙箱名稱。 如需中沙箱的詳細資訊 Platform，請參閱 沙箱概述檔案.

建立為設定檔和身分啟用的資料集 create-a-dataset-enabled-for-profile-and-identity

您可以在建立資料集後或資料集建立後，立即為即時客戶設定檔和Identity Service啟用資料集。 如果要啟用已建立的資料集，請遵循以下步驟 設定現有的資料集 稍後可在此檔案中找到。

若要建立為設定檔啟用的資料集，您可以使用對的POST請求 /dataSets 端點。

API格式

POST /dataSets

要求

包含 unifiedProfile 和 unifiedIdentity 在 tags 在請求內文中，資料集將立即啟用 Profile 和 Identity Service，依序輸入。 這些標籤的值必須是包含字串的陣列 "enabled:true".

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -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 '{
    "schemaRef": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
        "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
    },
    "tags": {
       "unifiedProfile": ["enabled:true"],
       "unifiedIdentity": ["enabled:true"]
    }
  }'

回應

成功的回應會顯示一個陣列，其中包含以形式建立之資料集的ID "@/dataSets/{DATASET_ID}". 當您成功建立並啟用資料集後，請繼續下列步驟： 上傳資料.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

設定現有的資料集 configure-an-existing-dataset

下列步驟說明如何啟用先前建立的資料集 Real-Time Customer Profile 和 Identity Service. 如果您已建立已啟用設定檔的資料集，請繼續的步驟 擷取資料.

檢查資料集是否已啟用 check-if-the-dataset-is-enabled

使用 Catalog API時，您可以檢查現有資料集以判斷是否已啟用它以用於中 Real-Time Customer Profile 和 Identity Service. 以下呼叫會依ID擷取資料集的詳細資料。

API格式

GET /dataSets/{DATASET_ID}

要求

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e' \
  -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}'

回應

{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "@/xdms/context/experienceevent",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

在 tags 屬性，您會看到 unifiedProfile 和 unifiedIdentity 都以值呈現 enabled:true. 因此， Real-Time Customer Profile 和 Identity Service 已分別為此資料集啟用。

啟用資料集 enable-the-dataset

如果現有的資料集尚未啟用 Profile 或 Identity Service，您可使用資料集ID發出PATCH請求來啟用它。

API格式

PATCH /dataSets/{DATASET_ID}

要求

curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type:application/json-patch+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 '[
        { "op": "add", "path": "/tags/unifiedProfile", "value": ["enabled:true"] },
        { "op": "add", "path": "/tags/unifiedIdentity", "value": ["enabled:true"] }
      ]'

請求內文包含 path 兩種型別的標籤， unifiedProfile 和 unifiedIdentity. 此 value 每個都是包含字串的陣列 enabled:true.

回應

成功的PATCH要求會傳回HTTP狀態200 （確定）以及包含已更新資料集ID的陣列。 此ID應符合PATCH請求中傳送的ID。 此 unifiedProfile 和 unifiedIdentity 現在已新增標籤，且資料集已啟用供設定檔和身分識別服務使用。

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

將資料擷取至資料集 ingest-data-into-the-dataset

兩者 Real-Time Customer Profile 和 Identity Service 使用XDM資料，因為它正在被擷取到資料集中。 如需如何將資料上傳到資料集的說明，請參閱上的教學課程 使用API建立資料集. 規劃要傳送哪些資料給您的時 Profile — 啟用的資料集，請考量下列最佳實務：

確認資料擷取依據 Real-Time Customer Profile confirm-data-ingest-by-real-time-customer-profile

首次將資料上傳到新資料集時，或作為涉及新ETL或資料來源的程式的一部分，建議仔細檢查資料，以確保資料已按預期上傳。 使用 Real-Time Customer Profile 存取API，您可以在批次資料載入資料集時擷取該資料。 如果您無法擷取任何您期望的實體，您的資料集可能不會啟用 Real-Time Customer Profile. 確認您的資料集已啟用後，請確保來源資料格式和識別碼支援您的期望。 如需如何使用 Real-Time Customer Profile 要存取的API Profile 資料，請參閱 entities端點指南，也稱為「Profile Access" API.

確認由Identity Service擷取的資料 confirm-data-ingest-by-identity-service

每個內嵌包含多個身分的資料片段，都會在您的私人身分圖形中建立連結。 如需身分圖表和存取身分資料的詳細資訊，請先閱讀 Identity Service總覽.