使用Flow Service API建立通訊協定來源的資料流
本教學課程涵蓋從通訊協定來源擷取資料，以及使用Flow Service API將資料帶到Platform的步驟。
NOTE
- 為了建立資料流，您必須擁有包含通訊協定來源的有效基底連線ID。 如果您沒有此ID，請參閱來源概觀，以取得您可以建立基礎連線的通訊協定來源清單。
快速入門
本教學課程也要求您實際瞭解下列Adobe Experience Platform元件：
-
Experience Data Model (XDM) System：Experience Platform用來組織客戶體驗資料的標準化架構。
- 結構描述組合的基本概念：瞭解XDM結構描述的基本建置區塊，包括結構描述組合中的關鍵原則和最佳實務。
- Schema Registry開發人員指南：包含您成功執行Schema Registry API呼叫所需瞭解的重要資訊。 這包括您的
{TENANT_ID}、「容器」的概念，以及發出要求所需的標頭（特別注意Accept標頭及其可能的值）。
-
Catalog Service：目錄是Experience Platform中資料位置和歷程的記錄系統。
-
Batch ingestion：批次擷取API可讓您將資料以批次檔案的形式擷取到Experience Platform中。
-
沙箱：Experience Platform提供的虛擬沙箱可將單一Platform執行個體分割成個別的虛擬環境，以利開發及改進數位體驗應用程式。
使用平台API
如需如何成功呼叫Platform API的詳細資訊，請參閱Platform API快速入門的指南。
建立來源連線 source
您可以向Flow Service API發出POST要求，以建立來源連線。 來源連線由連線ID、來源資料檔案的路徑以及連線規格ID組成。
若要建立來源連線，您也必須定義資料格式屬性的列舉值。
對檔案型聯結器使用下列列舉值：
資料格式
列舉值
已分隔
delimitedJSON
jsonParquet
parquet針對所有資料表式聯結器，將值設定為tabular。
API格式
POST /sourceConnections
要求
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Generic OData source connection",
"baseConnectionId": "a5c6b647-e784-4b58-86b6-47e784ab580b",
"description": "Generic OData source connection",
"data": {
"format": "tabular",
},
"params": {
"tableName": "Orders",
"columns": [
{
"name": "OrderID",
"type": "integer",
"xdm": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
{
"name": "CustomerID",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "OrderDate",
"type": "string",
"meta:xdmType": "date-time",
"xdm": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ShippedDate",
"type": "string",
"meta:xdmType": "date-time",
"xdm": {
"type": "string",
"format": "date-time"
}
}
]
},
"connectionSpec": {
"id": "8e6b41a8-d998-4545-ad7d-c6a9fff406c3",
"version": "1.0"
}
}'
屬性
說明
baseConnectionId您通訊協定應用程式的連線ID
params.path來源檔案的路徑。
connectionSpec.id您通訊協定應用程式的連線規格ID。
回應
成功的回應會傳回新建立的來源連線的唯一識別碼(id)。 在後續步驟中，建立目標連線時需要此ID。
{
"id": "0a768941-ddfb-499d-b689-41ddfbf99db0",
"etag": "\"8f00753e-0000-0200-0000-5e8a547d0000\""
}
建立目標XDM結構描述 target-schema
為了在Platform中使用來源資料，必須建立目標結構描述，以根據您的需求來建構來源資料。 然後目標結構描述會用來建立包含來源資料的Platform資料集。
可透過對結構描述登入API執行POST要求來建立目標XDM結構描述。
如需有關如何建立目標XDM結構描述的詳細步驟，請參閱有關使用API 建立結構描述的教學課程。
建立目標資料集 target-dataset
可以透過對目錄服務API執行POST要求，在承載中提供目標結構描述的ID來建立目標資料集。
如需有關如何建立目標資料集的詳細步驟，請參閱有關使用API建立資料集的教學課程。
建立目標連線 target-connection
目標連線代表與擷取資料著陸目的地之間的連線。 若要建立目標連線，您必須提供與Data Lake相關聯的固定連線規格ID。 此連線規格識別碼為： c604ff05-7f1a-43c0-8e18-33bf874cb11c。
您現在具有目標結構描述、目標資料集和到資料湖的連線規格ID的唯一識別碼。 使用Flow Service API，您可以指定這些識別碼以及將包含傳入來源資料的資料集，以建立目標連線。
API格式
POST /targetConnections
要求
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Target Connection for protocols",
"description": "Target Connection for protocols",
"data": {
"format": "parquet_xdm",
"schema": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/e669d7aba5a02f294fafb7b269af25f7cd4a66ce59193545",
"version" "application/vnd.adobe.xed-full+json;version=1"
}
},
"params": {
"dataSetId": "5e8a55ca53662c18af37a83a"
},
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}'
屬性
說明
data.schema.id目標XDM結構的
$id。params.dataSetId上一步中產生的目標資料集的ID。 注意：建立目標連線時，您必須提供有效的資料集識別碼。 無效的資料集ID將會導致錯誤。
connectionSpec.id用來連線至Data Lake的連線規格ID。 此ID為：
c604ff05-7f1a-43c0-8e18-33bf874cb11c。回應
成功的回應會傳回新目標連線的唯一識別碼(id)。 在後續步驟中需要此值，才能建立資料流。
{
"id": "576d5ecf-f114-4587-ad5e-cff1144587f4",
"etag": "\"13013506-0000-0200-0000-5e8a56d80000\""
}
建立對應 mapping
為了將來源資料擷取到目標資料集中，必須首先將其對應到目標資料集所堅持的目標結構描述。
若要建立對應集，請在提供您的目標XDM結構描述$id和您要建立的對應集詳細資料時，向Data Prep API的mappingSets端點提出POST要求。
API格式
POST /mappingSets
要求
curl -X POST \
'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"version": 0,
"xdmSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/e669d7aba5a02f294fafb7b269af25f7cd4a66ce59193545",
"xdmVersion": "1.0",
"id": null,
"mappings": [
{
"destinationXdmPath": "_id",
"sourceAttribute": "OrderID",
"identity": false,
"identityGroup": null,
"namespaceCode": null,
"version": 0
},
{
"destinationXdmPath": "_id",
"sourceAttribute": "CustomerID",
"identity": false,
"identityGroup": null,
"namespaceCode": null,
"version": 0
},
{
"destinationXdmPath": "_id",
"sourceAttribute": "EmployeeID",
"identity": false,
"identityGroup": null,
"namespaceCode": null,
"version": 0
},
{
"destinationXdmPath": "createdByBatchID",
"sourceAttribute": "OrderDate",
"identity": false,
"identityGroup": null,
"namespaceCode": null,
"version": 0
}
]
}'
屬性
說明
xdmSchema目標XDM結構的
$id。回應
成功的回應會傳回新建立的對應詳細資料，包括其唯一識別碼(id)。 在後續步驟中需要此ID才能建立資料流。
{
"id": "37409d3017e24a3eb4a2dc21020f7a5b",
"version": 0,
"createdDate": 1586124873209,
"modifiedDate": 1586124873209,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
查詢資料流規格 specs
資料流負責從來源收集資料，並將這些資料匯入Platform。 為了建立資料流，您必須先取得負責從通訊協定應用程式收集資料的資料流規格。
API格式
GET /flowSpecs?property=name=="CRMToAEP"
要求
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/flowSpecs?property=name=="CRMToAEP"' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
回應
成功的回應會傳回負責將資料從來源帶入Platform的資料流規格的詳細資料。 回應包含建立新資料流所需的唯一流程規格id。
NOTE
為了簡單起見，會隱藏下列JSON回應裝載。 選取「裝載」以檢視回應裝載。
檢視裝載
| code language-json |
|---|
|
建立資料流
收集資料的最後一步是建立資料流。 此時，您應該已準備下列必要值：
資料流負責從來源排程及收集資料。 您可以執行POST要求，同時在裝載中提供先前提到的值，藉此建立資料流。
若要排程內嵌，您必須先將開始時間值設為以秒為單位的epoch時間。 然後，您必須將頻率值設定為下列五個選項之一： once、minute、hour、day或week。 間隔值會指定兩個連續擷取之間的期間，而建立一次性擷取不需要設定間隔。 對於所有其他頻率，間隔值必須設定為等於或大於15。
API格式
POST /flows
要求
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Creating a dataflow for a protocols source",
"description": "Creating a dataflow for a protocols source",
"flowSpec": {
"id": "14518937-270c-4525-bdec-c2ba7cce3860",
"version": "1.0"
},
"sourceConnectionIds": [
"0a768941-ddfb-499d-b689-41ddfbf99db0"
],
"targetConnectionIds": [
"576d5ecf-f114-4587-ad5e-cff1144587f4"
],
"transformations": [
{
"name": "Copy",
"params": {
"deltaColumn": {
"name": "updatedAt",
"dateFormat": "YYYY-MM-DD",
"timezone": "UTC"
}
}
},
{
"name": "Mapping",
"params": {
"mappingId": "7409d3017e24a3eb4a2dc21020f7a5b",
"mappingVersion": 0
}
}
],
"scheduleParams": {
"startTime": "1567411548",
"frequency":"minute",
"interval":"30"
}
}'
屬性
說明
flowSpec.id在上一步中擷取的流程規格識別碼。
sourceConnectionIds已在先前步驟中擷取的來源連線識別碼。
targetConnectionIds已在先前步驟中擷取的目標連線識別碼。
transformations.params.mappingId已在先前步驟中擷取的對應ID。
transformations.params.deltaColum用來區分新資料和現有資料的指定欄。 將根據所選欄的時間戳記擷取增量資料。 使用Generic OData時
deltaColumn支援的格式為yyyy-MM-ddTHH:mm:ssZ。transformations.params.mappingId與資料庫關聯的對應ID。
scheduleParams.startTime資料流的開始時間（以Epoch時間計）。
scheduleParams.frequency資料流收集資料的頻率。 可接受的值包括：
once、minute、hour、day或week。scheduleParams.interval間隔會指定兩個連續資料流執行之間的期間。 間隔的值應為非零整數。 每個頻率的最小接受間隔值如下：
- 一次：不適用
- 分鐘： 15
- 小時： 1
- 天： 1
- 周： 1
回應
成功的回應會傳回新建立資料流的ID id。
{
"id": "8256cfb4-17e6-432c-a469-6aedafb16cd5",
"etag": "\"04004fe9-0000-0200-0000-5ebc4c8b0000\""
}
監視資料流
建立資料流後，您可以監視透過該資料流擷取的資料，以檢視有關資料流執行、完成狀態和錯誤的資訊。 如需如何監視資料流程的詳細資訊，請參閱有關API中監視資料流程的教學課程
後續步驟
依照本教學課程中的指示，您已建立來源聯結器，以依排程從通訊協定應用程式收集資料。 下游Platform服務（例如Real-Time Customer Profile和Data Science Workspace）現在可以使用傳入的資料。 如需更多詳細資訊，請參閱下列檔案：
recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089