事件流数据 - OneSignal

使用 Liquid 语法访问事件流数据。将所需的数据点包装在 {{ }} 中以在事件流中捕获该数据。查看示例。

`event` 属性

event 对象包含以下属性：

类型

Type: String 消息类型（push、email、sms、iam）和事件（如 received、sent、clicked、failed、unsubscribed、displayed、pagedisplayed、opened、clicked、unsubscribed、reported_as_spam、hardbounced、failed、supressed）。 Usage: {{ event.kind }}

消息事件类型（OneSignal）	事件名称（在数据集中）	事件描述
Push Sent	`message.push.sent`	推送通知成功发送到推送服务（FCM、APNS 等）。
Push Received	`message.push.received`	收件人接收到推送通知。并非在所有平台上都可用。更多详情请参见确认投递。
Push Clicked	`message.push.clicked`	用户点击推送通知以在设备上打开应用。
Push Failed	`message.push.failed`	推送发送失败。详情请参见推送消息报告。
Push Unsubscribed	`message.push.unsubscribed`	用户取消订阅推送订阅。参见推送订阅状态何时更新？。
In-App Impression	`message.iam.displayed`	应用内消息成功在设备上显示。
In-App Clicked	`message.iam.clicked`	用户点击了应用内消息上的元素。
In-App Page Displayed	`message.iam.pagedisplayed`	应用内消息页面已显示。对跟踪轮播很有帮助。
Email Sent	`message.email.sent`	电子邮件成功发送。
Email Received	`message.email.received`	收件人接收到电子邮件。
Email Opened	`message.email.opened`	收件人打开了电子邮件。详情请参见电子邮件消息报告。
Email Link Clicked	`message.email.clicked`	用户点击了电子邮件中的链接。
Email Unsubscribed	`message.email.unsubscribed`	用户通过取消订阅链接取消订阅电子邮件。
Email Reported As Spam	`message.email.reported_as_spam`	用户将电子邮件报告为垃圾邮件。Gmail 需要Google Postmaster 工具来跟踪。更多详情请参见电子邮件送达性。
Email Bounced	`message.email.hardbounced`	由于永久错误，电子邮件退回给发送者。详情请参见电子邮件消息报告。
Email Failed	`message.email.failed`	电子邮件无法投递。详情请参见电子邮件消息报告。
Email Suppressed	`message.email.supressed`	由于电子邮件地址在抑制列表中，电子邮件无法发送。
SMS Sent	`message.sms.sent`	短信发送给收件人
SMS Failed	`message.sms.failed`	SMS failed to send. See SMS Message Reports for details.
SMS Delivered	`message.sms.delivered`	SMS successfully delivered
SMS Undelivered	`message.sms.undelivered`	SMS could not be sent. See SMS Message Reports for details.

Event ID

Type: UUID OneSignal 为每个独立事件生成的唯一标识符，采用 UUID v4 格式。使用此 ID 进行幂等投递跟踪。如果您要查找特定的消息或模板标识符，请使用 message.id 或 message.template_id。 Usage: {{ event.id }}

Timestamp

Type: Integer 事件的 UNIX 时间戳。 Usage: {{ event.timestamp }}

UTC datetime

Type: String 事件在 UTC 时间的人类可读时间（具体是类似”2024-02-21T23:45:15.228Z”的 ISO 字符串）。 Usage: {{ event.datetime }}

App ID

Type: UUID OneSignal 应用 ID。 Usage: {{ event.app_id }}

Subscription type

Type: String 订阅类型（例如 iOS、Android、Chrome、Email、SMS 等）。 Usage: {{ event.subscription_device_type }}

Subscription ID

Type: UUID OneSignal 订阅 ID。 Usage: {{ event.subscription_id }}

OneSignal User ID

Type: UUID OneSignal 创建的用户 ID。 Usage: {{ event.onesignal_id }}

External User ID

Type: String 您设置为 OneSignal 外部 ID 别名的用户 ID。如果未在 OneSignal 中设置，可能为空。 Usage: {{ event.external_id }}

In-app message page name

Type: String 为特定应用内消息事件显示的页面或卡片的名称。详细信息请参见应用内消息事件流。 Usage: {{ event.data.page_name }}

In-app message page ID

Type: String 为特定应用内消息事件显示的页面或卡片的唯一标识符。详细信息请参见应用内消息事件流。 Usage: {{ event.data.page_id }}

In-app message target name

Type: String 被点击的按钮或图像块元素的名称。必须包含应用内点击操作。详细信息请参见应用内消息事件流。 Usage: {{ event.data.target_name }}

In-app message target ID

Type: String 被点击的按钮或图像块元素的唯一标识符。必须包含应用内点击操作。详细信息请参见应用内消息事件流。 Usage: {{ event.data.target_id }}

Example Input

{
  "event.kind": "{{ event.kind }}",
  "event.id": "{{ event.id }}",
  "event.timestamp": "{{ event.timestamp }}",
  "event.datetime": "{{ event.datetime }}",
  "event.app_id": "{{ event.app_id }}",
  "event.subscription_device_type": "{{ event.subscription_device_type }}",
  "event.subscription_id": "{{ event.subscription_id }}",
  "event.onesignal_id": "{{ event.onesignal_id }}",
  "event.external_id": "{{ event.external_id }}",
  "event.data.page_name": "{{ event.data.page_name}}",
  "event.data.page_id": "{{ event.data.page_id}}",
  "event.data.target_name": "{{ event.data.target_name}}",
  "event.data.target_id": "{{ event.data.target_id}}"
}

Message properties

message 对象旨在让您了解发送给最终用户的消息。它包括 id、template_id 和 content 等属性，其中包含消息的实际文本。

Message ID

Type: UUID OneSignal 生成的消息 ID。 Usage: {{ message.id }}

Message Name

Type: String 在控制台中设置或使用 API name 属性的消息名称。 Usage: {{ message.name }}

Message Title

Type: Object 在控制台中设置或使用 API headings 或 email_subject 属性的推送消息标题或电子邮件主题。 Usage: {{ message.title }}

Message Contents

Type: Object 在控制台中设置或使用 API contents 属性的推送或短信消息内容（截取为 50 个字符）。不提供电子邮件内容（email_body）。 Usage: {{ message.contents }}

Template ID

Type: UUID 通过旅程或 API template_id 属性发送的消息的模板 ID。 Usage: {{ message.template_id }}

Launch URL

Type: String 消息的启动 URL（当仅使用一个与 Web 和应用无关的 URL 时）。详细信息请参见 URL、链接和深度链接。 Usage: {{ message.url }}

App-Specific URL

Type: String 当同时使用 Web 和应用专用 URL 时的消息启动 URL。详细信息请参见 URL、链接和深度链接。 Usage: {{ message.app_url }}

Web-Specific URL

Type: String 当同时使用 Web 和应用专用 URL 时的消息启动 URL。详细信息请参见 URL、链接和深度链接。 Usage: {{ message.web_url }}

Example Message Object

{
  "message.id": "f3c9cd09-10d7-4f59-b9bc-66e16607f1d5",
  "message.name": "the-name-you-set",
  "message.title": "Claim 50% Off Today", // email subject example
  "message.title": "{'en':'the message title/headings'}", // push title example
  "message.contents": "{'en':'the message content'}",
  "message.template_id": "the-template-uuid-if-set",
  "message.url": "the-message-url",
  "message.app_url": "the-message-app-url",
  "message.web_url": "the-message-web-url"
}

User properties

OneSignal ID

Type: String 用户的 OneSignal ID。 Usage {{ user.onesignal_id }}

External ID

Type: String 用户的外部 ID。 Usage: {{ user.external_id }}

Language

Type: String 用户的语言。 Usage: {{ user.language }}

Subscription properties

Subscription ID

Type: String 消息发送到的订阅的 ID。 Usage: {{ user.subscription.id }}

App ID

Type: String 应用的 ID。 Usage: {{ user.subscription.app_id }}

Subscription Token

Type: String 消息发送到的订阅的令牌。

如果类型是电子邮件，令牌将是电子邮件地址。
如果类型是短信，令牌将是 E.164 格式的电话号码。
如果类型是推送选项之一，令牌将是推送令牌。

Usage: {{ user.subscription.subscription_token }}

Session Count

Type: Number 消息发送到的订阅的会话计数。 Usage: {{ user.subscription.session_count }}

Language

Type: String 消息发送到的订阅上设置的语言。 Usage: {{ user.subscription.language }}

Game Version

Type: String 消息发送到的订阅上设置的游戏版本。 Usage: {{ user.subscription.game_version }}

Last Active

Type: Number 消息发送到的订阅上设置的最后活跃时间。 Usage: {{ user.subscription.last_active }}

Play Time

Type: Number 消息发送到的订阅上设置的游戏时间。 Usage: {{ user.subscription.play_time }}

Amount Spent

Type: Number 消息发送到的订阅上的消费金额。 Usage: {{ user.subscription.amount_spent }}

Created At

Type: Number 消息发送到的订阅的创建时间。 Usage: {{ user.subscription.created_at }}

Subscribed

Type: Boolean 指示消息发送到的订阅是否当前已订阅。 Usage: {{ user.subscription.subscribed }}

SDK

Type: String The SDK version set on the subscription the message was sent to. Usage: {{ user.subscription.sdk }}

Device Model

Type: String 在消息发送到的订阅上设置的设备型号。 Usage: {{ user.subscription.device_model }}

Device OS

Type: String 在消息发送到的订阅上设置的设备操作系统。 Usage: {{ user.subscription.device_os }}

开始使用和设置

消息渠道

旅程

受众和自定义事件

分析和集成

隐私和安全

​event 属性

​类型

​Event ID

​Timestamp

​UTC datetime

​App ID

​Subscription type

​Subscription ID

​OneSignal User ID

​External User ID

​In-app message page name

​In-app message page ID

​In-app message target name

​In-app message target ID

​Example Input

​Message properties

​Message ID

​Message Name

​Message Title

​Message Contents

​Template ID

​Launch URL

​App-Specific URL

​Web-Specific URL

​Example Message Object

​User properties

​OneSignal ID

​External ID

​Tags

​Language

​Subscription properties

​Subscription ID

​App ID

​Subscription Token

​Session Count

​Language

​Game Version

​Last Active

​Play Time

​Amount Spent

​Created At

​Subscribed

​SDK

​Device Model

​Device OS

​Tags

`event` 属性

类型

Event ID

Timestamp

UTC datetime

App ID

Subscription type

Subscription ID

OneSignal User ID

External User ID

In-app message page name

In-app message page ID

In-app message target name

In-app message target ID

Example Input

Message properties

Message ID

Message Name

Message Title

Message Contents

Template ID

Launch URL

App-Specific URL

Web-Specific URL

Example Message Object

User properties

OneSignal ID

External ID

Tags

Language

Subscription properties

Subscription ID

App ID

Subscription Token

Session Count

Language

Game Version

Last Active

Play Time

Amount Spent

Created At

Subscribed

SDK

Device Model

Device OS

Tags