在Adobe的 Real-time Customer Data Platform

本教學課程示範如何使用API呼叫來連線至您的Adobe Experience Platform資料、建立電子郵件行銷目的地、建立資料流至您新建立的目的地，以及啟用資料至您新建立的目的地。

本教學課程在所有範例中都使用Adobe Campaign目標，但所有電子郵件行銷目標的步驟都相同。

概觀——建立目標及啟用區段的步驟

如果您偏好使用Adobe即時CDP中的使用者介面來連接目標並啟用資料，請參閱 Connect destination and Activate profiles and segments to a destination教學課程。

快速入門

本指南需要有效瞭解Adobe Experience Platform的下列元件：

Experience Data Model (XDM) System:組織客戶體驗資料 Experience Platform 的標準化架構。
Catalog Service: Catalog 是資料位置和世系的記錄系統 Experience Platform。
Sandboxes: Experience Platform 提供虛擬沙盒，可將單一執行個體分 Platform 割為不同的虛擬環境，以協助開發和發展數位體驗應用程式。

以下各節提供您需要瞭解的其他資訊，以便在即時CDP中將資料啟動至電子郵件行銷目的地。

收集必要的認證

要完成本教學課程中的步驟，您應準備好下列憑證，這取決於您要連接和啟用區段的目標類型。

對於 Amazon S3連線至電子郵件行銷平台： accessId的 secretKey
對於電子郵件行銷平台的SFTP連線： domain、 port、 username password 或 ssh key （視FTP位置的連線方法而定）

讀取範例API呼叫

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

收集必要和選用標題的值

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

授權：生產者 {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}

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

x-sandbox-name: {SANDBOX_NAME}

注意

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

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

內容類型： application/json

Swagger檔案

您可在Swagger的本教學課程中，找到所有API呼叫的隨附參考檔案。請參閱 Adobe.io上的Flow Service API檔案。建議您同時使用本教學課程和Swagger檔案頁面。

取得可用目的地清單

目標步驟概述步驟1

首先，您應決定要啟動資料的電子郵件行銷目標。首先，請執行呼叫以請求可連接並啟用區段至的可用目的地清單。對端點執行以下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: {IMS_ORG}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}'

回應

成功的響應包含可用目標及其唯一標識符(id)的清單。儲存您計畫使用之目的地的值，因為後續步驟中將會要求它。例如，如果您想要連線區段並傳送至Adobe Campaign，請在回應中尋找下列程式碼片段：

{
    "id": "0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
  "name": "Adobe Campaign",
  ...
  ...
}

連線至您的資 Experience Platform 料

目標步驟概述步驟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: {IMS_ORG}' \
--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 料

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: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
            "name": "Connecting to Unified Profile Service",
            "description": "Optional",
            "connectionSpec": {
                "id": "{CONNECTION_SPEC_ID}",
                "version": "1.0"
            },
            "baseConnectionId": "{BASE_CONNECTION_ID}",
            "data": {
                "format": "CSV",
                "schema": null
            },
            "params" : {}
}'

{BASE_CONNECTION_ID}:使用您在上一步驟中取得的ID。
{CONNECTION_SPEC_ID}:使用——的連接規範 Unified Profile Service ID 8a9c3494-9708-43d7-ae3f-cda01e5030e1。

回應

成功的響應將返回新建立的源id連接的唯一標識符() Unified Profile Service。這可確認您已成功連線至您的 Experience Platform 資料。在後續步驟中，視需要儲存此值。

{
    "id": "ed48ae9b-c774-4b6e-88ae-9bc7748b6e97"
}

連線至電子郵件行銷目的地

目標步驟概述步驟3

在此步驟中，您要設定與所需電子郵件行銷目的地的連線。這包括兩個子步驟，如下所述。

首先，您必須通過設定基本連接來執行授權訪問電子郵件服務提供商的呼叫。
然後，使用基本連接ID，您將進行另一次調用，在其中建立目標連接，該調用指定將傳送導出資料的儲存帳戶中的位置以及將導出的資料的格式。

授權存取電子郵件行銷目的地

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: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "S3 Connection for Adobe Campaign",
    "description": "summer advertising campaign",
    "connectionSpec": {
        "id": "{_CONNECTION_SPEC_ID}",
        "version": "1.0"
    },
    "auth": {
        "specName": "{S3 or SFTP}",
        "params": {
            "accessId": "{ACCESS_ID}",
            "secretKey": "{SECRET_KEY}"
        }
    }
}'

{CONNECTION_SPEC_ID}:使用在步驟獲取可用目標清單中獲得的連接規範ID。
{S3 or SFTP}:填寫此目的地的所需連線類型。在目標目錄中，捲動至您偏好的目標，以查看是否支援S3和／或SFTP連線類型。
{ACCESS_ID}:您的 Amazon S3儲存位置存取ID。
{SECRET_KEY}:S3儲存位置的 Amazon 機密金鑰。

回應

成功的響應包含基本連接的唯一標識符(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: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "TargetConnection for Adobe Campaign",
    "description": "Connection to Adobe Campaign",
    "baseConnectionId": "{BASE_CONNECTION_ID}",
    "connectionSpec": {
        "id": "{CONNECTION_SPEC_ID}",
        "version": "1.0"
    },
    "data": {
        "format": "json",
        "schema": {
            "id": "1.0",
            "version": "1.0"
        }
    },
    "params": {
        "mode": "S3",
        "bucketName": "{BUCKETNAME}",
        "path": "{FILEPATH}",
        "format": "CSV"
    }
}'

{BASE_CONNECTION_ID}:使用您在上述步驟中取得的基本連線ID。
{CONNECTION_SPEC_ID}:使用在步驟獲取可用目標列表中獲得的連接規範。
{BUCKETNAME}:您 Amazon 的S3儲存段，即時CDP將儲存資料導出。
{FILEPATH}:S3儲存桶目 Amazon 錄中的路徑，即時CDP將儲存資料導出。

回應

成功的回應會傳回新建立之目標連線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: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d  '{
   
        "name": "Activate segments to Adobe Campaign",
        "description": "This operation creates a dataflow which we will later use to activate segments to Adobe Campaign",
        "flowSpec": {
            "id": "{FLOW_SPEC_ID}",
            "version": "1.0"
        },
        "sourceConnectionIds": [
            "{SOURCE_CONNECTION_ID}"
        ],
        "targetConnectionIds": [
            "{TARGET_CONNECTION_ID}"
        ],
        "transformations": [
            {
                "name": "GeneralTransform",
                "params": {
                    "segmentSelectors": {
                        "selectors": []
                    },
                    "profileSelectors": {
                        "selectors": []
                    }
                }
            }
        ]
    }

{FLOW_SPEC_ID}:使用您要連線至的電子郵件行銷目的地的流程。要獲取流規範，請在端點上執行GET操 flowspecs 作。請參閱Swagger檔案：https://platform.adobe.io/data/foundation/flowservice/swagger#/Flow%20Specs%20API/getFlowSpecs。在回應中，尋 upsTo 找並複製您要連線至之電子郵件行銷目的地的對應ID。例如，若是Adobe Campaign，請尋找並 upsToCampaign 複製參 id 數。
{SOURCE_CONNECTION_ID}:使用您在步驟「連線至您的Experience Platform」中取得的來源連線ID。
{TARGET_CONNECTION_ID}:使用您在「連線至電子郵件行銷目的地」步驟中取得的目標連線ID。

回應

成功的響應返回新創id建的資料流的ID()和 etag。請記下這兩個值。如同您在下個步驟中所做的，啟動區段。

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

將資料啟動至您的新目的地

目標步驟概述步驟5

建立完所有連線和資料流程後，您現在可以將個人檔案資料啟動至電子郵件行銷平台。在此步驟中，您可以選擇要傳送至目的地的區段和描述檔屬性，並可排程資料並傳送至目的地。

若要將區段啟用至新目的地，您必須執行JSON PATCH作業，如下例所示。您可以在一次呼叫中啟用多個區段和描述檔屬性。若要進一步瞭解JSON修補程式，請參閱 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: {IMS_ORG}' \
--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/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}:使用您在上一步驟中取得的資料流。
{ETAG}:使用您在上一步驟中取得的標籤。
{SEGMENT_ID}:提供您要匯出至此目的地的區段ID。若要擷取您要啟用之區段的區段ID，請前往 https://www.adobe.io/apis/experienceplatform/home/api-reference.html#/，在左側導覽功能表中選取「區段服務API 」，然後在「區段定義」 中尋找 GET /segment/definitions 操作。
{PROFILE_ATTRIBUTE}: 例如, "person.lastName"

回應

尋找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: {IMS_ORG}' \
--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": []
            },
            "segmentSelectors": {
                "selectors": [
                    {
                        "type": "PLATFORM_SEGMENT",
                        "value": {
                            "name": "Men over 50",
                            "description": "",
                            "id": "72ddd79b-6b0a-4e97-a8d2-112ccd81bd02"
                        }
                    }
                ]
            }
        }
    }
],

後續步驟

通過本教程，您成功將即時CDP連接到您首選的電子郵件行銷目標之一，並將資料流設定到相應的目標。傳出資料現在可用於電子郵件促銷活動、目標廣告和許多其他使用案例的目的地。如需詳細資訊，請參閱下列頁面：

在Adobe的 Real-time Customer Data Platform

快速入門

收集必要的認證

讀取範例API呼叫

收集必要和選用標題的值

Swagger檔案

取得可用目的地清單

連線至您的資 Experience Platform 料

授權存取您的資料，位於 Experience Platform

連線至您的資 Experience Platform 料

連線至電子郵件行銷目的地

授權存取電子郵件行銷目的地

指定儲存位置和資料格式

建立資料流

將資料啟動至您的新目的地

驗證資料流

後續步驟

adobe.com 上的資源

本頁內容

檢視下一個: