若要瞭解Adobe端的訊息格式及設定檔設定和轉換程式,請熟悉下列Experience Platform概念:
xdm:identityMap
在 XDM欄位字典.status
欄位,請閱讀以下檔案: 區段會籍詳細資料結構描述欄位群組.Destination SDK支援的所有引數名稱和值皆為 區分大小寫. 為避免區分大小寫錯誤,請完全按照檔案中所示使用引數名稱和值。
請參閱下表,以取得關於哪些型別的整合支援本頁面所述功能的詳細資訊。
整合型別 | 支援功能 |
---|---|
即時(串流)整合 | 是 |
檔案式(批次)整合 | 是(只有下圖中的步驟1和2) |
此頁面說明從Adobe Experience Platform匯出至目的地的資料中的訊息格式和設定檔轉換。
Adobe Experience Platform會以各種資料格式,將資料匯出至許多目的地。 目的地型別的一些範例為廣告平台(Google)、社交網路(Facebook)和雲端儲存位置(Amazon S3、Azure事件中樞)。
Experience Platform可以調整匯出設定檔的訊息格式,以符合您側的預期格式。 若要瞭解此自訂,請務必注意下列概念:
Experience Platform使用XDM結構描述,以一致且可重複使用的方式描述資料結構。
來源XDM結構描述(1):此專案是指客戶在Experience Platform中使用的結構描述。 在Experience Platform中、在 對應步驟 在啟用目的地工作流程中,客戶會將欄位從其XDM結構描述對應到您目的地的目標結構描述(2)。
目標XDM結構描述(2):根據目的地預期格式的JSON標準結構描述(3)和目的地可解譯的屬性,您可以在目標XDM結構描述中定義設定檔屬性和身分。 您可以在目的地設定的下列位置執行此操作: schemaConfig 和 identityNamespaces 物件。
目的地設定檔屬性的JSON標準結構描述(3):此範例代表 JSON結構 平台支援的所有設定檔屬性及其型別(例如:物件、字串、陣列)。 目的地可支援的範例欄位 firstName
, lastName
, gender
, email
, phone
, productId
, productName
、等等。 您需要 訊息轉換範本 量身打造資料匯出Experience Platform後的預期格式。
根據上述結構描述轉換,以下說明來源XDM結構描述和合作夥伴端範例結構描述之間的設定檔設定如何變更:
為了示範設定檔轉換程式,以下範例使用Adobe Experience Platform中的三個常見設定檔屬性: 名字, 姓氏、和 電子郵件地址.
客戶將屬性從來源XDM結構描述對應到Adobe Experience Platform UI中的合作夥伴XDM結構描述,在 對應 步驟 啟用目的地工作流程.
假設您的平台可以接收如下的訊息格式:
POST https://YOUR_REST_API_URL/users/
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"attributes":
{
"first_name": "Yours",
"last_name": "Truly",
"external_id": "yourstruly@adobe.com"
}
}
考慮訊息格式,對應的轉換如下:
Adobe端的合作夥伴XDM結構描述中的屬性 | 轉換 | 您這邊HTTP訊息中的屬性 |
---|---|---|
_your_custom_schema.firstName |
attributes.first_name |
first_name |
_your_custom_schema.lastName |
attributes.last_name |
last_name |
personalEmail.address |
attributes.external_id |
external_id |
若要進一步瞭解頁面上下方的範例,請務必瞭解Experience Platform中的設定檔結構。
設定檔有3個區段:
segmentMembership
(永遠出現在設定檔上)
realized
或 exited
.identityMap
(永遠出現在設定檔上)
.value
路徑(如果屬性出現在設定檔上) (請參閱 lastName
屬性(來自範例1)。 如果設定檔上沒有這些變數,則不會包含 .value
路徑(請參閱 firstName
屬性(來自範例1)。.value
路徑。 所有存在於設定檔上的對應屬性都會出現在屬性對應中。 不會出現不存在的專案(請參閱範例2 - firstName
屬性不存在於設定檔上)。請參閱以下兩個Experience Platform設定檔範例:
segmentMembership
, identityMap
自由格式屬性的和屬性{
"segmentMembership": {
"ups": {
"11111111-1111-1111-1111-111111111111": {
"lastQualificationTime": "2019-04-15T02:41:50.000+0000",
"status": "realized"
}
}
},
"identityMap": {
"mobileIds": [
{
"id": "e86fb215-0921-4537-bc77-969ff775752c"
}
]
},
"attributes": {
"firstName": {
},
"lastName": {
"value": "lastName"
}
}
}
segmentMembership
, identityMap
預先定義屬性的和屬性{
"segmentMembership": {
"ups": {
"11111111-1111-1111-1111-111111111111": {
"lastQualificationTime": "2019-04-15T02:41:50.000+0000",
"status": "realized"
}
}
},
"identityMap": {
"mobileIds": [
{
"id": "e86fb215-0921-4537-bc77-969ff775752c"
}
]
},
"attributes": {
"lastName": "lastName"
}
}
Adobe使用 Pebble範本,類似於 金家,將欄位從Experience PlatformXDM結構描述轉換為目的地支援的格式。
本節提供如何進行這些轉換的數個範例 — 從輸入XDM結構描述,透過範本,以及輸出為目的地接受的裝載格式。 透過增加複雜性來呈現以下範例,如下所示:
若要轉換匯出至目的地的設定檔屬性,請參閱以下的JSON和程式碼範例。
如需Adobe Experience Platform中所有可用設定檔屬性的清單,請參閱 XDM欄位字典.
輸入
設定檔1:
{
"attributes": {
"firstName": {
"value": "Hermione"
},
"birthDate": {}
}
}
設定檔2:
{
"attributes": {
"firstName": {
"value": "Harry"
},
"birthDate": {
"value": "1980/07/31"
}
}
}
範本
{
"profiles": [
{% for profile in input.profiles %}
{
{% for attribute in profile.attributes %}
"{{ attribute.key }}":
{% if attribute.value is empty %}
null
{% else %}
"{{ attribute.value.value }}"
{% endif %}
{% if not loop.last %},{% endif %}
{% endfor %}
}{% if not loop.last %},{% endif %}
{% endfor %}
]
}
結果
{
"profiles": [
{
"firstName": "Hermione",
"birthDate": null
},
{
"firstName": "Harry",
"birthDate": "1980/07/31"
}
]
}
此 segmentMembership XDM屬性會通知設定檔是哪些區段的成員。
對於 status
欄位,請閱讀以下檔案: 區段會籍詳細資料結構描述欄位群組.
輸入
設定檔1:
{
"segmentMembership": {
"ups": {
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "realized"
},
"788d8874-8007-4253-92b7-ee6b6c20c6f3": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "realized"
},
"8f812592-3f06-416b-bd50-e7831848a31a": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "exited"
}
}
}
}
設定檔2:
{
"segmentMembership": {
"ups": {
"32396e4b-16f6-4033-9702-fc69b5e24e7c": {
"lastQualificationTime": "2021-08-20T17:23:04Z",
"status": "realized"
},
"af854278-894a-4192-a96b-320fbf2623fd": {
"lastQualificationTime": "2021-08-20T16:44:37Z",
"status": "realized"
},
"66505bf9-bc08-4bac-afbc-8b6706650ea4": {
"lastQualificationTime": "2019-08-20T17:23:04Z",
"status": "realized"
}
}
}
}
範本
{
"profiles": [
{% for profile in input.profiles %}
{
"AdobeExperiencePlatformSegments": {
"add": [
{% for segment in profile.segmentMembership.ups | added %}
"{{ segment.key }}"{% if not loop.last %},{% endif %}
{% endfor %}
],
"remove": [
{# Alternative syntax for filtering segments by status: #}
{% for segment in removedSegments(profile.segmentMembership.ups) %}
"{{ segment.key }}"{% if not loop.last %},{% endif %}
{% endfor %}
]
}
}{% if not loop.last %},{% endif %}
{% endfor %}
]
}
結果
{
"profiles": [
{
"AdobeExperiencePlatformSegments": {
"add": [
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075",
"788d8874-8007-4253-92b7-ee6b6c20c6f3"
],
"remove": [
"8f812592-3f06-416b-bd50-e7831848a31a"
]
}
},
{
"AdobeExperiencePlatformSegments": {
"add": [
"32396e4b-16f6-4033-9702-fc69b5e24e7c",
"af854278-894a-4192-a96b-320fbf2623fd",
"66505bf9-bc08-4bac-afbc-8b6706650ea4"
],
"remove": [
]
}
}
]
}
如需Experience Platform中身分的相關資訊,請參閱 身分名稱空間總覽.
輸入
設定檔1:
{
"identityMap": {
"email": [
{
"id": "johndoe@example.com"
},
{
"id": "jd@example.com"
}
],
"external_id": [
{
"id": "123456"
}
]
}
}
設定檔2:
{
"identityMap": {
"email": [
{
"id": "jane.doe@example.com"
}
]
}
}
範本
{
"profiles": [
{% for profile in input.profiles %}
{
"identities": [
{% for email in profile.identityMap.email %}
{
"type": "email",
"id": "{{ email.id }}"
}{% if not loop.last %},{% endif %}
{% endfor %}
{# Add a comma only if you have both emails and external_ids. #}
{% if profile.identityMap.email is not empty and profile.identityMap.external_id is not empty %}
,
{% endif %}
{% for external in profile.identityMap.external_id %}
{
"type": "external_id",
"id": "{{ external.id }}"
}{% if not loop.last %},{% endif %}
{% endfor %}
]
}{% if not loop.last %},{% endif %}
{% endfor %}
]
}
結果
{
"profiles": [
{
"identities": [
{
"type": "email",
"id": "johndoe@example.com"
},
{
"type": "email",
"id": "jd@example.com"
},
{
"type": "external_id",
"id": "123456"
}
]
},
{
"identities": [
{
"type": "email",
"id": "jane.doe@example.com"
}
]
}
]
}
本節提供AdobeXDM結構描述和合作夥伴目的地結構描述之間常用轉換的範例。
以下範例說明如何轉換區段會籍和身分格式,並將其輸出至您的目的地。
輸入
設定檔1:
{
"identityMap": {
"email": [
{
"id": "johndoe@example.com"
},
{
"id": "jd@example.com"
}
],
"external_id": [
{
"id": "123456"
}
]
},
"segmentMembership": {
"ups": {
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "realized"
},
"788d8874-8007-4253-92b7-ee6b6c20c6f3": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "realized"
},
"8f812592-3f06-416b-bd50-e7831848a31a": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "exited"
}
}
}
}
設定檔2:
{
"identityMap": {
"email": [
{
"id": "jane.doe@example.com"
}
]
},
"segmentMembership": {
"ups": {
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075": {
"lastQualificationTime": "2021-08-31T10:01:42Z",
"status": "realized"
}
}
}
}
範本
{
"profiles": [
{% for profile in input.profiles %}
{
"identities": [
{% for email in profile.identityMap.email %}
{
"type": "email",
"id": "{{ email.id }}"
}{% if not loop.last %},{% endif %}
{% endfor %}
{# Add a comma only if you have both emails and external_ids. #}
{% if profile.identityMap.email is not empty and profile.identityMap.external_id is not empty %}
,
{% endif %}
{% for external in profile.identityMap.external_id %}
{
"type": "external_id",
"id": "{{ external.id }}"
}{% if not loop.last %},{% endif %}
{% endfor %}
],
"AdobeExperiencePlatformSegments": {
"add": [
{% for segment in profile.segmentMembership.ups | added %}
"{{ segment.key }}"{% if not loop.last %},{% endif %}
{% endfor %}
],
"remove": [
{# Alternative syntax for filtering segments by status: #}
{% for segment in removedSegments(profile.segmentMembership.ups) %}
"{{ segment.key }}"{% if not loop.last %},{% endif %}
{% endfor %}
]
}
}{% if not loop.last %},{% endif %}
{% endfor %}
]
}
結果
此 json
以下表示從Adobe Experience Platform匯出的資料。
{
"profiles": [
{
"identities": [
{
"type": "email",
"id": "johndoe@example.com"
},
{
"type": "email",
"id": "jd@example.com"
},
{
"type": "external_id",
"id": "123456"
}
],
"AdobeExperiencePlatformSegments": {
"add": [
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075",
"788d8874-8007-4253-92b7-ee6b6c20c6f3"
],
"remove": [
"8f812592-3f06-416b-bd50-e7831848a31a"
]
}
},
{
"identities": [
{
"type": "email",
"id": "jane.doe@example.com"
}
],
"AdobeExperiencePlatformSegments": {
"add": [
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075"
],
"remove": []
}
}
]
}
本節提供AdobeXDM結構描述和合作夥伴目的地結構描述之間常用轉換的範例。
另一個常見的使用案例是匯出包含區段會籍、身分(例如:電子郵件地址、電話號碼、廣告ID)和個人資料屬性的資料。 若要以此方式匯出資料,請參閱下列範例:
輸入
設定檔1:
{
"attributes": {
"firstName": {
"value": "Hermione"
},
"birthDate": {}
},
"identityMap": {
"email": [
{
"id": "johndoe@example.com"
},
{
"id": "jd@example.com"
}
],
"external_id": [
{
"id": "123456"
}
]
},
"segmentMembership": {
"ups": {
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "realized"
},
"788d8874-8007-4253-92b7-ee6b6c20c6f3": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "realized"
},
"8f812592-3f06-416b-bd50-e7831848a31a": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "exited"
}
}
}
}
設定檔2:
{
"attributes": {
"firstName": {
"value": "Harry"
},
"birthDate": {
"value": "1980/07/31"
}
},
"identityMap": {
"email": [
{
"id": "harry.p@example.com"
}
]
},
"segmentMembership": {
"ups": {
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075": {
"lastQualificationTime": "2019-11-20T13:15:49Z",
"status": "realized"
}
}
}
}
範本
{
"profiles": [
{% for profile in input.profiles %}
{
"attributes": {
{% for attribute in profile.attributes %}
"{{ attribute.key }}":
{% if attribute.value is empty %}
null
{% else %}
"{{ attribute.value.value }}"
{% endif %}
{% if not loop.last %},{% endif %}
{% endfor %}
},
"identities": [
{% for email in profile.identityMap.email %}
{
"type": "email",
"id": "{{ email.id }}"
}{% if not loop.last %},{% endif %}
{% endfor %}
{# Add a comma only if we have both emails and external_ids. #}
{% if profile.identityMap.email is not empty and profile.identityMap.external_id is not empty %}
,
{% endif %}
{% for external in profile.identityMap.external_id %}
{
"type": "external_id",
"id": "{{ external.id }}"
}{% if not loop.last %},{% endif %}
{% endfor %}
],
"AdobeExperiencePlatformSegments": {
"add": [
{% for segment in profile.segmentMembership.ups | added %}
"{{ segment.key }}"{% if not loop.last %},{% endif %}
{% endfor %}
],
"remove": [
{# Alternative syntax for filtering segments by status: #}
{% for segment in removedSegments(profile.segmentMembership.ups) %}
"{{ segment.key }}"{% if not loop.last %},{% endif %}
{% endfor %}
]
}
}
]
}
結果
此 json
以下表示從Adobe Experience Platform匯出的資料。
{
"profiles": [
{
"attributes": {
"firstName": "Hermione",
"birthDate": null
},
"identities": [
{
"type": "email",
"id": "johndoe@example.com"
},
{
"type": "email",
"id": "jd@example.com"
},
{
"type": "external_id",
"id": "123456"
}
],
"AdobeExperiencePlatformSegments": {
"add": [
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075",
"788d8874-8007-4253-92b7-ee6b6c20c6f3"
],
"remove": [
"8f812592-3f06-416b-bd50-e7831848a31a"
]
}
},
{
"attributes": {
"firstName": "Harry",
"birthDate": "1980/07/21"
},
"identities": [
{
"type": "email",
"id": "harry.p@example.com"
}
],
"AdobeExperiencePlatformSegments": {
"add": [
"36a51c13-9dd6-4d2c-8aa3-07d785ea5075"
],
"remove": []
}
}
]
}
當您使用 可設定的彙總 在目標設定中,您可以根據區段ID、區段別名、區段會籍或身分名稱空間等條件,將匯出至目標的設定檔分組。
在訊息轉換範本中,您可以存取上述彙總索引鍵,如下列各節的範例所示。 使用彙總金鑰來建構匯出為Experience Platform的HTTP訊息,以符合目的地預期的格式和速率限制。
如果您使用 可設定的彙總 並設定 includeSegmentId
若設為true,則匯出至目的地的HTTP訊息中的設定檔會依區段ID分組。 請參閱以下說明如何存取範本中的區段ID。
輸入
請考量下列四個設定檔,其中:
788d8874-8007-4253-92b7-ee6b6c20c6f3
8f812592-3f06-416b-bd50-e7831848a31a
設定檔1:
{
"attributes":{
"firstName":{
"value":"Hermione"
}
},
"segmentMembership":{
"ups":{
"788d8874-8007-4253-92b7-ee6b6c20c6f3":{
"lastQualificationTime":"2020-11-20T13:15:49Z",
"status":"realized"
}
}
}
}
設定檔2:
{
"attributes":{
"firstName":{
"value":"Harry"
}
},
"segmentMembership":{
"ups":{
"788d8874-8007-4253-92b7-ee6b6c20c6f3":{
"lastQualificationTime":"2020-11-20T13:15:49Z",
"status":"realized"
}
}
}
}
設定檔3:
{
"attributes":{
"firstName":{
"value":"Tom"
}
},
"segmentMembership":{
"ups":{
"8f812592-3f06-416b-bd50-e7831848a31a":{
"lastQualificationTime":"2021-02-20T12:00:00Z",
"status":"realized"
}
}
}
}
設定檔4:
{
"attributes":{
"firstName":{
"value":"Jerry"
}
},
"segmentMembership":{
"ups":{
"8f812592-3f06-416b-bd50-e7831848a31a":{
"lastQualificationTime":"2021-02-20T12:00:00Z",
"status":"realized"
},
"788d8874-8007-4253-92b7-ee6b6c20c6f3":{
"lastQualificationTime":"2020-11-20T13:15:49Z",
"status":"realized"
}
}
}
}
範本
請注意以下方式 audienceId
用於範本中存取區段ID。 此範例假設您使用 audienceId
目的地分類法中的區段會籍。 您可以改用任何其他欄位名稱,視您自己的分類法而定。
{
"audienceId": "{{ input.aggregationKey.segmentId }}",
"profiles": [
{% for profile in input.profiles %}
{
"first_name": "{{ profile.attributes.firstName.value }}"
}{% if not loop.last %},{% endif %}
{% endfor %}
]
}
結果
將設定檔匯出至目的地時,會根據其區段ID將設定檔分割為兩個群組。
{
"audienceId":"788d8874-8007-4253-92b7-ee6b6c20c6f3",
"profiles":[
{
"firstName":"Hermione"
},
{
"firstName":"Harry"
},
{
"firstName":"Jerry"
}
]
}
{
"audienceId":"8f812592-3f06-416b-bd50-e7831848a31a",
"profiles":[
{
"firstName":"Tom"
},
{
"firstName":"Jerry"
}
]
}
如果您使用 可設定的彙總 並設定 includeSegmentId
若設為true,您也可以在範本中存取區段別名。
將以下行新增至範本,以存取按區段別名分組的匯出設定檔。
customerList={{input.aggregationKey.segmentAlias}}
如果您使用 可設定的彙總 並設定 includeSegmentId
和 includeSegmentStatus
若設為true,則您可存取範本中的區段狀態。 如此一來,您就可以根據應從區段新增還是移除設定檔,將匯出至目的地的HTTP訊息中的設定檔分組。
可能的值包括:
根據上述值,將以下行新增至範本,以在區段中新增或移除設定檔:
action={% if input.aggregationKey.segmentStatus == "exited" %}REMOVE{% else %}ADD{% endif%}
以下範例說明 可設定的彙總 在目的地設定中,已設定為以表單依身分名稱空間彙總匯出的設定檔 "namespaces": ["email", "phone"]
和 "namespaces": ["GAID", "IDFA"]
. 請參閱 groups
中的引數 建立目的地設定 說明檔案,以取得有關分組的更多詳細資料。
輸入
設定檔1:
{
"identityMap":{
"email":[
{
"id":"e1@example.com"
},
{
"id":"e2@example.com"
}
],
"phone":[
{
"id":"+40744111222"
}
],
"IDFA":[
{
"id":"AEBE52E7-03EE-455A-B3C4-E57283966239"
}
],
"GAID":[
{
"id":"e4fe9bde-caa0-47b6-908d-ffba3fa184f2"
}
]
}
}
設定檔2:
{
"identityMap":{
"email":[
{
"id":"e3@example.com"
}
],
"phone":[
{
"id":"+40744333444"
},
{
"id":"+40744555666"
}
],
"IDFA":[
{
"id":"134GHU45-34HH-GHJ7-K0H8-LHN665998NN0"
}
],
"GAID":[
{
"id":"47bh00i9-8jv6-334n-lll8-nb7f24sghg76"
}
]
}
}
範本
請注意 input.aggregationKey.identityNamespaces
用於以下的範本中
{
"profiles": [
{% for profile in input.profiles %}
{
{% for ns in input.aggregationKey.identityNamespaces %}
"{{ns}}": [
{% for id in profile.identityMap[ns] %}
"{{id.id}}"{% if not loop.last %},{% endif %}
{% endfor %}
]{% if not loop.last %},{% endif %}
{% endfor %}
}{% if not loop.last %},{% endif %}
{% endfor %}
]
}
結果
將設定檔匯出至目的地時,會根據其身分名稱空間將設定檔分割為兩個群組。 電子郵件和電話位於一個群組中,而GAID和IDFA位於另一個群組中。
{
"profiles":[
{
"email":[
"e1@example.com",
"e2@example.com"
],
"phone":[
"+40744111222"
]
},
{
"email":[
"e3@example.com"
],
"phone":[
"+40744333444",
"+40744555666"
]
}
]
}
{
"profiles":[
{
"IDFA":[
"AEBE52E7-03EE-455A-B3C4-E57283966239"
],
"GAID":[
"e4fe9bde-caa0-47b6-908d-ffba3fa184f2"
]
},
{
"IDFA":[
"134GHU45-34HH-GHJ7-K0H8-LHN665998NN0"
],
"GAID":[
"47bh00i9-8jv6-334n-lll8-nb7f24sghg76"
]
}
]
}
視您的使用案例而定,您也可以在URL中使用這裡所述的彙總索引鍵,如下所示:
https://api.example.com/audience/{{input.aggregationKey.segmentId}}
提供給範本的內容包含 input
(此呼叫中匯出的設定檔/資料)和 destination
(有關Adobe將資料傳送至的目的地資料,對所有設定檔都有效)。
下表提供上述範例中函式的說明。
函數 | 說明 |
---|---|
input.profile |
設定檔,表示為 JsonNode. 遵循本頁前面提到的合作夥伴XDM結構描述。 |
destination.segmentAliases |
從Adobe Experience Platform名稱空間中的區段ID對應至合作夥伴系統中的區段別名。 |
destination.segmentNames |
從Adobe Experience Platform名稱空間中的區段名稱對應到合作夥伴系統中的區段名稱。 |
addedSegments(listOfSegments) |
僅傳回具有狀態的區段 realized . |
removedSegments(listOfSegments) |
僅傳回具有狀態的區段 exited . |
閱讀本檔案後,您現在瞭解從Experience Platform匯出的資料如何轉換。 接下來,請閱讀下列頁面,以完整瞭解如何為目的地建立訊息轉換範本:
若要深入瞭解其他目的地伺服器元件,請參閱下列文章: