本教學課程示範如何使用API呼叫來連線至您的Adobe Experience Platform資料、建立串流雲端儲存空間目的地(AmazonKinesis 或 Azure事件中心)、建立資料流到新建立的目標,並將資料激活到新建立的目標。
本教學課程使用 Amazon Kinesis 目的地,但步驟與 Azure Event Hubs.
如果您偏好使用Platform中的使用者介面來連線至目的地並啟用資料,請參閱 連接目標 和 對串流區段匯出目的地啟用受眾資料 教學課程。
本指南需要妥善了解下列Adobe Experience Platform元件:
以下小節提供您需要了解的其他資訊,以便將資料啟用至Platform中的串流目的地。
若要完成本教學課程中的步驟,您應根據您要連線和啟用區段的目的地類型,備妥下列憑證。
accessKeyId
, secretKey
, region
或 connectionUrl
sasKeyName
, sasKey
, namespace
本教學課程提供範例API呼叫,以示範如何設定要求格式。 這些功能包括路徑、必要標題和格式正確的請求裝載。 也提供API回應中傳回的範例JSON。 如需範例API呼叫檔案中所使用慣例的相關資訊,請參閱 如何閱讀API呼叫範例 Experience Platform疑難排解指南中。
若要呼叫Platform API,您必須先完成 驗證教學課程. 完成驗證教學課程後,所有Experience PlatformAPI呼叫中每個必要標題的值都會顯示,如下所示:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
Experience Platform中的資源可以隔離至特定的虛擬沙箱。 在向Platform API提出的請求中,您可以指定要執行操作之沙箱的名稱和ID。 這些是選用參數。
{SANDBOX_NAME}
如需Experience Platform中沙箱的詳細資訊,請參閱 沙箱概述檔案.
所有包含裝載(POST、PUT、PATCH)的請求都需要其他媒體類型標題:
application/json
您可以在Swagger中找到本教學課程中所有API呼叫的隨附參考檔案。 請參閱 Adobe I/O上的流量服務API檔案. 建議您同時使用本教學課程和Swagger檔案頁面。
首先,您應決定要啟用資料的串流目的地。 若要開始使用,請執行呼叫,以要求可供連線及啟用區段的可用目的地清單。 對執行下列GET要求 connectionSpecs
端點,返回可用目的地清單:
API格式
GET /connectionSpecs
要求
curl --location --request GET 'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs' \
--header 'accept: application/json' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}'
回應
成功的回應包含可用目的地及其唯一識別碼的清單(id
)。 儲存您打算使用的目的地值,因為後續步驟將需要它。 例如,如果您想要連線並將區段傳送至 Amazon Kinesis 或 Azure Event Hubs,在回應中尋找下列程式碼片段:
{
"id": "86043421-563b-46ec-8e6c-e23184711bf6",
"name": "Amazon Kinesis",
...
...
}
{
"id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
"name": "Azure Event Hubs",
...
...
}
接下來,您必須連線至您的Experience Platform資料,以便匯出設定檔資料並在您偏好的目的地啟用。 這包含兩個子步驟,如下所述。
API格式
POST /connections
要求
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Base connection to Experience Platform",
"description": "This call establishes the connection to Experience Platform data",
"connectionSpec": {
"id": "{CONNECTION_SPEC_ID}",
"version": "1.0"
}
}'
{CONNECTION_SPEC_ID}
:使用配置檔案服務的連接規範ID - 8a9c3494-9708-43d7-ae3f-cda01e5030e1
.回應
成功的回應包含基本連線的唯一識別碼(id
)。 在下一步建立源連接時,按需要儲存此值。
{
"id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}
API格式
POST /sourceConnections
要求
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Connecting to Profile Service",
"description": "Optional",
"connectionSpec": {
"id": "{CONNECTION_SPEC_ID}",
"version": "1.0"
},
"baseConnectionId": "{BASE_CONNECTION_ID}",
"data": {
"format": "json"
},
"params": {}
}'
{BASE_CONNECTION_ID}
:使用您在上一步中取得的ID。{CONNECTION_SPEC_ID}
:使用配置檔案服務的連接規範ID - 8a9c3494-9708-43d7-ae3f-cda01e5030e1
.回應
成功的回應會傳回唯一識別碼(id
),以取得新建立的來源連線。 這可確認您已成功連線至Experience Platform資料。 在後續步驟中,視需要儲存此值。
{
"id": "ed48ae9b-c774-4b6e-88ae-9bc7748b6e97"
}
在此步驟中,您會設定與所需串流目的地的連線。 這包含兩個子步驟,如下所述。
API格式
POST /connections
要求
以下範例包含前置詞為的程式碼註解 //
. 這些註解會反白標示必須針對不同串流目的地使用不同值的位置。 使用此代碼段之前,請刪除這些注釋。
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Connection for Amazon Kinesis/ Azure Event Hubs",
"description": "summer advertising campaign",
"connectionSpec": {
"id": "{_CONNECTION_SPEC_ID}",
"version": "1.0"
},
"auth": {
"specName": "{AUTHENTICATION_CREDENTIALS}",
"params": { // use these values for Amazon Kinesis connections
"accessKeyId": "{ACCESS_ID}",
"secretKey": "{SECRET_KEY}",
"region": "{REGION}"
},
"params": { // use these values for Azure Event Hubs connections
"sasKeyName": "{SAS_KEY_NAME}",
"sasKey": "{SAS_KEY}",
"namespace": "{EVENT_HUB_NAMESPACE}"
}
}
}'
{CONNECTION_SPEC_ID}
:使用在步驟中獲得的連接規範ID 取得可用目的地的清單.{AUTHENTICATION_CREDENTIALS}
:填入串流目的地的名稱: Aws Kinesis authentication credentials
或 Azure EventHub authentication credentials
.{ACCESS_ID}
: 針對 Amazon Kinesis 連線。 Amazon Kinesis儲存位置的存取ID。{SECRET_KEY}
: 針對 Amazon Kinesis 連線。 Amazon Kinesis儲存位置的機密金鑰。{REGION}
: 針對 Amazon Kinesis 連線。 您 Amazon Kinesis Platform將在哪個帳戶串流您的資料。{SAS_KEY_NAME}
: 針對 Azure Event Hubs 連線。 填寫SAS密鑰名。 了解驗證 Azure Event Hubs 在 Microsoft檔案.{SAS_KEY}
: 針對 Azure Event Hubs 連線。 填入SAS密鑰。 了解驗證 Azure Event Hubs 在 Microsoft檔案.{EVENT_HUB_NAMESPACE}
: 針對 Azure Event Hubs 連線。 填入 Azure Event Hubs Platform將串流您資料的命名空間。 如需詳細資訊,請參閱 建立事件中心命名空間 在 Microsoft 檔案。回應
成功的回應包含基本連線的唯一識別碼(id
)。 在下一步建立目標連線時,視需要儲存此值。
{
"id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}
API格式
POST /targetConnections
要求
以下範例包含前置詞為的程式碼註解 //
. 這些註解會反白標示必須針對不同串流目的地使用不同值的位置。 使用此代碼段之前,請刪除這些注釋。
curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Amazon Kinesis/ Azure Event Hubs target connection",
"description": "Connection to Amazon Kinesis/ Azure Event Hubs",
"baseConnectionId": "{BASE_CONNECTION_ID}",
"connectionSpec": {
"id": "{CONNECTION_SPEC_ID}",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": { // use these values for Amazon Kinesis connections
"stream": "{NAME_OF_DATA_STREAM}",
"region": "{REGION}"
},
"params": { // use these values for Azure Event Hubs connections
"eventHubName": "{EVENT_HUB_NAME}"
}
}'
{BASE_CONNECTION_ID}
:使用您在上述步驟中取得的基本連線ID。{CONNECTION_SPEC_ID}
:使用在步驟中獲得的連接規範 取得可用目的地的清單.{NAME_OF_DATA_STREAM}
: 針對 Amazon Kinesis 連線。 提供您 Amazon Kinesis 帳戶。 Platform會將資料匯出至此資料流。{REGION}
: 針對 Amazon Kinesis 連線。 Amazon Kinesis帳戶中Platform將串流您資料的地區。{EVENT_HUB_NAME}
: 針對 Azure Event Hubs 連線。 填入 Azure Event Hub 為Platform串流您資料的位置命名。 如需詳細資訊,請參閱 建立事件中心 在 Microsoft 檔案。回應
成功的回應會傳回唯一識別碼(id
),以取得新建立的目標連線。 在後續步驟中,視需要儲存此值。
{
"id": "12ab90c7-519c-4291-bd20-d64186b62da8"
}
您現在可以使用在前述步驟中取得的ID,在Experience Platform資料與要啟用資料的目標之間建立資料流。 請將此步驟想像成建構管道,資料稍後會透過管道在Experience Platform和您想要的目的地之間流動。
若要建立資料流,請執行POST請求,如下所示,同時在裝載中提供以下提及的值。
執行以下POST請求以建立資料流。
API格式
POST /flows
要求
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-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": "Azure Event Hubs",
"description": "Azure Event Hubs",
"flowSpec": {
"id": "{FLOW_SPEC_ID}",
"version": "1.0"
},
"sourceConnectionIds": [
"{SOURCE_CONNECTION_ID}"
],
"targetConnectionIds": [
"{TARGET_CONNECTION_ID}"
],
"transformations": [
{
"name": "GeneralTransform",
"params": {
"profileSelectors": {
"selectors": [
]
},
"segmentSelectors": {
"selectors": [
]
}
}
}
]
}
{FLOW_SPEC_ID}
:基於配置檔案的目的地的流規範ID為 71471eba-b620-49e4-90fd-23f1fa0174d8
. 在呼叫中使用此值。{SOURCE_CONNECTION_ID}
:使用在步驟中獲得的源連接ID 連線至您的Experience Platform.{TARGET_CONNECTION_ID}
:使用您在步驟中取得的目標連線ID 連線至串流目的地.回應
成功的回應會傳回ID(id
)和 etag
. 請記下這兩個值。 如同您在下一步中啟動區段時一樣。
{
"id": "8256cfb4-17e6-432c-a469-6aedafb16cd5",
"etag": "8256cfb4-17e6-432c-a469-6aedafb16cd5"
}
建立了所有連線和資料流後,您就可以將設定檔資料啟用至串流平台。 在此步驟中,您可以選取要傳送至目的地的區段以及設定檔屬性,並可排程及傳送資料至目的地。
若要將區段啟用至新目的地,您必須執行JSONPATCH作業,如下列範例所示。 您可以在一個呼叫中啟用多個區段和設定檔屬性。 若要深入了解JSONPATCH,請參閱 RFC規範.
API格式
PATCH /flows
要求
curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'If-Match: "{ETAG}"' \
--data-raw '[
{
"op": "add",
"path": "/transformations/0/params/segmentSelectors/selectors/-",
"value": {
"type": "PLATFORM_SEGMENT",
"value": {
"name": "Name of the segment that you are activating",
"description": "Description of the segment that you are activating",
"id": "{SEGMENT_ID}"
}
}
},
{
"op": "add",
"path": "/transformations/0/params/profileSelectors/selectors/-",
"value": {
"type": "JSON_PATH",
"value": {
"operator": "EXISTS",
"path": "{PROFILE_ATTRIBUTE}"
}
}
}
]
屬性 | 說明 |
---|---|
{DATAFLOW_ID} |
在URL中,使用您在上一步驟中建立的資料流的ID。 |
{ETAG} |
取得 {ETAG} 從上一步的回應, 建立資料流. 上一步中的回應格式已逸出引號。 您必須在請求標題中使用未逸出的值。 請參閱下列範例:
每次成功更新資料流時,etag值都會更新。 |
{SEGMENT_ID} |
提供您要匯出至此目的地的區段ID。 若要擷取您要啟用之區段的區段ID,請參閱 擷取區段定義 在Experience PlatformAPI參考中。 |
{PROFILE_ATTRIBUTE} |
例如, "person.lastName" |
op |
用於定義更新資料流所需操作的操作調用。 操作包括: add , replace ,和 remove . 要將段添加到資料流,請使用 add 操作。 |
path |
定義要更新的流程的部分。 將段添加到資料流時,請使用示例中指定的路徑。 |
value |
您要用更新參數的新值。 |
id |
指定要添加到目標資料流的段的ID。 |
name |
可選. 指定要添加到目標資料流的段的名稱。 請注意,此欄位不是必填欄位,您可以在不提供其名稱的情況下成功將段添加到目標資料流。 |
回應
尋找202 OK回應。 未傳回回應內文。 若要驗證請求是否正確,請參閱下一步「驗證資料流」。
作為本教學課程的最後一步,您應驗證區段和設定檔屬性確實已正確對應至資料流。
若要驗證,請執行下列GET要求:
API格式
GET /flows
要求
curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: prod' \
--header 'If-Match: "{ETAG}"'
{DATAFLOW_ID}
:使用上一步的資料流。{ETAG}
:使用上一步的標籤。回應
傳回的回應應包含在 transformations
參數您在上一步驟中提交的區段和設定檔屬性。 範例 transformations
回應中的參數可能如下所示:
"transformations": [
{
"name": "GeneralTransform",
"params": {
"profileSelectors": {
"selectors": [
{
"type": "JSON_PATH",
"value": {
"path": "personalEmail.address",
"operator": "EXISTS"
}
},
{
"type": "JSON_PATH",
"value": {
"path": "person.lastname",
"operator": "EXISTS"
}
}
]
},
"segmentSelectors": {
"selectors": [
{
"type": "PLATFORM_SEGMENT",
"value": {
"name": "Men over 50",
"description": "",
"id": "72ddd79b-6b0a-4e97-a8d2-112ccd81bd02"
}
}
]
}
}
}
],
匯出的資料
除了步驟中的設定檔屬性和區段外 將資料啟用到新目的地,將資料匯出至 AWS Kinesis 和 Azure Event Hubs 也包含身分對應的相關資訊。 這代表匯出設定檔的身分(例如 ECID、行動ID、Google ID、電子郵件地址等)。 請參閱下列範例。
{
"person": {
"email": "yourstruly@adobe.com"
},
"segmentMembership": {
"ups": {
"72ddd79b-6b0a-4e97-a8d2-112ccd81bd02": {
"lastQualificationTime": "2020-03-03T21:24:39Z",
"status": "exited"
},
"7841ba61-23c1-4bb3-a495-00d695fe1e93": {
"lastQualificationTime": "2020-03-04T23:37:33Z",
"status": "existing"
}
}
},
"identityMap": {
"ecid": [
{
"id": "14575006536349286404619648085736425115"
},
{
"id": "66478888669296734530114754794777368480"
}
],
"email_lc_sha256": [
{
"id": "655332b5fa2aea4498bf7a290cff017cb4"
},
{
"id": "66baf76ef9de8b42df8903f00e0e3dc0b7"
}
]
}
}
若要以更簡化的方式連線至本教學課程中說明的串流目的地,您可以使用 Postman.
Postman 是一種工具,可用來進行API呼叫,以及管理預先定義之呼叫和環境的程式庫。
針對本特定教學課程,以下 Postman 集合已附加:
按一下 此處 下載集合封存檔。
每個集合都包含必要的要求和環境變數, AWS Kinesis,和 Azure Event Hub,分別為。
若要使用附加的成功連線至目的地 Postman 集合,請遵循下列步驟:
本教學課程中的API端點會遵循一般Experience PlatformAPI錯誤訊息原則。 請參閱 API狀態代碼 和 請求標題錯誤 以取得解譯錯誤回應的詳細資訊,請參閱Platform疑難排解指南。
依照本教學課程,您已成功將Platform連線至您其中一個偏好的串流目的地,並設定連線至個別目的地的資料流。 傳出資料現在可用於客戶分析的目的地,或您可能想執行的任何其他資料作業。 如需詳細資訊,請參閱下列頁面: