批次內嵌概觀

Adobe Experience Platform資料擷取API可讓您將資料以批次檔案的形式內嵌至Platform。 正在擷取的資料可以是來自CRM系統中一般檔案(例如Parquet檔案)的設定檔資料,或符合Experience Data Model (XDM)註冊表中已知結構的資料。

資料擷取API參考提供這些API呼叫的其他資訊。

下圖概述批次擷取程式:

使用 API

Data Ingestion API可讓您透過三個基本步驟,將資料以批次(資料單位,由一或多個要以單一單位內嵌的檔案組成)的形式內嵌至Experience Platform:

  1. 建立新批。
  2. 將檔案上傳至符合資料之XDM結構的指定資料集。
  3. 發出批次結束的信號。

Data Ingestion 必要條件

  • 要上傳的資料必須採用Parquet或JSON格式。
  • Catalog services中建立的資料集。
  • Parquet檔案的內容必須符合上傳至之資料集結構的子集。
  • 在驗證後使用您的唯一存取權杖。

批次內嵌最佳實務

  • 建議的批處理大小介於256 MB和100 GB之間。
  • 每個批次最多應包含1500個檔案。

若要上傳大於512MB的檔案,必須將檔案分割為較小的區塊。 您可在此處找到上傳大型檔案的指示。

讀取範例API呼叫

本指南提供範例API呼叫,以示範如何設定請求格式。 這些功能包括路徑、必要標題和格式正確的請求裝載。 也提供API回應中傳回的範例JSON。 如需範例API呼叫檔案中所使用慣例的資訊,請參閱Experience Platform疑難排解指南中如何讀取範例API呼叫一節。

收集必要標題的值

若要呼叫Platform API,您必須先完成authentication tutorial。 完成驗證教學課程後,將提供所有Experience Platform API呼叫中每個必要標題的值,如下所示:

  • 授權:承載{ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform中的所有資源都與特定虛擬沙箱隔離。 對Platform API的所有請求都需要標題,以指定作業將在下列位置進行的沙箱名稱:

  • x-sandbox-name: {SANDBOX_NAME}
注意

如需Platform中沙箱的詳細資訊,請參閱沙箱概觀檔案

所有包含裝載(POST、PUT、PATCH)的請求都需要額外的標題:

  • 內容類型:application/json

建立批次

必須先將資料連結至批次資料,之後再上傳至指定的資料集,才能將資料新增至資料集。

POST /batches

要求

curl -X POST "https://platform.adobe.io/data/foundation/import/batches" \
  -H "Content-Type: application/json" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key : {API_KEY}"
  -d '{ 
          "datasetId": "{DATASET_ID}" 
      }'
屬性 說明
datasetId 上傳檔案至的資料集ID。

回應

{
    "id": "{BATCH_ID}",
    "imsOrg": "{IMS_ORG}",
    "updated": 0,
    "status": "loading",
    "created": 0,
    "relatedObjects": [
        {
            "type": "dataSet",
            "id": "{DATASET_ID}"
        }
    ],
    "version": "1.0.0",
    "tags": {},
    "createdUser": "{USER_ID}",
    "updatedUser": "{USER_ID}"
}
屬性 說明
id 剛建立的批次ID(用於後續請求)。
relatedObjects.id 上傳檔案至的資料集ID。

檔案上傳

成功建立新批次以供上傳後,即可將檔案上傳至特定資料集。

您可以使用小型檔案上傳API來上傳檔案。 不過,如果您的檔案太大且超出閘道限制(例如延長逾時、超出主體大小的要求及其他限制),您可以切換至「大型檔案上傳API」。 此API會以區塊上傳檔案,並使用「大型檔案上傳完成API」呼叫將資料匯整在一起。

注意

以下示例使用Apache Parquet檔案格式。 若需使用JSON檔案格式的範例,請參閱批次內嵌開發人員指南

小型檔案上傳

建立批次資料後,即可將資料上傳至現有的資料集。 上傳的檔案必須符合其參考的XDM結構。

PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
屬性 說明
{BATCH_ID} 批的ID。
{DATASET_ID} 上傳檔案的資料集ID。
{FILE_NAME} 資料集中顯示的檔案名稱。

要求

curl -X PUT "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet" \
  -H "content-type: application/octet-stream" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key : {API_KEY}" \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
屬性 說明
{FILE_PATH_AND_NAME} 要上傳至資料集的檔案路徑和檔案名稱。

回應

#Status 200 OK, with empty response body

大型檔案上傳 — 建立檔案

若要上傳大型檔案,必須將檔案分割為較小的區塊,並一次上傳一個。

POST /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}?action=initialize
屬性 說明
{BATCH_ID} 批的ID。
{DATASET_ID} 擷取檔案的資料集ID。
{FILE_NAME} 資料集中顯示的檔案名稱。

要求

curl -X POST "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/part1=a/part2=b/{FILE_NAME}.parquet?action=initialize" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}"

回應

#Status 201 CREATED, with empty response body

大型檔案上傳 — 上傳後續部件

建立檔案後,可以透過重複的PATCH要求來上傳所有後續區塊,檔案的每個區段各一個。

PATCH /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
屬性 說明
{BATCH_ID} 批的ID。
{DATASET_ID} 上傳檔案至的資料集ID。
{FILE_NAME} 資料集中顯示的檔案名稱。

要求

curl -X PATCH "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/part1=a/part2=b/{FILE_NAME}.parquet" \
  -H "content-type: application/octet-stream" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "Content-Range: bytes {CONTENT_RANGE}" \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
屬性 說明
{FILE_PATH_AND_NAME} 要上傳至資料集的檔案路徑和檔案名稱。

回應

#Status 200 OK, with empty response

信號批完成

將所有檔案上載到批後,可以發出該批完成的信號。 通過執行此操作,將為已完成的檔案建立Catalog DataSetFile條目,並與上述生成的批相關聯。 接著, Catalog批次會標示為成功,這會觸發下游流程內嵌可用資料。

要求

POST /batches/{BATCH_ID}?action=COMPLETE
屬性 說明
{BATCH_ID} 要上傳至資料集的批次ID。
curl -X POST "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE" \
-H "x-gw-ims-org-id: {IMS_ORG}" \
-H "x-sandbox-name: {SANDBOX_NAME}" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "x-api-key : {API_KEY}"

回應

#Status 200 OK, with empty response

檢查批狀態

等待檔案上傳至批次時,可以檢查批次的狀態,以查看其進度。

API格式

GET /batch/{BATCH_ID}
屬性 說明
{BATCH_ID} 正在檢查的批的ID。

要求

curl GET "https://platform.adobe.io/data/foundation/catalog/batch/{BATCH_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "x-api-key: {API_KEY}"

回應

{
    "{BATCH_ID}": {
        "imsOrg": "{IMS_ORG}",
        "created": 1494349962314,
        "createdClient": "MCDPCatalogService",
        "createdUser": "{USER_ID}",
        "updatedUser": "{USER_ID}",
        "updated": 1494349963467,
        "externalId": "{EXTERNAL_ID}",
        "status": "success",
        "errors": [
            {
                "code": "err-1494349963436"
            }
        ],
        "version": "1.0.3",
        "availableDates": {
            "startDate": 1337,
            "endDate": 4000
        },
        "relatedObjects": [
            {
                "type": "batch",
                "id": "foo_batch"
            },
            {
                "type": "connection",
                "id": "foo_connection"
            },
            {
                "type": "connector",
                "id": "foo_connector"
            },
            {
                "type": "dataSet",
                "id": "foo_dataSet"
            },
            {
                "type": "dataSetView",
                "id": "foo_dataSetView"
            },
            {
                "type": "dataSetFile",
                "id": "foo_dataSetFile"
            },
            {
                "type": "expressionBlock",
                "id": "foo_expressionBlock"
            },
            {
                "type": "service",
                "id": "foo_service"
            },
            {
                "type": "serviceDefinition",
                "id": "foo_serviceDefinition"
            }
        ],
        "metrics": {
            "foo": 1337
        },
        "tags": {
            "foo_bar": [
                "stuff"
            ],
            "bar_foo": [
                "woo",
                "baz"
            ],
            "foo/bar/foo-bar": [
                "weehaw",
                "wee:haw"
            ]
        },
        "inputFormat": {
            "format": "parquet",
            "delimiter": ".",
            "quote": "`",
            "escape": "\\",
            "nullMarker": "",
            "header": "true",
            "charset": "UTF-8"
        }
    }
}
屬性 說明
{USER_ID} 建立或更新批的用戶的ID。

"status"欄位顯示請求的批的當前狀態。 批可以具有以下任一狀態:

批次內嵌狀態

狀態 說明
放棄 批未在預期的時間範圍內完成。
已中止 已為指定批調用中止操作​顯式(通過批次內嵌API)。 一旦批次進入「已載入」狀態,就無法中止。
作用中 批已成功升級,可用於下游衝減。 此狀態可與「Success」交替使用。
已刪除 批次的資料已完全移除。
已失敗 由錯誤配置和/或錯誤資料造成的終端狀態。 失敗批次的資料將​不會​顯示。 此狀態可與「失敗」交互使用。
非作用中 批已成功升級,但已還原或已過期。 該批不再可用於下游衝減。
已載入 批次的資料已完成,且該批次已準備好升級。
載入 正在上載此批的資料,並且該批當前​​已準備好升級。
重試 正在處理此批的資料。 但是,由於系統或暫時錯誤,該批處理失敗,因此正在重試該批處理。
已轉移 批的升級進程的分段階段已完成,並且已運行獲取作業。
預備 正在處理批的資料。
逾時 正在處理批的資料。 不過,多次重試後批次促銷已停止。

本頁內容