边缘分段

注意

以下文档说明了如何使用API执行边缘分段。 有关使用UI执行边缘分段的信息,请阅读 边缘分段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(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)])
在一个时间范围内否定了具有配置文件属性的单个事件 任何引用一段时间内一个或多个用户档案属性和否定单个传入事件的区段定义。 居住在美国并且有 在过去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小时的时间范围内发生特定次数的否定事件。 未访问过主页的人 更多 超过5次了。 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上处于活动状态的合并策略。 有关合并策略的更多信息,请阅读 合并策略指南.

区段定义将 在以下情况下启用边缘分段:

  • 区段定义包括单个事件和 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用户界面执行类似操作和使用区段,请访问 Segment Builder用户指南.

附录

以下部分列出了有关边缘分段的常见问题解答:

区段在Edge Network上可用需要多长时间?

在Edge Network上可用区段最多需要一小时。

在此页面上