以下文檔說明如何使用API執行邊緣分割。 有關使用UI執行邊緣分割的資訊,請閱讀 邊緣分割UI指南。
現在,所有平台用戶都可以使用邊緣分割。 如果在測試期間建立了邊段,則這些段將繼續運行。
邊緣分割是一種在邊緣上即時評估Adobe Experience Platform區段的能力,使同一頁和下一頁個性化使用案例成為可能。
邊緣資料將儲存在最靠近其收集位置的邊緣伺服器位置,並且可以儲存在指定為集線器(或主體)Adobe Experience Platform資料中心的位置以外的位置。
此外,邊緣分割引擎將僅處理存在邊緣的請求 一個 主標籤標識,與非基於邊緣的主標識一致。
本開發人員指南要求對各種 Adobe Experience Platform 與邊緣分割相關的服務。 在開始本教程之前,請查看以下服務的文檔:
要成功調用任何Experience PlatformAPI終結點,請閱讀上的指南 平台API入門 瞭解所需標頭以及如何讀取示例API調用。
要使用邊緣分割來評估段,查詢必須符合以下准則:
查詢類型 | 詳細資訊 | 範例 |
---|---|---|
單個事件 | 任何引用無時間限制的單個傳入事件的段定義。 | 已將物料添加到購物車中的人員。 |
引用配置檔案的單個事件 | 引用一個或多個配置檔案屬性和單個傳入事件且沒有時間限制的任何段定義。 | 訪問首頁的美國人。 |
使用配置檔案屬性否定單個事件 | 任何引用否定的單個傳入事件和一個或多個配置檔案屬性的段定義 | 生活在美國並擁有 不 已訪問首頁。 |
在24小時時間窗口內單個事件 | 指24小時內單個傳入事件的任何段定義。 | 過去24小時內訪問首頁的人。 |
在24小時時間窗口內具有配置檔案屬性的單個事件 | 在24小時內引用一個或多個配置檔案屬性和單個傳入事件的任何段定義。 | 過去24小時內訪問首頁的美國人。 |
在24小時時間窗口內使用配置檔案屬性否定單個事件 | 在24小時內引用一個或多個配置檔案屬性和否定的單個傳入事件的任何段定義。 | 生活在美國並擁有 不 在過去24小時內訪問了首頁。 |
24小時時間窗內的頻率事件 | 任何段定義,指在24小時的時間窗口內發生一定次數的事件。 | 訪問首頁的人 至少 24小時內有5次。 |
在24小時時間窗口內具有配置檔案屬性的頻率事件 | 指一個或多個配置檔案屬性以及在24小時的時間窗口內發生一定次數的事件的任何段定義。 | 訪問首頁的美國人 至少 24小時內有5次。 |
在24小時時間窗口內使用配置檔案否定頻率事件 | 任何段定義,它指一個或多個配置檔案屬性以及在24小時的時間窗口內發生一定次數的已取消事件。 | 未訪問首頁的人 更多 比過去24小時里多了5次。 |
在24小時內的時間配置檔案內多次傳入命中 | 任何段定義,指在24小時的時間窗口內發生的多個事件。 | 訪問首頁的人員 或 在過去24小時內訪問了簽出頁面。 |
在24小時時間窗口內使用配置檔案的多個事件 | 任何段定義,它指在24小時的時間窗口內發生的一個或多個配置檔案屬性和多個事件。 | 訪問首頁的美國人 和 在過去24小時內訪問了簽出頁面。 |
此外,該分部 必須 綁定到邊緣上處於活動狀態的合併策略。 有關合併策略的詳細資訊,請閱讀 合併策略指南。
通過向IMS組織發出GET請求,您可以檢索IMS組織內啟用邊緣分割的所有段的清單 /segment/definitions
端點。
API格式
要檢索為邊緣分割啟用的段,必須包括查詢參數 evaluationInfo.synchronous.enabled=true
的子菜單。
GET /segment/definitions?evaluationInfo.synchronous.enabled=true
要求
curl -X GET \
'https://platform.adobe.io/data/core/ups/segment/definitions?evaluationInfo.synchronous.enabled=true' \
-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}'
回應
成功的響應將返回IMS組織中啟用邊緣分割的一組段。 有關返回的段定義的詳細資訊,請參見 段定義端點指南。
{
"segments": [
{
"id": "15063cb-2da8-4851-a2e2-bf59ddd2f004",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 30,
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "",
"sandboxName": "",
"type": "production",
"default": true
},
"name": " People who are NOT on their homepage ",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = false"
},
"evaluationInfo": {
"batch": {
"enabled": false
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": true
}
},
"creationTime": 1572029711000,
"updateEpoch": 1572029712000,
"updateTime": 1572029712000
},
{
"id": "f15063cb-2da8-4851-a2e2-bf59ddd2f004",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 30,
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "",
"sandboxName": "",
"type": "production",
"default": true
},
"name": "Homepage_continuous",
"description": "People who are on their homepage - continuous",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
},
"evaluationInfo": {
"batch": {
"enabled": false
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": true
}
},
"creationTime": 1572021085000,
"updateEpoch": 1572021086000,
"updateTime": 1572021086000
}
],
"page": {
"totalCount": 2,
"totalPages": 1,
"sortField": "creationTime",
"sort": "desc",
"pageSize": 2,
"limit": 100
},
"link": {}
}
可通過向POST請求建立允許邊緣分割的段 /segment/definitions
與其中一個 上面列出的邊緣分割查詢類型。
API格式
POST /segment/definitions
要求
下面的示例是建立段的標準請求。 有關建立段定義的詳細資訊,請閱讀有關 建立段。
curl -X POST \
https://platform.adobe.io/data/core/ups/segment/definitions \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 30,
"name": "Homepage_continuous",
"description": "People who are on their homepage - continuous",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
}
}'
回應
成功的響應將返回新建立的段定義的詳細資訊,該定義啟用了邊緣分割。
{
"id": "f15063cb-2da8-4851-a2e2-bf59ddd2f004",
"schema": {
"name": "_xdm.context.profile"
},
"ttlInDays": 30,
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"type": "production",
"default": true
},
"name": "Homepage_continuous",
"description": "People who are on their homepage - continuous",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "chain(xEvent, timestamp, [X: WHAT(var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = "true")])"
},
"evaluationInfo": {
"batch": {
"enabled": false
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": true
}
},
"creationTime": 1572021085000,
"updateEpoch": 1572021086000,
"updateTime": 1572021086000
}
現在您知道如何建立啟用邊緣分割的段,可以使用這些段啟用同一頁和下一頁個性化使用案例。
要瞭解如何使用Adobe Experience Platform用戶介面執行類似操作和使用段,請訪問 段生成器使用手冊。