文档Experience Platform查询服务指南

查询服务中的Adobe定义的SQL函数

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • 用户
  • 开发人员

Adobe定义的函数（此处称为ADF）是Adobe Experience Platform查询服务中的预建函数，可帮助对Experience Event数据执行常见的业务相关任务。 这些功能包括会话化和归因的功能，这些功能与Adobe Analytics中的功能类似。

本文档提供了Query Service中可用的Adobe定义函数的信息。

NOTE
Experience CloudID (ECID)也称为MCID，它将继续用在命名空间中。

窗口函数 window-functions

大多数业务逻辑要求收集客户的接触点并按时间对这些接触点排序。 此支持由Spark SQL以窗口函数的形式提供。 窗口函数是标准SQL的一部分，并且受许多其他SQL引擎支持。

窗口函数将更新聚合，并为排序子集中的每一行返回单个项。 最基本的聚合函数是SUM()。 SUM()将获取您的行并提供一个总计。 如果将SUM()应用于窗口，并将其转换为窗口函数，则每行将收到累加总和。

大多数Spark SQL帮助程序都是窗口函数，用于更新窗口中的每一行，并添加该行的状态。

查询语法

OVER ({PARTITION} {ORDER} {FRAME})
参数
描述
示例
{PARTITION}
基于列或可用字段的行子组。
PARTITION BY endUserIds._experience.mcid.id
{ORDER}
用于对子集或行进行排序的列或可用字段。
ORDER BY timestamp
{FRAME}
分区中行的子组。
ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW

会话化

当您使用来自网站、移动应用程序、交互式语音响应系统或任何其他客户交互渠道的Experience Event数据时，如果事件可以按照相关活动周期进行分组，则这样做很有帮助。 通常，您有特定的意图来推动您的活动，例如研究产品、支付账单、检查帐户余额、填写应用程序等。

这种数据分组或会话化有助于关联事件，以揭示有关客户体验的更多上下文。

有关Adobe Analytics中的会话化的更多信息，请参阅有关上下文感知会话的文档。

查询语法

SESS_TIMEOUT({TIMESTAMP}, {EXPIRATION_IN_SECONDS}) OVER ({PARTITION} {ORDER} {FRAME})
参数
描述
{TIMESTAMP}
在数据集中找到的时间戳字段。
{EXPIRATION_IN_SECONDS}
事件之间限定当前会话结束和新会话开始所需的秒数。

可以在窗口函数部分中找到OVER()函数中参数的说明。

示例查询

SELECT
  endUserIds._experience.mcid.id as id,
  timestamp,
  SESS_TIMEOUT(timestamp, 60 * 30)
    OVER (PARTITION BY endUserIds._experience.mcid.id
        ORDER BY timestamp
        ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)
    AS session
FROM experience_events
ORDER BY id, timestamp ASC
LIMIT 10

结果

                id                |       timestamp       |      session
----------------------------------+-----------------------+--------------------
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:55:53.0 | (0,1,true,1)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:56:51.0 | (58,1,false,2)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:57:47.0 | (56,1,false,3)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:58:27.0 | (40,1,false,4)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:59:22.0 | (55,1,false,5)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:16:23.0 | (1361821,2,true,1)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:17:17.0 | (54,2,false,2)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:18:06.0 | (49,2,false,3)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:18:39.0 | (33,2,false,4)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:19:10.0 | (31,2,false,5)
(10 rows)

对于给定的示例查询，结果在session列中给出。 session列由以下组件组成：

({TIMESTAMP_DIFF}, {NUM}, {IS_NEW}, {DEPTH})
参数
描述
{TIMESTAMP_DIFF}
当前记录与之前记录之间的时间差（以秒为单位）。
{NUM}
在window函数的PARTITION BY中定义的键的唯一会话编号，从1开始。
{IS_NEW}
一个布尔值，用于标识记录是否为会话的第一个。
{DEPTH}
会话中当前记录的深度。

SESS_START_IF

此查询基于当前时间戳和给定的表达式返回当前行的会话状态，并启动与当前行的新会话。

查询语法

SESS_START_IF({TIMESTAMP}, {TEST_EXPRESSION}) OVER ({PARTITION} {ORDER} {FRAME})
参数
描述
{TIMESTAMP}
在数据集中找到的时间戳字段。
{TEST_EXPRESSION}
要检查数据字段的表达式。 例如：application.launches > 0。

可以在窗口函数部分中找到OVER()函数中参数的说明。

示例查询

SELECT
    endUserIds._experience.mcid.id AS id,
    timestamp,
    IF(application.launches.value > 0, true, false) AS isLaunch,
    SESS_START_IF(timestamp, application.launches.value > 0)
        OVER (PARTITION BY endUserIds._experience.mcid.id
            ORDER BY timestamp
            ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)
        AS session
    FROM experience_events
    ORDER BY id, timestamp ASC
    LIMIT 10

结果

                id                |       timestamp       | isLaunch |      session
----------------------------------+-----------------------+----------+--------------------
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:55:53.0 | true     | (0,1,true,1)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:56:51.0 | false    | (58,1,false,2)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:57:47.0 | false    | (56,1,false,3)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:58:27.0 | true     | (40,2,true,1)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:59:22.0 | false    | (55,2,false,2)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:16:23.0 | false    | (1361821,2,false,3)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:17:17.0 | false    | (54,2,false,4)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:18:06.0 | false    | (49,2,false,5)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:18:39.0 | false    | (33,2,false,6)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:19:10.0 | false    | (31,2,false,7)
(10 rows)

对于给定的示例查询，结果在session列中给出。 session列由以下组件组成：

({TIMESTAMP_DIFF}, {NUM}, {IS_NEW}, {DEPTH})
参数
描述
{TIMESTAMP_DIFF}
当前记录与之前记录之间的时间差（以秒为单位）。
{NUM}
在window函数的PARTITION BY中定义的键的唯一会话编号，从1开始。
{IS_NEW}
一个布尔值，用于标识记录是否为会话的第一个。
{DEPTH}
会话中当前记录的深度。

SESS_END_IF

此查询根据当前时间戳和给定的表达式返回当前行的会话状态，结束当前会话，并在下一行启动新会话。

查询语法

SESS_END_IF({TIMESTAMP}, {TEST_EXPRESSION}) OVER ({PARTITION} {ORDER} {FRAME})
参数
描述
{TIMESTAMP}
在数据集中找到的时间戳字段。
{TEST_EXPRESSION}
要检查数据字段的表达式。 例如：application.launches > 0。

可以在窗口函数部分中找到OVER()函数中参数的说明。

示例查询

SELECT
    endUserIds._experience.mcid.id AS id,
    timestamp,
    IF(application.applicationCloses.value > 0 OR application.crashes.value > 0, true, false) AS isExit,
    SESS_END_IF(timestamp, application.applicationCloses.value > 0 OR application.crashes.value > 0)
        OVER (PARTITION BY endUserIds._experience.mcid.id
            ORDER BY timestamp
            ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)
        AS session
    FROM experience_events
    ORDER BY id, timestamp ASC
    LIMIT 10

结果

                id                |       timestamp       | isExit   |      session
----------------------------------+-----------------------+----------+--------------------
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:55:53.0 | false    | (0,1,true,1)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:56:51.0 | false    | (58,1,false,2)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:57:47.0 | true     | (56,1,false,3)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:58:27.0 | false    | (40,2,true,1)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-01-18 06:59:22.0 | false    | (55,2,false,2)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:16:23.0 | false    | (1361821,2,false,3)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:17:17.0 | false    | (54,2,false,4)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:18:06.0 | false    | (49,2,false,5)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:18:39.0 | false    | (33,2,false,6)
 100080F22A45CB40-3A2B7A8E11096B6 | 2018-02-03 01:19:10.0 | false    | (31,2,false,7)
(10 rows)

对于给定的示例查询，结果在session列中给出。 session列由以下组件组成：

({TIMESTAMP_DIFF}, {NUM}, {IS_NEW}, {DEPTH})
参数
描述
{TIMESTAMP_DIFF}
当前记录与之前记录之间的时间差（以秒为单位）。
{NUM}
在window函数的PARTITION BY中定义的键的唯一会话编号，从1开始。
{IS_NEW}
一个布尔值，用于标识记录是否为会话的第一个。
{DEPTH}
会话中当前记录的深度。

路径分析

路径分析可用于了解客户的参与深度、确认体验的预期步骤是否按设计要求工作，以及识别影响客户的潜在棘手问题。

以下ADF支持根据先前和后续的关系建立路径视图。 您将能够创建上一页和下一页，或逐步执行多个事件以创建路径。

上一页

确定在窗口内距离指定步数的特定字段的上一个值。 请注意，在该示例中，WINDOW函数配置有ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW帧，并将ADF设置为查看当前行和所有后续行。

查询语法

PREVIOUS({KEY}, {SHIFT}, {IGNORE_NULLS}) OVER ({PARTITION} {ORDER} {FRAME})
参数
描述
{KEY}
事件中的列或字段。
{SHIFT}
（可选）当前事件之外的事件数。 默认情况下，该值为1。
{IGNORE_NULLS}
（可选）一个布尔值，指示是否应忽略null {KEY}值。 默认情况下，值为false。

可以在窗口函数部分中找到OVER()函数中参数的说明。

示例查询

SELECT endUserIds._experience.mcid.id, timestamp, web.webPageDetails.name
    PREVIOUS(web.webPageDetails.name, 3)
      OVER(PARTITION BY endUserIds._experience.mcid.id
           ORDER BY timestamp
           ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)
      AS previous_page
FROM experience_events
ORDER BY endUserIds._experience.mcid.id, timestamp ASC

结果

                id                 |       timestamp       |                 name                |                    previous_page
-----------------------------------+-----------------------+-------------------------------------+-----------------------------------------------------
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 17:15:28.0 |                                     |
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 17:53:05.0 | Home                                |
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 17:53:45.0 | Kids                                | (Home)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 19:22:34.0 |                                     | (Kids)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:01:12.0 | Home                                |
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:01:57.0 | Kids                                | (Home)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:03:36.0 | Search Results                      | (Kids)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:04:30.0 | Product Details: Pemmican Power Bar | (Search Results)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:05:27.0 | Shopping Cart: Cart Details         | (Product Details: Pemmican Power Bar)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:06:07.0 | Shopping Cart: Shipping Information | (Shopping Cart: Cart Details)
(10 rows)

对于给定的示例查询，结果在previous_page列中给出。 previous_page列中的值基于ADF中使用的{KEY}。

下一页

确定在窗口内距离指定步数的特定字段的下一个值。 请注意，在该示例中，WINDOW函数配置有ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING帧，并将ADF设置为查看当前行和所有后续行。

查询语法

NEXT({KEY}, {SHIFT}, {IGNORE_NULLS}) OVER ({PARTITION} {ORDER} {FRAME})
参数
描述
{KEY}
事件中的列或字段。
{SHIFT}
（可选）当前事件之外的事件数。 默认情况下，该值为1。
{IGNORE_NULLS}
（可选）一个布尔值，指示是否应忽略null {KEY}值。 默认情况下，值为false。

可以在窗口函数部分中找到OVER()函数中参数的说明。

示例查询

SELECT endUserIds._experience.aaid.id, timestamp, web.webPageDetails.name,
    NEXT(web.webPageDetails.name, 1, true)
      OVER(PARTITION BY endUserIds._experience.aaid.id
           ORDER BY timestamp
           ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING)
      AS next_page
FROM experience_events
ORDER BY endUserIds._experience.aaid.id, timestamp ASC
LIMIT 10

结果

                id                 |       timestamp       |                name                 |             previous_page
-----------------------------------+-----------------------+-------------------------------------+---------------------------------------
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 17:15:28.0 |                                     | (Home)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 17:53:05.0 | Home                                | (Kids)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 17:53:45.0 | Kids                                | (Home)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 19:22:34.0 |                                     | (Home)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:01:12.0 | Home                                | (Kids)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:01:57.0 | Kids                                | (Search Results)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:03:36.0 | Search Results                      | (Product Details: Pemmican Power Bar)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:04:30.0 | Product Details: Pemmican Power Bar | (Shopping Cart: Cart Details)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:05:27.0 | Shopping Cart: Cart Details         | (Shopping Cart: Shipping Information)
 457C3510571E5930-69AA721C4CBF9339 | 2017-11-08 20:06:07.0 | Shopping Cart: Shipping Information | (Shopping Cart: Billing Information)
(10 rows)

对于给定的示例查询，结果在previous_page列中给出。 previous_page列中的值基于ADF中使用的{KEY}。

时间间隔

“时间间隔”允许您在事件发生之前或之后的特定时间段内探索潜在的客户行为。

上一个匹配之间的时间

此查询返回一个数字，表示自查看上一个匹配事件以来的时间单位。 如果未找到匹配的事件，则返回null。

查询语法

TIME_BETWEEN_PREVIOUS_MATCH(
    {TIMESTAMP}, {EVENT_DEFINITION}, {TIME_UNIT})
    OVER ({PARTITION} {ORDER} {FRAME})
参数
描述
{TIMESTAMP}
在所有事件填充的数据集中发现的时间戳字段。
{EVENT_DEFINITION}
限定上一个事件的表达式。
{TIME_UNIT}
输出单位。 可能的值包括天、小时、分钟和秒。 默认情况下，该值为秒。

可以在窗口函数部分中找到OVER()函数中参数的说明。

示例查询

SELECT
  page_name,
  SUM (time_between_previous_match) / COUNT(page_name) as average_minutes_since_registration
FROM
(
SELECT
  endUserIds._experience.mcid.id as id,
  timestamp, web.webPageDetails.name as page_name,
  TIME_BETWEEN_PREVIOUS_MATCH(timestamp, web.webPageDetails.name='Account Registration|Confirmation', 'minutes')
    OVER(PARTITION BY endUserIds._experience.mcid.id
       ORDER BY timestamp
       ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)
    AS time_between_previous_match
FROM experience_events
)
WHERE time_between_previous_match IS NOT NULL
GROUP BY page_name
ORDER BY average_minutes_since_registration
LIMIT 10

结果

             page_name             | average_minutes_since_registration
-----------------------------------+------------------------------------
                                   |
 Account Registration|Confirmation |                                0.0
 Seasonal                          |                   5.47029702970297
 Equipment                         |                  6.532110091743119
 Women                             |                  7.287081339712919
 Men                               |                  7.640918580375783
 Product List                      |                  9.387459807073954
 Unlimited Blog|February           |                  9.954545454545455
 Product Details|Buffalo           |                 13.304347826086957
 Unlimited Blog|June               |                  770.4285714285714
(10 rows)

对于给定的示例查询，结果在average_minutes_since_registration列中给出。 average_minutes_since_registration列中的值是当前事件与上一个事件之间的时间差。 时间单位之前在{TIME_UNIT}中定义。

下一次匹配之间的时间

此查询返回一个负数，表示下一个匹配事件之后的时间单位。 如果找不到匹配的事件，则返回null。

查询语法

TIME_BETWEEN_NEXT_MATCH({TIMESTAMP}, {EVENT_DEFINITION}, {TIME_UNIT}) OVER ({PARTITION} {ORDER} {FRAME})
参数
描述
{TIMESTAMP}
在所有事件填充的数据集中发现的时间戳字段。
{EVENT_DEFINITION}
用于限定下一个事件的表达式。
{TIME_UNIT}
（可选）输出单位。 可能的值包括天、小时、分钟和秒。 默认情况下，该值为秒。

可以在窗口函数部分中找到OVER()函数中参数的说明。

示例查询

SELECT
  page_name,
  SUM (time_between_next_match) / COUNT(page_name) as average_minutes_until_order_confirmation
FROM
(
SELECT
  endUserIds._experience.mcid.id as id,
  timestamp, web.webPageDetails.name as page_name,
  TIME_BETWEEN_NEXT_MATCH(timestamp, web.webPageDetails.name='Shopping Cart|Order Confirmation', 'minutes')
    OVER(PARTITION BY endUserIds._experience.mcid.id
       ORDER BY timestamp
       ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING)
    AS time_between_next_match
FROM experience_events
)
WHERE time_between_next_match IS NOT NULL
GROUP BY page_name
ORDER BY average_minutes_until_order_confirmation DESC
LIMIT 10

结果

             page_name             | average_minutes_until_order_confirmation
-----------------------------------+------------------------------------------
 Shopping Cart|Order Confirmation  |                                      0.0
 Men                               |                       -9.465295629820051
 Equipment                         |                       -9.682098765432098
 Product List                      |                       -9.690661478599221
 Women                             |                       -9.759459459459459
 Seasonal                          |                                  -10.295
 Shopping Cart|Order Review        |                      -366.33567364956144
 Unlimited Blog|February           |                       -615.0327868852459
 Shopping Cart|Billing Information |                       -775.6200495367711
 Product Details|Buffalo           |                      -1274.9571428571428
(10 rows)

对于给定的示例查询，结果在average_minutes_until_order_confirmation列中给出。 average_minutes_until_order_confirmation列中的值是当前事件与下一个事件之间的时间差。 时间单位之前在{TIME_UNIT}中定义。

后续步骤

使用此处描述的函数，您可以编写查询以使用Query Service访问您自己的Experience Event数据集。 有关在Query Service中创作查询的更多信息，请参阅有关创建查询的文档。

其他资源

以下视频介绍了如何在Adobe Experience Platform界面和PSQL客户端中运行查询。 此外，该视频还使用涉及XDM对象中各个属性、使用Adobe定义的函数以及使用CREATE TABLE AS SELECT (CTAS)的示例。

https://video.tv.adobe.com/v/32702?quality=12&learn=on&captions=chi_hans

recommendation-more-help
ccf2b369-4031-483f-af63-a93b5ae5e3fb