以Destination SDK建立的目的地的伺服器規格

上次更新: 2023-10-31
  • 建立對象:
  • Admin
    User

目的地伺服器規格會定義從Adobe Experience Platform接收資料的目的地平台型別,以及Platform與目的地之間的通訊引數。 例如:

  • A 串流 目的地伺服器規格會定義從Platform接收HTTP訊息的HTTP伺服器端點。 若要瞭解如何設定端點HTTP呼叫的格式,請閱讀 範本規格 頁面。
  • 一個 Amazon S3 目的地伺服器規格會定義 S3 Platform將匯出檔案的時段名稱和路徑。
  • 一個 SFTP 目的地伺服器規格會定義Platform將匯出檔案的SFTP伺服器的主機名稱、根目錄、通訊連線埠及加密型別。

若要瞭解此元件在何處適合使用Destination SDK建立的整合,請參閱 設定選項 檔案或請參閱下列目的地設定總覽頁面:

您可以透過以下方式設定目的地伺服器規格 /authoring/destination-servers 端點。 請參閱下列API參考頁面,以取得詳細的API呼叫範例,您可在此範例設定本頁面中顯示的元件。

此頁面顯示Destination SDK支援的所有目的地伺服器型別及其所有組態引數。 建立目的地時,請以您自己的值取代引數值。

重要

Destination SDK支援的所有引數名稱和值如下 區分大小寫. 為避免區分大小寫錯誤,請完全依照檔案中所示使用引數名稱和值。

支援的整合型別

如需瞭解哪些型別的整合支援本頁面所述功能的詳細資訊,請參閱下表。

整合型別 支援功能
即時(串流)整合
檔案式(批次)整合

時間 建立更新 目的地伺服器,請使用此頁面中說明的其中一個伺服器型別組態。 根據您的整合需求,請務必將這些範例中的範例引數值取代為您自己的值。

硬式編碼欄位與範本化欄位

透過Destination SDK建立目的地伺服器時,您可以藉由將組態引數硬式編碼到組態中,或使用範本化欄位來定義組態引數值。 範本化欄位可讓您從Platform UI讀取使用者提供的值。

目的地伺服器引數有兩個可設定的欄位。 這些選項指定您是使用硬式編碼值或範本化值。

參數 類型 說明
templatingStrategy 字串 必要. 定義是否透過 value 欄位或UI中使用者可設定的值。 支援的值:
  • NONE:當您透過硬式編碼引數值時,請使用此值 value 引數(請參閱下一列)。 範例:"value": "my-storage-bucket".
  • PEBBLE_V1:如果您希望使用者在UI中提供引數值,請使用此值。 範例:"value": "{{customerData.bucket}}"
value 字串 必要. 定義引數值。 支援的值型別:
  • 硬式編碼值:使用硬式編碼值(例如 "value": "my-storage-bucket")時,以免使用者在UI中輸入引數值。 硬式編碼值時, templatingStrategy 應一律設為 NONE.
  • 範本化值:使用範本化值(例如 "value": "{{customerData.bucket}}")時,以免使用者在UI中提供引數值。 使用範本化值時, templatingStrategy 應一律設為 PEBBLE_V1.

何時使用硬式編碼欄位或範本化欄位

根據您建立的整合型別,硬式編碼和範本化欄位在Destination SDK中都有各自的用途。

無需使用者輸入即可連線到您的目的地

當使用者 連線到您的目的地 在Platform UI中,您可能會想在不輸入的情況下處理目的地連線程式。

若要這麼做,您可以在伺服器規格中硬式編碼目的地平台連線引數。 當您在目標伺服器設定中使用硬式編碼引數值時,Adobe Experience Platform與您的目標平台之間的連線無需使用者輸入即可處理。

在以下範例中,合作夥伴會使用建立資料登陸區域目的地伺服器 path.value 欄位進行硬式編碼。

{
   "name":"Data Landing Zone destination server",
   "destinationServerType":"FILE_BASED_DLZ",
   "fileBasedDlzDestination":{
      "path":{
         "templatingStrategy":"NONE",
         "value":"Your/hardcoded/path/here"
      },
      "useCase": "Your use case"
   }
}

因此,當使用者透過 目的地連線教學課程,則不會看到 驗證步驟. 而是由Platform處理驗證,如下圖所示。

顯示Platform與DLZ目的地之間驗證畫面的Ui影像。

使用使用者輸入連線到您的目的地

當Platform和您的目的地之間的連線應該根據平台UI中的特定使用者輸入建立(例如選取API端點或提供欄位值)時,您可以使用伺服器規格中的範本化欄位來讀取使用者輸入並連線到您的目的地平台。

在以下範例中,合作夥伴會建立 即時(串流) 整合與 url.value 欄位使用範本化引數 {{customerData.region}} 根據使用者輸入個人化部分API端點。

{
   "name":"Templatized API endpoint example",
   "destinationServerType":"URL_BASED",
   "urlBasedDestination":{
      "url":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"https://api.yourcompany.com/data/{{customerData.region}}/items"
      }
   }
}

若要讓使用者可選擇從Platform UI選取值,請 region 引數也必須在以下位置定義: 目的地設定 作為客戶資料欄位,如下所示:

"customerDataFields":[
   {
      "name":"region",
      "title":"Region",
      "description":"Select an option",
      "type":"string",
      "isRequired":true,
      "readOnly":false,
      "enum":[
         "US",
         "EU"
      ]
   }

因此,當使用者透過 目的地連線教學課程,使用者必須先選取地區,才能連線至目的地平台。 當他們連線到目的地時,範本化的欄位 {{customerData.region}} 會取代為使用者在UI中選取的值,如下圖所示。

顯示具有地區選擇器之目的地連線畫面的Ui影像。

即時(串流)目的地伺服器

此目的地伺服器型別可讓您透過HTTP請求,將資料從Adobe Experience Platform匯出至您的目的地。 伺服器設定包含接收訊息之伺服器(您這端的伺服器)的相關資訊。

此程式會以一系列HTTP訊息的形式將使用者資料傳送至您的目的地平台。 以下引數構成HTTP伺服器規格範本。

以下範例顯示即時(串流)目的地的目的地伺服器設定範例。

{
   "name":"Your destination server name",
   "destinationServerType":"URL_BASED",
   "urlBasedDestination":{
      "url":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{YOUR_API_ENDPOINT}"
      }
   }
}
參數 類型 說明
name 字串 必要. 代表伺服器的易記名稱,僅對Adobe可見。 合作夥伴或客戶看不到此名稱。 範例:Moviestar destination server
destinationServerType 字串 必要. 將此專案設為 URL_BASED 適用於串流目的地。
templatingStrategy 字串 必要.
  • 使用 PEBBLE_V1 如果您在「 」中使用範本化欄位,而不是硬式編碼值, value 欄位。 如果您有類似以下的端點,請使用此選項: https://api.moviestar.com/data/{{customerData.region}}/items,使用者必須從Platform UI中選取端點區域。
  • 使用 NONE 如果Adobe端不需要範本化轉換,例如,如果您有類似以下的端點: https://api.moviestar.com/data/items
value 字串 必要. 填寫Experience Platform應連線的API端點位址。

Amazon S3 目的地伺服器

此目的地伺服器可讓您將包含Adobe Experience Platform資料的檔案匯出至Amazon S3儲存空間。

以下範例顯示Amazon S3目的地的目的地伺服器設定範例。

{
   "name":"Amazon S3 destination",
   "destinationServerType":"FILE_BASED_S3",
   "fileBasedS3Destination":{
      "bucket":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.bucket}}"
      },
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      }
   }
}
參數 類型 說明
name 字串 目的地伺服器的名稱。
destinationServerType 字串 根據您的目的地平台設定此值。 若要將檔案匯出至 Amazon S3 值區,將此值設為 FILE_BASED_S3.
fileBasedS3Destination.bucket.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 bucket.value 欄位。
  • 如果您希望使用者在Experience PlatformUI中輸入自己的貯體名稱,請將此值設為 PEBBLE_V1. 在此情況下,您必須將 value 欄位以讀取值 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼貯體名稱進行整合,例如 "bucket.value":"MyBucket",然後將此值設為 NONE.
fileBasedS3Destination.bucket.value 字串 的名稱 Amazon S3 要由此目的地使用的貯體。 這可以是範本化欄位,將讀取下列欄位的值: 客戶資料欄位 填入(如上述範例所示)或硬式編碼值(例如 "value":"MyBucket".
fileBasedS3Destination.path.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 path.value 欄位。
  • 如果您希望使用者在Experience PlatformUI中輸入自己的路徑,請將此值設為 PEBBLE_V1. 在此情況下,您必須將 path.value 欄位以讀取值 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼路徑進行整合,例如 "bucket.value":"/path/to/MyBucket",然後將此值設為 NONE.
fileBasedS3Destination.path.value 字串 的路徑 Amazon S3 要由此目的地使用的貯體。 這可以是範本化欄位,將讀取下列欄位的值: 客戶資料欄位 填入(如上述範例所示)或硬式編碼值(例如 "value":"/path/to/MyBucket".

SFTP 目的地伺服器

此目的地伺服器可讓您將包含Adobe Experience Platform資料的檔案匯出至 SFTP 儲存伺服器。

以下範例顯示SFTP目的地的目的地伺服器設定範例。

{
   "name":"File-based SFTP destination server",
   "destinationServerType":"FILE_BASED_SFTP",
   "fileBasedSFTPDestination":{
      "rootDirectory":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.rootDirectory}}"
      },
      "hostName":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.hostName}}"
      },
      "port":22,
      "encryptionMode":"PGP"
   }
}
參數 類型 說明
name 字串 目的地伺服器的名稱。
destinationServerType 字串 根據您的目的地平台設定此值。 若要將檔案匯出至 SFTP 目的地,設定為 FILE_BASED_SFTP.
fileBasedSFTPDestination.rootDirectory.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 rootDirectory.value 欄位。
  • 如果您希望使用者在Experience PlatformUI中輸入自己的根目錄路徑,請將此值設為 PEBBLE_V1. 在此情況下,您必須將 rootDirectory.value 欄位來讀取使用者提供的值,從 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼的根目錄路徑進行整合,例如 "rootDirectory.value":"Storage/MyDirectory",然後將此值設為 NONE.
fileBasedSFTPDestination.rootDirectory.value 字串 存放匯出檔案的目錄路徑。 這可以是範本化欄位,將讀取下列欄位的值: 客戶資料欄位 填入(如上述範例所示)或硬式編碼值(例如 "value":"Storage/MyDirectory"
fileBasedSFTPDestination.hostName.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 hostName.value 欄位。
  • 如果您希望使用者在Experience PlatformUI中輸入自己的主機名稱,請將此值設為 PEBBLE_V1. 在此情況下,您必須將 hostName.value 欄位來讀取使用者提供的值,從 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼主機名稱進行整合,例如 "hostName.value":"my.hostname.com",然後將此值設為 NONE.
fileBasedSFTPDestination.hostName.value 字串 SFTP伺服器的主機名稱。 這可以是範本化欄位,將讀取下列欄位的值: 客戶資料欄位 填入(如上述範例所示)或硬式編碼值(例如 "hostName.value":"my.hostname.com".
port 整數 SFTP檔案伺服器連線埠。
encryptionMode 字串 指示是否使用檔案加密。 支援的值:
  • PGP
  • None

Azure Data Lake Storage (ADLS)目的地伺服器

此目的地伺服器可讓您將包含Adobe Experience Platform資料的檔案匯出至 Azure Data Lake Storage 帳戶。

以下範例顯示的「 」目的地伺服器設定範例。 Azure Data Lake Storage 目的地。

{
   "name":"ADLS destination server",
   "destinationServerType":"FILE_BASED_ADLS_GEN2",
   "fileBasedAdlsGen2Destination":{
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      }
   }
}
參數 類型 說明
name 字串 目的地連線的名稱。
destinationServerType 字串 根據您的目的地平台設定此值。 的 Azure Data Lake Storage 目的地,將此專案設為 FILE_BASED_ADLS_GEN2.
fileBasedAdlsGen2Destination.path.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 path.value 欄位。
  • 如果您希望使用者輸入其 ADLS 在Experience Platform UI中的資料夾路徑,將此值設定為 PEBBLE_V1. 在此情況下,您必須將 path.value 欄位以讀取值 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼路徑進行整合,例如 "abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/",然後將此值設為 NONE.
fileBasedAdlsGen2Destination.path.value 字串 路徑至 ADLS 儲存資料夾。 這可以是範本化欄位,將讀取下列欄位的值: 客戶資料欄位 填入(如上述範例所示)或硬式編碼值(例如 abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/.

Azure Blob Storage 目的地伺服器

此目的地伺服器可讓您將包含Adobe Experience Platform資料的檔案匯出至 Azure Blob Storage 容器。

以下範例顯示的「 」目的地伺服器設定範例。 Azure Blob Storage 目的地。

{
   "name":"Blob destination server",
   "destinationServerType":"FILE_BASED_AZURE_BLOB",
   "fileBasedAzureBlobDestination":{
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      },
      "container":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.container}}"
      }
   }
}
參數 類型 說明
name 字串 目的地連線的名稱。
destinationServerType 字串 根據您的目的地平台設定此值。 的 Azure Blob Storage 目的地,將此專案設為 FILE_BASED_AZURE_BLOB.
fileBasedAzureBlobDestination.path.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 path.value 欄位。
  • 如果您希望使用者自行輸入 Azure Blob 儲存體帳戶URI 在Experience Platform UI中,將此值設為 PEBBLE_V1. 在此情況下,您必須將 path.value 欄位以讀取值 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼路徑進行整合,例如 "path.value": "https://myaccount.blob.core.windows.net/",然後將此值設為 NONE.
fileBasedAzureBlobDestination.path.value 字串 路徑至 Azure Blob 儲存。 這可以是範本化欄位,將讀取下列欄位的值: 客戶資料欄位 填入(如上述範例所示)或硬式編碼值(例如 https://myaccount.blob.core.windows.net/.
fileBasedAzureBlobDestination.container.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 container.value 欄位。
  • 如果您希望使用者自行輸入 Azure Blob 容器名稱 在Experience Platform UI中,將此值設為 PEBBLE_V1. 在此情況下,您必須將 container.value 欄位以讀取值 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼容器名稱進行整合,例如 "path.value: myContainer",然後將此值設為 NONE.
fileBasedAzureBlobDestination.container.value 字串 用於此目的地的Azure Blob儲存體容器的名稱。 這可以是範本化欄位,將讀取下列欄位的值: 客戶資料欄位 填入(如上述範例所示)或硬式編碼值(例如 myContainer.

Data Landing Zone (DLZ)目的地伺服器

此目的地伺服器可讓您將包含Platform資料的檔案匯出至 Data Landing Zone 儲存。

以下範例顯示的目標伺服器設定範例: Data Landing Zone (DLZ)目的地。

{
   "name":"Data Landing Zone destination server",
   "destinationServerType":"FILE_BASED_DLZ",
   "fileBasedDlzDestination":{
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      },
      "useCase": "Your use case"
   }
}
參數 類型 說明
name 字串 目的地連線的名稱。
destinationServerType 字串 根據您的目的地平台設定此值。 的 Data Landing Zone 目的地,將此專案設為 FILE_BASED_DLZ.
fileBasedDlzDestination.path.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 path.value 欄位。
  • 如果您希望使用者自行輸入 Data Landing Zone 帳戶在Experience Platform UI中,將此值設定為 PEBBLE_V1. 在此情況下,您必須將 path.value 欄位以讀取值 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼路徑進行整合,例如 "path.value": "https://myaccount.blob.core.windows.net/",然後將此值設為 NONE.
fileBasedDlzDestination.path.value 字串 目的地資料夾的路徑,此資料夾將裝載匯出的檔案。

Google Cloud Storage 目的地伺服器

此目的地伺服器可讓您將包含Platform資料的檔案匯出至 Google Cloud Storage 帳戶。

以下範例顯示的目標伺服器設定範例: Google Cloud Storage 目的地。

{
   "name":"Google Cloud Storage Server",
   "destinationServerType":"FILE_BASED_GOOGLE_CLOUD",
   "fileBasedGoogleCloudStorageDestination":{
      "bucket":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.bucket}}"
      },
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      }
   }
}
參數 類型 說明
name 字串 目的地連線的名稱。
destinationServerType 字串 根據您的目的地平台設定此值。 的 Google Cloud Storage 目的地,將此專案設為 FILE_BASED_GOOGLE_CLOUD.
fileBasedGoogleCloudStorageDestination.bucket.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 bucket.value 欄位。
  • 如果您希望使用者自行輸入 Google Cloud Storage 在Experience PlatformUI中儲存貯體名稱,將此值設為 PEBBLE_V1. 在此情況下,您必須將 bucket.value 欄位以讀取值 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼貯體名稱進行整合,例如 "bucket.value": "my-bucket",然後將此值設為 NONE.
fileBasedGoogleCloudStorageDestination.bucket.value 字串 的名稱 Google Cloud Storage 要由此目的地使用的貯體。 這可以是範本化欄位,將讀取下列欄位的值: 客戶資料欄位 填入(如上述範例所示)或硬式編碼值(例如 "value": "my-bucket".
fileBasedGoogleCloudStorageDestination.path.templatingStrategy 字串 必要. 根據中使用的值型別設定此值 path.value 欄位。
  • 如果您希望使用者自行輸入 Google Cloud Storage Experience PlatformUI中的貯體路徑,請將此值設為 PEBBLE_V1. 在此情況下,您必須將 path.value 欄位以讀取值 客戶資料欄位 已由使用者填入。 此使用案例如上述範例所示。
  • 如果您使用硬式編碼路徑進行整合,例如 "path.value": "/path/to/my-bucket",然後將此值設為 NONE.
fileBasedGoogleCloudStorageDestination.path.value 字串 的路徑 Google Cloud Storage 此目的地要使用的資料夾。 這可以是範本化欄位,將讀取下列欄位的值: 客戶資料欄位 填入(如上述範例所示)或硬式編碼值(例如 "value": "/path/to/my-bucket".

後續步驟

閱讀本文後,您應該更加瞭解什麼是目的地伺服器規格,以及如何進行設定。

若要深入瞭解其他目的地伺服器元件,請參閱下列文章:

本頁內容