使用流量服務API連線到串流目的地並啟用資料

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：

建立對象：

undefined
undefined

IMPORTANT

若要連線到目的地，您需要 檢視目的地 和 管理目的地 存取控制許可權。

若要啟用資料，您需要 檢視目的地、啟用目的地、檢視設定檔 和 檢視區段 存取控制許可權。

閱讀存取控制總覽或連絡您的產品管理員以取得必要的許可權。

此教學課程示範如何使用API呼叫連線至您的Adobe Experience Platform資料、建立與串流雲端儲存空間目的地(Amazon Kinesis或Azure事件中樞)的連線、建立連線至您新建立之目的地的資料流，以及啟用資料至您新建立的目的地。

本教學課程在所有範例中都使用Amazon Kinesis目的地，但Azure Event Hubs的步驟相同。

概觀 — 建立串流目的地和啟用對象的步驟

如果您偏好使用Platform中的使用者介面來連線到目的地並啟用資料，請參閱連線目的地和將對象資料啟用到串流對象匯出目的地教學課程。

快速入門

本指南需要您深入了解下列 Adobe Experience Platform 元件：

Experience Data Model (XDM) System：Experience Platform用來組織客戶體驗資料的標準化架構。
Catalog Service： Catalog是Experience Platform中資料位置和歷程的記錄系統。
沙箱：Experience Platform提供的虛擬沙箱可將單一Platform執行個體分割成個別的虛擬環境，以利開發及改進數位體驗應用程式。

以下章節提供您需要瞭解的其他資訊，才能在Platform中啟用串流目的地的資料。

收集必要的認證

若要完成本教學課程中的步驟，您應該準備好下列憑證，端視您要連線並啟用對象的目的地型別而定。

針對Amazon Kinesis連線： accessKeyId、secretKey、region或connectionUrl
針對Azure Event Hubs連線： sasKeyName、sasKey、namespace

讀取範例 API 呼叫 reading-sample-api-calls

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

收集必要和選用標題的值 gather-values

若要呼叫Platform API，您必須先完成驗證教學課程。完成驗證教學課程，在所有Experience Platform API呼叫中提供每個必要標題的值，如下所示：

授權：持有人{ACCESS_TOKEN}
x-api-key： {API_KEY}
x-gw-ims-org-id： {ORG_ID}

Experience Platform中的資源可以隔離到特定的虛擬沙箱。在對Platform API的請求中，您可以指定將執行作業的沙箱名稱和ID。這些是選用引數。

x-sandbox-name： {SANDBOX_NAME}

NOTE

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

包含裝載(POST、PUT、PATCH)的所有請求都需要額外的媒體型別標頭：

Content-Type： application/json

Swagger檔案 swagger-docs

您可以在Swagger中找到本教學課程中所有API呼叫的隨附參考檔案。請參閱Adobe I/O🔗上的流程服務API檔案。我們建議您同時使用本教學課程和Swagger檔案頁面。

取得可用串流目的地的清單 get-the-list-of-available-streaming-destinations

目的地步驟概述步驟1

首先，您應該決定要啟用資料的串流目的地。首先，請執行呼叫以請求您可以連線並啟用對象的目標可用目的地清單。對connectionSpecs端點執行下列GET要求，以傳回可用目的地的清單：

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資料 connect-to-your-experience-platform-data

目的地步驟概述步驟2

接下來，您必須連線至您的Experience Platform資料，才能匯出設定檔資料，並在您偏好的目的地啟用該資料。此包含兩個子步驟，如下所述。

首先，您必須透過設定基礎連線，執行呼叫以授權存取Experience Platform中的資料。
然後，使用基本連線ID進行另一個呼叫，您會在其中建立來源連線，以建立與您的Experience Platform資料的連線。

授權存取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"
}

連線至您的Experience Platform資料 connect-to-platform-data

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"
}

連線到串流目的地 connect-to-streaming-destination

目的地步驟概述步驟3

在此步驟中，您會設定與所需串流目的地的連線。此包含兩個子步驟，如下所述。

首先，您必須透過設定基本連線，執行呼叫以授權存取串流目的地。
然後，使用基本連線ID進行另一個呼叫，以建立目標連線，指定儲存體帳戶中要傳送已匯出資料的位置，以及要匯出的資料格式。

授權存取串流目的地

API格式

POST /connections

要求

IMPORTANT

下列範例包含前置詞為//的程式碼註解。這些註解會強調不同串流目的地必須使用不同值的位置。在使用程式碼片段之前，請先移除註解。

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金鑰名稱。在Microsoft檔案中瞭解如何使用SAS金鑰驗證Azure Event Hubs。
{SAS_KEY}： 用於Azure Event Hubs個連線。 填入您的SAS金鑰。在Microsoft檔案中瞭解如何使用SAS金鑰驗證Azure Event Hubs。
{EVENT_HUB_NAMESPACE}： 用於Azure Event Hubs個連線。 填入Platform將串流您資料的Azure Event Hubs名稱空間。如需詳細資訊，請參閱Microsoft檔案中的建立事件中樞名稱空間。

回應

成功的回應包含基底連線的唯一識別碼(id)。將此值儲存為建立目標連線的下一個步驟所需的值。

{
    "id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}

指定儲存位置和資料格式

API格式

POST /targetConnections

要求

IMPORTANT

下列範例包含前置詞為//的程式碼註解。這些註解會強調不同串流目的地必須使用不同值的位置。在使用程式碼片段之前，請先移除註解。

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個連線。 填入Platform將串流您資料的Azure Event Hub名稱。如需詳細資訊，請參閱Microsoft檔案中的建立事件中樞。

回應

成功的回應會傳回新建立之串流目的地的目標連線的唯一識別碼(id)。視需要在後續步驟中儲存此值。

{
    "id": "12ab90c7-519c-4291-bd20-d64186b62da8"
}

建立資料流程

目的地步驟概述步驟4

您現在可以使用前述步驟中取得的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}：以設定檔為基礎的目的地的流程規格識別碼為71471eba-b620-49e4-90fd-23f1fa0174d8。在呼叫中使用此值。
{SOURCE_CONNECTION_ID}：使用您在步驟連線至您的Experience Platform中取得的來源連線ID。
{TARGET_CONNECTION_ID}：使用您在步驟連線到串流目的地中取得的目標連線識別碼。

回應

成功的回應傳回新建立的資料流和etag的識別碼(id)。記下這兩個值。如同您下一步將進行的操作，以啟動對象。

{
    "id": "8256cfb4-17e6-432c-a469-6aedafb16cd5",
    "etag": "8256cfb4-17e6-432c-a469-6aedafb16cd5"
}

啟用新目的地的資料 activate-data

目的地步驟概述步驟5

建立所有連線和資料流程後，您現在可以將設定檔資料啟用至串流平台。在此步驟中，您可以選取要傳送至目的地的對象和設定檔屬性，且可以排程資料並將資料傳送至目的地。

若要將對象啟用至您的新目的地，您必須執行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 audience that you are activating",
        "description": "Description of the audience 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":""7400453a-0000-1a00-0000-62b1c7a90000""
要在您的請求中使用的值： "etag": "7400453a-0000-1a00-0000-62b1c7a90000"

每次成功更新資料流時，etag值都會更新。

{SEGMENT_ID}

提供您要匯出至此目的地的對象ID。若要擷取您要啟動之對象的對象ID，請參閱Experience Platform API參考中的擷取對象定義。

{PROFILE_ATTRIBUTE}

例如, "person.lastName"

op

用於定義更新資料流所需動作的操作呼叫。作業包括： add、replace和remove。若要將對象新增至資料流，請使用add作業。

path

定義要更新的流程部分。將對象新增至資料流時，請使用範例中指定的路徑。

value

您想要用來更新引數的新值。

id

指定您要新增至目的地資料流的對象ID。

name

選擇性。指定您要新增至目的地資料流的對象名稱。請注意，此欄位並非必填欄位，您可以在不提供名稱的情況下成功將對象新增至目的地資料流。

回應

尋找202 OK回應。未傳回任何回應內文。若要驗證請求是否正確，請參閱下一個步驟：驗證資料流程。

驗證資料流程

目的地步驟概述步驟6

在教學課程的最後一步，您應驗證對象和設定檔屬性是否已正確對應至資料流程。

若要驗證，請執行以下的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}：使用上一步驟的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"
                        }
                    }
                ]
            }
        }
    }
],

已匯出資料

IMPORTANT

除了設定檔屬性和步驟啟用資料至您的新目的地中的對象之外，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": "realized"
      }
    }
  },
  "identityMap": {
    "ecid": [
      {
        "id": "14575006536349286404619648085736425115"
      },
      {
        "id": "66478888669296734530114754794777368480"
      }
    ],
    "email_lc_sha256": [
      {
        "id": "655332b5fa2aea4498bf7a290cff017cb4"
      },
      {
        "id": "66baf76ef9de8b42df8903f00e0e3dc0b7"
      }
    ]
  }
}

使用Postman個集合連線至串流目的地 collections

若要以更簡化的方式連線至本教學課程中所述的串流目的地，您可以使用Postman。

Postman是一種工具，可用來進行API呼叫並管理預先定義的呼叫和環境程式庫。

針對此特定教學課程，已附加下列Postman個集合：

AWS Kinesis Postman集合
Azure Event Hubs Postman集合

按一下這裡以下載集合封存。

每個集合分別包含AWS Kinesis和Azure Event Hub的必要要求和環境變數。

如何使用Postman集合 how-to-use-postman-collections

若要使用附加的Postman集合成功連線到目的地，請遵循下列步驟：

下載並安裝Postman；
下載並解壓縮附加的集合；
將集合從對應的資料夾匯入至Postman；
依照本文的指示填寫環境變數；
根據本文中的指示，執行來自Postman的API要求。

API錯誤處理 api-error-handling

本教學課程中的API端點會遵循一般Experience PlatformAPI錯誤訊息原則。如需解譯錯誤回應的詳細資訊，請參閱Platform疑難排解指南中的API狀態碼和要求標頭錯誤。

後續步驟 next-steps

依照本教學課程中的指示，您已成功將Platform連線至其中一個慣用的串流目的地，並設定流向相應目的地的資料流程。傳出資料現在可用於客戶分析目的地或您可能想要執行的任何其他資料操作。如需詳細資訊，請參閱下列頁面：

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6