設定檔匯出作業端點
Real-Time Customer Profile 可讓您彙集來自多個來源的資料(包括屬性資料和行為資料),以建立個別客戶的單一檢視。 然後,可將設定檔資料匯出至資料集,以供進一步處理。 例如, Profile 可透過建立受眾來匯出資料以供啟用,且可匯出設定檔屬性以供報告。
本檔案提供逐步指示,說明如何使用 設定檔API.
除了建立匯出作業之外,您也可以存取 Profile 資料使用 /entities
端點,也稱為"Profile Access「。 請參閱 entities端點指南 以取得詳細資訊。 如需如何存取的步驟 Profile 資料使用UI,請參閱 使用手冊.
快速入門
本指南中使用的API端點屬於 Real-Time Customer Profile API。 在繼續之前,請檢閱 快速入門手冊 如需相關檔案的連結,請參閱本檔案範例API呼叫的指南,以及有關成功呼叫任何專案所需標題的重要資訊 Experience Platform API。
建立匯出作業
匯出 Profile 資料需要先建立資料匯出到的資料集,然後起始新的匯出工作。 這兩個步驟都可以使用Experience PlatformAPI來完成,前者使用目錄服務API,後者使用即時客戶設定檔API。 完成每個步驟的詳細指示在以下各節中概述。
建立目標資料集
匯出時 Profile 資料,必須先建立目標資料集。 請務必正確設定資料集,以確保匯出成功。
重要考量事項之一是資料集所根據的結構描述(schemaRef.id
(位於以下的API範例請求中)。 為了匯出設定檔資料,資料集必須以 XDM Individual Profile 聯合結構描述(https://ns.adobe.com/xdm/context/profile__union
)。 聯合結構描述是系統產生的唯讀結構描述,可彙總共用相同類別的結構描述欄位。 在此案例中,這就是 XDM Individual Profile 類別。 如需聯合檢視結構描述的詳細資訊,請參閱 結構描述組合基礎指南中的聯合區段.
本教學課程後續步驟將概述如何建立參照 XDM Individual Profile 使用聯合結構描述 Catalog API。 您也可以使用 Platform 使用者介面來建立參考聯合結構的資料集。 有關使用UI的步驟,請參閱 此用於匯出對象的UI教學課程 但也適用於此處。 完成後,您可以返回本教學課程以繼續的步驟 起始新的匯出工作.
如果您已經有相容的資料集並知道其ID,您可以直接進行步驟 起始新的匯出工作.
API格式
POST /dataSets
要求
以下請求會建立新資料集,在承載中提供設定引數。
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 '{
"name": "Profile Data Export",
"schemaRef": {
"id": "https://ns.adobe.com/xdm/context/profile__union",
"contentType": "application/vnd.adobe.xed+json;version=1"
}
}'
name
schemaRef.id
回應
成功的回應會傳回陣列,其中包含新建立資料集的唯讀、系統產生的唯一ID。 需要正確設定的資料集ID才能成功匯出設定檔資料。
[
"@/datasets/5b020a27e7040801dedba61b"
]
啟動匯出工作 initiate
擁有聯合儲存資料集後,您可以透過向以下專案發出POST請求,建立匯出作業以將設定檔資料儲存至資料集: /export/jobs
Real-time Customer Profile API中的端點,並在請求內文中提供您要匯出的資料詳細資訊。
API格式
POST /export/jobs
要求
以下請求會建立新的匯出作業,在承載中提供設定引數。
curl -X POST \
https://platform.adobe.io/data/core/ups/export/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 '{
"fields": "identities.id,personalEmail.address",
"mergePolicy": {
"id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
"version": 1
},
"additionalFields": {
"eventList": {
"fields": "environment.browserDetails.name,environment.browserDetails.version",
"filter": {
"fromIngestTimestamp": "2018-10-25T13:22:04-07:00"
}
}
}
"destination": {
"datasetId": "5b020a27e7040801dedba61b",
"segmentPerBatch": false
},
"schema": {
"name": "_xdm.context.profile"
}
}'
fields
mergePolicy
mergePolicy.id
mergePolicy.version
additionalFields.eventList
(可選) 提供下列一或多個設定,控制為子或關聯物件匯出的時間序列事件欄位:
eventList.fields
:控制要匯出的欄位。eventList.filter
:指定限制關聯物件所含結果的條件。 需要匯出所需的最小值,通常是日期。eventList.filter.fromIngestTimestamp
:將時間序列事件篩選為提供的時間戳記之後所擷取的事件。 這不是事件時間本身,而是事件的擷取時間。
destination
(必要) 已匯出資料的目的地資訊:
destination.datasetId
: (必要) 要匯出資料之資料集的識別碼。destination.segmentPerBatch
: (可選) Boolean值;若未提供,預設值為false
. 值false
會將所有區段定義ID匯出至單一批次ID。 值true
將一個區段定義ID匯出至一個批次ID。 請注意,將值設為true
可能會影響批次匯出效能。
schema.name
回應
成功的回應會傳回填入設定檔資料的資料集,如請求中所指定。
{
"profileInstanceId": "ups",
"jobType": "BATCH",
"id": 24115,
"schema": {
"name": "_xdm.context.profile"
},
"mergePolicy": {
"id": "0bf16e61-90e9-4204-b8fa-ad250360957b",
"version": 1
},
"status": "NEW",
"requestId": "IwkVcD4RupdSmX376OBVORvcvTdA4ypN",
"computeGatewayJobId": {},
"metrics": {
"totalTime": {
"startTimeInMs": 1559674261657
}
},
"destination": {
"dataSetId": "5cf6bcf79ecc7c14530fe436",
"segmentPerBatch": false,
"batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
},
"updateTime": 1559674261868,
"imsOrgId": "{ORG_ID}",
"creationTime": 1559674261657
}
列出所有匯出工作
您可以透過對下列專案執行GET請求,傳回特定組織的所有匯出工作清單: export/jobs
端點。 此請求也支援查詢引數 limit
和 offset
,如下所示。
API格式
GET /export/jobs
GET /export/jobs?{QUERY_PARAMETERS}
start
start=4
limit
limit=10
page
page=2
sort
asc
)或降序( desc
)順序。 傳回多個結果頁面時,排序引數無法運作。 範例:sort=updateTime:asc
要求
curl -X GET \
https://platform.adobe.io/data/core/ups/export/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}'
回應
回應包括 records
包含貴組織建立的匯出作業的物件。
{
"records": [
{
"profileInstanceId": "ups",
"jobType": "BATCH",
"id": 726,
"schema": {
"name": "_xdm.context.profile"
},
"mergePolicy": {
"id": "timestampOrdered-none-mp",
"version": 1
},
"status": "SUCCEEDED",
"requestId": "d995479c-8a08-4240-903b-af469c67be1f",
"computeGatewayJobId": {
"exportJob": "f3058161-7349-4ca9-807d-212cee2c2e94",
"pushJob": "feaeca05-d137-4605-aa4e-21d19d801fc6"
},
"metrics": {
"totalTime": {
"startTimeInMs": 1538615973895,
"endTimeInMs": 1538616233239,
"totalTimeInMs": 259344
},
"profileExportTime": {
"startTimeInMs": 1538616067445,
"endTimeInMs": 1538616139576,
"totalTimeInMs": 72131
},
"aCPDatasetWriteTime": {
"startTimeInMs": 1538616195172,
"endTimeInMs": 1538616195715,
"totalTimeInMs": 543
}
},
"destination": {
"datasetId": "5b7c86968f7b6501e21ba9df",
"batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
},
"updateTime": 1538616233239,
"imsOrgId": "{ORG_ID}",
"creationTime": 1538615973895
},
{
"profileInstanceId": "test_xdm_latest_profile_20_e2e_1538573005395",
"errors": [
{
"code": "0090000009",
"msg": "Error writing profiles to output path 'adl://va7devprofilesnapshot.azuredatalakestore.net/snapshot/722'",
"callStack": "com.adobe.aep.unifiedprofile.common.logging.Logger"
},
{
"code": "unknown",
"msg": "Job aborted.",
"callStack": "org.apache.spark.SparkException: Job aborted."
}
],
"jobType": "BATCH",
"filter": {
"segments": [
{
"segmentId": "7a93d2ff-a220-4bae-9a4e-5f3c35032be3"
}
]
},
"id": 722,
"schema": {
"name": "_xdm.context.profile"
},
"mergePolicy": {
"id": "7972e3d6-96ea-4ece-9627-cbfd62709c5d",
"version": 1
},
"status": "FAILED",
"requestId": "KbOAsV7HXmdg262lc4yZZhoml27UWXPZ",
"computeGatewayJobId": {
"exportJob": "15971e0f-317c-4390-9038-1a0498eb356f"
},
"metrics": {
"totalTime": {
"startTimeInMs": 1538573416687,
"endTimeInMs": 1538573922551,
"totalTimeInMs": 505864
},
"profileExportTime": {
"startTimeInMs": 1538573872211,
"endTimeInMs": 1538573918809,
"totalTimeInMs": 46598
}
},
"destination": {
"datasetId": "5bb4c46757920712f924a3eb",
"batchId": ""
},
"updateTime": 1538573922551,
"imsOrgId": "{ORG_ID}",
"creationTime": 1538573416687
}
],
"page": {
"sortField": "createdTime",
"sort": "desc",
"pageOffset": "1538573416687_722",
"pageSize": 2
},
"link": {
"next": "/export/jobs/?limit=2&offset=1538573416687_722"
}
}
監視匯出進度
GET若要檢視特定匯出作業的詳細資訊,或監視其處理狀態,您可以向匯出作業的 /export/jobs
端點並包括 id
路徑中匯出作業的ID。 匯出作業於下列作業完成後完成: status
欄位會傳回「SUCCEEDED」值。
API格式
GET /export/jobs/{EXPORT_JOB_ID}
{EXPORT_JOB_ID}
id
要存取之匯出作業的摘要。要求
curl -X GET \
https://platform.adobe.io/data/core/ups/export/jobs/24115 \
-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}'
回應
{
"profileInstanceId": "ups",
"jobType": "BATCH",
"id": 24115,
"schema": {
"name": "_xdm.context.profile"
},
"mergePolicy": {
"id": "0bf16e61-90e9-4204-b8fa-ad250360957b",
"version": 1
},
"status": "SUCCEEDED",
"requestId": "YwMt1H8QbVlGT2pzyxgwFHTwzpMbHrTq",
"computeGatewayJobId": {
"exportJob": "305a2e5c-2cf3-4746-9b3d-3c5af0437754",
"pushJob": "963f275e-91a3-4fa1-8417-d2ca00b16a8a"
},
"metrics": {
"totalTime": {
"startTimeInMs": 1547053539564,
"endTimeInMs": 1547054743929,
"totalTimeInMs": 1204365
},
"profileExportTime": {
"startTimeInMs": 1547053667591,
"endTimeInMs": 1547053778195,
"totalTimeInMs": 110604
},
"aCPDatasetWriteTime": {
"startTimeInMs": 1547054660416,
"endTimeInMs": 1547054698918,
"totalTimeInMs": 38502
}
},
"destination": {
"dataSetId": "5cf6bcf79ecc7c14530fe436",
"segmentPerBatch": false,
"batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
},
"updateTime": 1559674261868,
"imsOrgId": "{ORG_ID}",
"creationTime": 1559674261657
}
batchId
取消匯出工作
Experience Platform可讓您取消現有的匯出作業,這可能是由於許多原因所造成,包括匯出作業未完成或卡在處理階段中。 若要取消匯出作業,您可以執行DELETE請求至 /export/jobs
端點並包括 id
要取消的匯出作業匯出到請求路徑。
API格式
DELETE /export/jobs/{EXPORT_JOB_ID}
{EXPORT_JOB_ID}
id
要存取之匯出作業的摘要。要求
curl -X POST \
https://platform.adobe.io/data/core/ups/export/jobs/726 \
-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狀態204 (無內容)和空白的回應內文,指出取消作業成功。
後續步驟
成功完成匯出後,您的資料就可以在Experience Platform的資料湖中使用。 然後,您可以使用 資料存取API 以使用存取資料 batchId
與匯出相關聯。 視匯出大小而定,資料可能會以區塊為單位,而批次可能包含數個檔案。
如需有關如何使用資料存取API來存取及下載批次檔案的逐步指示,請遵循 資料存取教學課程.
您也可以使用Adobe Experience Platform查詢服務存取成功匯出的即時客戶設定檔資料。 查詢服務可讓您使用UI或RESTful API,針對Data Lake內的資料寫入、驗證及執行查詢。
如需如何查詢受眾資料的詳細資訊,請參閱 查詢服務檔案.
附錄
下節包含有關設定檔API中匯出作業的其他資訊。
其他匯出裝載範例
的章節中顯示的API呼叫範例: 起始匯出工作 建立同時包含設定檔(記錄)和事件(時間序列)資料的工作。 本節提供其他請求裝載範例,將匯出限製為包含一種資料型別或另一種資料型別。
以下裝載會建立僅包含設定檔資料(無事件)的匯出作業:
{
"fields": "identities.id,personalEmail.address",
"mergePolicy": {
"id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
"version": 1
},
"destination": {
"datasetId": "5b020a27e7040801dedba61b",
"segmentPerBatch": false
},
"schema": {
"name": "_xdm.context.profile"
}
}
若要建立僅包含事件資料(無設定檔屬性)的匯出作業,裝載可能會如下所示:
{
"fields": "identityMap",
"mergePolicy": {
"id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
"version": 1
},
"additionalFields": {
"eventList": {
"fields": "environment.browserDetails.name,environment.browserDetails.version",
"filter": {
"fromIngestTimestamp": "2018-10-25T13:22:04-07:00"
}
}
},
"destination": {
"datasetId": "5b020a27e7040801dedba61b",
"segmentPerBatch": false
},
"schema": {
"name": "_xdm.context.profile"
}
}
匯出對象
您也可以使用匯出作業端點來匯出對象,而不是 Profile 資料。 請參閱以下指南: 匯出分段API中的作業 以取得詳細資訊。