以下檔案說明如何使用API執行邊緣細分。 如需使用UI執行邊緣區段的資訊,請參閱 edge segmentation UI指南.
邊緣區段現在可供所有Platform使用者普遍使用。 如果您在Beta版期間建立了邊緣區段定義,這些區段定義將繼續運作。
邊緣區段是即時在邊緣上評估Adobe Experience Platform中區段定義的能力,可啟用相同頁面和下一頁個人化使用案例。
邊緣資料將會儲存在距離收集位置最近的邊緣伺服器位置,而且可能會儲存在指定為Adobe Experience Platform資料中心中心(或主體)以外的位置。
此外,邊緣區段引擎只會處理邊緣區段的請求,該邊緣區段有 一 主要標籤的身分,與非邊緣型主要身分一致。
本開發人員指南需要深入瞭解各種 Adobe Experience Platform 邊緣細分涉及的服務。 在開始本教學課程之前,請檢閱下列服務的檔案:
為了成功呼叫任何Experience PlatformAPI端點,請閱讀以下指南: Platform API快速入門 以瞭解必要的標頭以及如何讀取範例API呼叫。
為了使用邊緣區段來評估區段,查詢必須符合以下准則:
查詢型別 | 詳細資訊 | 範例 | PQL範例 |
---|---|---|---|
單一事件 | 任何區段定義,會參照沒有時間限制的單一傳入事件。 | 已將專案新增至購物車的使用者。 | chain(xEvent, timestamp, [A: WHAT(eventType = "addToCart")]) |
單一設定檔 | 任何參考單一設定檔屬性的區段定義 | 美國居民。 | homeAddress.countryCode = "US" |
參考設定檔的單一事件 | 任何區段定義,會參照一或多個設定檔屬性,以及沒有時間限制的單一傳入事件。 | 居住在美國的人造訪了首頁。 | homeAddress.countryCode = "US" and chain(xEvent, timestamp, [A: WHAT(eventType = "addToCart")]) |
否定具有設定檔屬性的單一事件 | 任何參考否定單一傳入事件和一個或多個設定檔屬性的區段定義 | 居住在美國且有 not 造訪了首頁。 | not(chain(xEvent, timestamp, [A: WHAT(eventType = "homePageView")])) |
時間範圍內的單一事件 | 任何參考一段時間內單一傳入事件的區段定義。 | 過去24小時內造訪過首頁的人。 | chain(xEvent, timestamp, [X: WHAT(eventType = "addToCart") WHEN(< 8 days before now)]) |
時間範圍內具有設定檔屬性的單一事件 | 任何區段定義,會參照一段時間內的一或多個設定檔屬性和單一傳入事件。 | 居住在美國的人在過去24小時內瀏覽過首頁。 | homeAddress.countryCode = "US" and chain(xEvent, timestamp, [X: WHAT(eventType = "addToCart") WHEN(< 8 days before now)]) |
否定時間範圍內具有設定檔屬性的單一事件 | 任何區段定義,會參照一或多個設定檔屬性,以及一段時間內否定單一傳入事件。 | 居住在美國且有 not 在過去24小時內造訪了首頁。 | homeAddress.countryCode = "US" and not(chain(xEvent, timestamp, [X: WHAT(eventType = "addToCart") WHEN(< 8 days before now)])) |
24小時時間範圍內的頻率事件 | 任何區段定義,會參照在24小時之時間範圍內發生特定次數的事件。 | 造訪過首頁的人 至少 過去24小時內5次。 | chain(xEvent, timestamp, [A: WHAT(eventType = "homePageView") WHEN(< 24 hours before now) COUNT(5) ] ) |
在24小時時間範圍內具有設定檔屬性的頻率事件 | 任何區段定義,會參照一或多個設定檔屬性,以及在24小時之時間範圍內發生特定次數的事件。 | 造訪首頁的美國人 至少 過去24小時內5次。 | homeAddress.countryCode = "US" and chain(xEvent, timestamp, [A: WHAT(eventType = "homePageView") WHEN(< 24 hours before now) COUNT(5) ] ) |
在24小時時間範圍內具有設定檔的否定頻率事件 | 任何區段定義,會參照一或多個設定檔屬性,以及在24小時內特定次數內發生的否定事件。 | 尚未造訪過首頁的人 更多 在過去24小時內超過五次。 | not(chain(xEvent, timestamp, [A: WHAT(eventType = "homePageView") WHEN(< 24 hours before now) COUNT(5) ] )) |
24小時時間設定檔內有多次傳入點選 | 任何區段定義,會參照在24小時內發生的時間範圍內所發生的多個事件。 | 造訪過首頁的人 或 在過去24小時內造訪過結帳頁面。 | chain(xEvent, timestamp, [X: WHAT(eventType = "homePageView") WHEN(< 24 hours before now)]) and chain(xEvent, timestamp, [X: WHAT(eventType = "checkoutPageView") WHEN(< 24 hours before now)]) |
在24小時時間範圍內有多個具有設定檔的事件 | 任何區段定義,會參照在24小時時間範圍內發生的一或多個設定檔屬性和多個事件。 | 造訪過首頁的美國人 和 在過去24小時內造訪過結帳頁面。 | homeAddress.countryCode = "US" and chain(xEvent, timestamp, [X: WHAT(eventType = "homePageView") WHEN(< 24 hours before now)]) and chain(xEvent, timestamp, [X: WHAT(eventType = "checkoutPageView") WHEN(< 24 hours before now)]) |
區段區段 | 包含一或多個批次或串流區段的任何區段定義。 | 居住在美國且處於「現有區段」區段的人員。 | homeAddress.countryCode = "US" and inSegment("existing segment") |
參考地圖的查詢 | 任何參照屬性對應的區段定義。 | 已根據外部區段資料新增至購物車的使用者。 | chain(xEvent, timestamp, [A: WHAT(eventType = "addToCart") WHERE(externalSegmentMapProperty.values().exists(stringProperty="active"))]) |
此外,區段 必須 繫結至在edge上作用中的合併原則。 如需有關合併原則的詳細資訊,請參閱 合併原則指南.
區段定義會 not 在以下情況下啟用邊緣分段:
inSegment
事件。
inSegment
事件只是設定檔,區段定義 將 啟用邊緣區段。您可以透過向「 」發出GET請求,擷取貴組織內啟用邊緣分段的所有區段清單。 /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}'
回應
成功的回應會傳回組織中啟用邊緣區段的一系列區段。 有關所傳回區段定義的更多詳細資訊,請參閱 區段定義端點指南.
{
"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"
},
"evaluationInfo": {
"batch": {
"enabled": false
},
"continuous": {
"enabled": false
},
"synchronous": {
"enabled": 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使用者介面執行類似動作和使用區段,請造訪 區段產生器使用手冊.
下節列出與邊緣細分相關的常見問題:
在Edge Network上提供區段最多需要一小時。