边缘分段

NOTE
以下文档介绍了如何使用API执行边缘分段。 有关使用UI执行边缘分段的信息,请阅读边缘分段UI指南
Edge分段现在通常可供所有Platform用户使用。 如果您在测试版中创建了边缘区段定义,则这些区段定义将继续有效。

Edge分段功能能够在边缘即时评估Adobe Experience Platform中的区段定义,从而实现同一页面和下一页面个性化用例。

IMPORTANT
边缘数据将存储在距离收集位置最近的边缘服务器位置,并且可能会存储在指定为Adobe Experience Platform数据中心中心(或主体)的位置以外的位置。
此外,边缘分段引擎将仅在具有​ 一个 ​主标记身份的边缘上处理请求,这与不基于边缘的主身份一致。

快速入门

此开发人员指南需要深入了解与边缘分段相关的各种Adobe Experience Platform服务。 在开始本教程之前,请查看以下服务的文档:

为了成功调用任何Experience PlatformAPI端点,请阅读平台API快速入门指南,了解所需的标头以及如何读取示例API调用。

Edge分段查询类型 query-types

为了使用边缘分段来评估区段,查询必须遵循以下准则:

查询类型
详细信息
小于24小时时间范围内的单个事件
任何涉及少于24小时时间范围内的单个传入事件的区段定义。
仅配置文件
仅引用配置文件属性的任何区段定义。
在相对时间范围小于24小时内的配置文件属性为单个事件
任何涉及单个传入事件(具有一个或多个用户档案属性)且发生在小于24小时的相对时间范围内的区段定义。
区段划分
包含一个或多个批次或流式客户细分的任何客户细分定义。 注意: ​如果使用区段区段,则每24小时​ 将发生配置文件取消资格
具有配置文件属性的多个事件
任何在过去24小时​ 内引用多个事件 ​且(可选)具有一个或多个配置文件属性的区段定义。

此外,区段​ 必须 ​绑定到边缘上活动的合并策略。 有关合并策略的更多信息,请参阅合并策略指南

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

  • 区段定义包含单个事件和inSegment事件的组合。
    • 但是,如果inSegment事件中包含的区段仅是配置文件,则区段定义​ ​启用边缘分段。
  • 区段定义使用“忽略年份”作为其时间限制的一部分。

检索为边缘分段启用的所有区段

通过向/segment/definitions端点发出GET请求,您可以检索贵组织中启用了边缘分段的所有区段的列表。

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"
            },
            "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"
            },
            "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": {}
}

创建启用边缘分段的区段

您可以通过对与上面列出的边缘分段查询类型之一匹配的/segment/definitions端点发出POST请求,来创建为边缘分段启用的区段。

API格式

POST /segment/definitions

请求

NOTE
以下示例是创建区段的标准请求。 有关创建区段定义的更多信息,请阅读有关创建区段的教程。
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"
    },
    "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"
    },
    "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上可用?

在Edge Network上提供一个区段最多需要一小时。

recommendation-more-help
770bc05d-534a-48a7-9f07-017ec1e14871