合作夥伴結構描述設定

Experience Platform 會使用結構，以一致且可重複使用的方式說明資料結構。將資料內嵌至Platform時，會根據XDM結構描述進行建構。 如需結構描述組合模型的詳細資訊，包括設計原則和最佳實務，請參閱 結構描述組合的基本面.

使用Destination SDK建立目的地時，您可以定義自己的合作夥伴結構描述，以供目的地平台使用。 這可讓使用者將設定檔屬性從Platform對應至目的地平台可辨識的特定欄位，而且全都在Platform UI中。

為您的目的地設定合作夥伴結構描述時，您可以微調目的地平台支援的欄位對應，例如：

• 允許使用者對應 phoneNumber XDM屬性至 phone 目標平台支援的屬性。
• 建立動態合作夥伴結構描述，讓Experience Platform可以動態呼叫，以擷取目的地內所有支援屬性的清單。
• 定義目的地平台所需的必要欄位對應。

若要瞭解此元件在何處適合使用Destination SDK建立的整合，請參閱 設定選項 檔案或請參閱操作說明指南 使用Destination SDK來設定以檔案為基礎的目的地.

您可以透過以下方式設定您的結構描述： /authoring/destinations 端點。 請參閱下列API參考頁面，以取得詳細的API呼叫範例，您可在此範例設定本頁面中顯示的元件。

• 建立目的地設定
• 更新目的地設定

本文會說明您可用於目的地的所有支援結構描述設定選項，並顯示客戶會在Platform UI中看到的內容。

支援的整合型別

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

支援的結構描述設定

Destination SDK支援多種結構描述設定：

• 靜態結構描述是透過 profileFields 中的陣列 schemaConfig 區段。 在靜態結構描述中，您會定義應顯示在「 」中Experience PlatformUI的每個目標屬性 profileFields 陣列。 如果您需要更新結構，必須 更新目的地設定.
• 動態結構描述會使用其他目的地伺服器型別，稱為 動態結構描述伺服器，以動態擷取支援的目標屬性，並根據您自己的API產生結構描述。 動態結構描述不會使用 profileFields 陣列。 如果您需要更新結構描述，則無需 更新目的地設定. 而是由動態結構描述伺服器從您的API擷取更新的結構描述。
• 在架構設定中，您可以選擇新增必要（或預先定義）的對應。 這些是使用者可以在Platform UI中檢視的對應，但在設定與您的目的地的連線時無法修改。 例如，您可以強制電子郵件位址列位一律傳送到目的地。

此 schemaConfig 一節會根據您需要的結構描述型別，使用多個設定引數，如下節所示。

建立靜態結構描述

若要使用設定檔屬性建立靜態綱要，請在 profileFields 陣列，如下所示。

"schemaConfig":{
      "profileFields":[
           {
              "name":"phoneNo",
              "title":"phoneNo",
              "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the mobilePhone.number value in Experience Platform could be phoneNo on your side.",
              "type":"string",
              "isRequired":false,
              "readOnly":false,
              "hidden":false
           },
                      {
              "name":"firstName",
              "title":"firstName",
              "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the person.name.firstName value in Experience Platform could be firstName on your side.",
              "type":"string",
              "isRequired":false,
              "readOnly":false,
              "hidden":false
           },
                      {
              "name":"lastName",
              "title":"lastName",
              "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the person.name.lastName value in Experience Platform could be phoneNo on your side.",
              "type":"string",
              "isRequired":false,
              "readOnly":false,
              "hidden":false
           }
        ],
      "useCustomerSchemaForAttributeMapping":false,
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true,
      "segmentNamespaceAllowList": ["someNamespace"],
      "segmentNamespaceDenyList": ["someOtherNamespace"]

}

產生的UI體驗會顯示在下圖中。

當使用者選擇目標對應時，他們可以看到中定義的欄位 profileFields 陣列。

選取屬性後，他們便可在目標欄位欄中看到這些屬性。

建立動態結構描述

Destination SDK支援建立動態合作夥伴結構。 相對於靜態結構描述，動態結構描述不會使用 profileFields 陣列。 動態方案會改用動態方案伺服器，此伺服器會連線至您自己的API，從其中擷取方案設定。

在動態架構設定中， profileFields 陣列由 dynamicSchemaConfig 區段，如下所示。

"schemaConfig":{
   "dynamicSchemaConfig":{
      "dynamicEnum": {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"DYNAMIC_SCHEMA_SERVER_ID",
         "value": "Schema Name",
         "responseFormat": "SCHEMA"
      }
   },
   "profileRequired":true,
   "segmentRequired":true,
   "identityRequired":true
}

必要的對應

在結構描述設定中，除了您的靜態或動態結構描述外，您還可以選擇新增必要（或預先定義）的對應。 這些是使用者可以在Platform UI中檢視的對應，但在設定與您的目的地的連線時無法修改。

例如，您可以強制電子郵件位址列位一律傳送到目的地。

請參閱以下兩個具有必要對應的結構描述設定範例，以及這些範例在 啟用批次目的地工作流程的資料.

"schemaConfig": {
    "requiredMappingsOnly": true,
    "requiredMappings": [
      {
        "sourceType": "text/x.schema-path",
        "source": "personalEmail.address",
        "destination": "personalEmail.address"
      }
    ]
}

"schemaConfig": {
    "requiredMappingsOnly": true,
    "requiredMappings": [
      {
        "destination": "identityMap.ExamplePartner_ID",
        "mandatoryRequired": true,
        "primaryKeyRequired": true
      }
    ]
}

後續步驟

閱讀本文後，您應該更瞭解Destination SDK支援哪些結構描述型別，以及如何設定您的結構描述。

若要深入瞭解其他目的地元件，請參閱下列文章：

• 客戶驗證
• OAuth2驗證
• UI屬性
• 客戶資料欄位
• 身分名稱空間設定
• 支援的對應設定
• 目的地傳遞
• 對象中繼資料設定
• 彙總原則
• 批次設定
• 歷史設定檔資格

Business.Adobe.com 資源