RBM 会创建在摘要和事务级别报告用户和代理活动的数据文件。数据会拆分为多个文件:
文件 | 说明 | 有权访问的人 |
---|---|---|
结算事件报告 | 已发布代理和用户之间的计费事件记录 | 所有在其网络上有 RBM 流量的运营商 |
活动日志 | 原始 RBM 平台活动数据 | 拥有 RBM 流量且根据自己的服务条款 (ToS) 使用 Jibe Cloud 启用 RCS 活动的运营商 |
生成
结算事件报告和活动日志的生成会延迟两天。
只有当活动事件所属的结算会话完成时,Google 才会报告该活动事件。会话最多可能需要 24 小时才能完成,我们的结算流水线每天执行一次,并且仅报告必须完成(因此至少有 24 小时)的结算会话。
例如:
一条消息在 d 号发送并发起了结算会话,但在 1 小时前错过了流水线执行时间。因此,系统不会报告任何活动事件。
当流水线在 d+1 上再次运行时,启动消息的会话仅在 23 小时前已存在。因此,在 d+1 上不会报告此消息的任何活动事件。
当流水线在 d+2 再次运行时,表示会话已完成,因此活动事件会与结算会话一起报告。
存储和访问权限
无论是在静态存储时还是在传输过程中,数据文件都会经过加密处理。
要通过 SFTP 检索数据文件,您需要提供 SFTP 公钥。如需生成密钥,请参阅为 SFTP Dropbox 生成安全外壳 (SSH) 密钥对。
SFTP 服务器为 partnerupload.google.com
,为提高安全性,连接使用的是高端口号 (19321)。
您可以使用以下命令访问您的数据文件:
sftp -i <path_to_private_key> -P 19321 <username>@partnerupload.google.com
Google 按以下格式提供帐号用户名:
rbmreports-billableevents-<carrier name>
rbmreports-activity-<carrier name>
Google 会指定 <carrier name>
并针对每种报告类型提供单独的帐号。
对于不同类型的报告,我们还提供了不同的帐号。
文件可用性
如果尚未生成任何报告文件,您将看到类似于 remote readdir("/"): No such file or directory
的 SFTP 错误。这是正常现象。
如果没有可报告的 RBM 流量,则不会生成文件。这意味着,可能会有几天系统未生成文件。在这种情况下,如果您需要生成空文件以简化处理,请发送电子邮件至 rbm-support@google.com。
刷新和留存
每个数据文件都代表一天的平台使用情况(采用世界协调时间 [UTC])。指定日期的记录仅生成一次,并在该日期结束后的 2 天(48 小时)内最终确定。如果将这些文件加载到数据仓库中,则可以更新当月的指标。
如果没有要考虑的活动,就不会生成文件。
每个文件名称中的日期即为文件的生成日期。该文件中的记录涵盖文件日期前 2 天的世界协调时间 (UTC) 日期。
生成文件的导出过程会在太平洋标准时间凌晨 2 点到凌晨 4 点之间执行。
数据文件最多可保留 30 天,之后便会被删除。
结算事件报告
结算事件报告是使用建议的计费单位根据基础消息计算的可计费事件的记录。可计费事件包含机密信息,但不包含用户个人身份信息(例如,没有 MSISDN、经过哈希处理的 MSISDN 或任何用户唯一标识符)。
只有已发布的代理才会生成结算事件。尚未启动或未发布的代理的活动不会显示在结算报告中。
结算报告假定事件是在传送消息时计费,而不是在消息发送时付费。传送前未传送或已撤消的消息不会触发结算事件。
每个 RBM 代理都有一个“结算类别”,由代理开发者在提交代理以供发布之前设置。结算类别决定了代理发送的消息是离散的,还是它们是否可以合并到对话式结算事件中。
可计费事件有五种类型:
事件 | 定义 |
---|---|
基本信息 | 一条应用与个人 (A2P) 消息
仅限对话代理:如果 P2A 消息在接下来的 24 小时内作为对 A2P 消息的回复传送,基本消息将成为 A2P 对话的一部分;否则,会话会终止。基本消息始终由代理发送给用户。 |
单条消息 | 一条应用与个人 (A2P) 消息
仅限对话代理:如果 P2A 消息在接下来的 24 小时内递送, 单条消息会成为 A2P 会话的一部分; 否则,会话会终止。代理始终会将一条消息传送给用户。 |
A2P 对话 | 仅适用于对话代理:当 P2A 消息在 A2P 单条消息或 A2P 基本消息发布后的 24 小时内送达时,系统会发起 A2P 对话。请注意,如果一条 P2A 消息在多条 A2P 消息发生后的 24 小时内传送,系统仅会使用紧接在 P2A 消息前面的 A2P 消息创建对话会话。此 A2P 消息以及在接下来的 24 小时内传送的任何消息都是新的 A2P 对话的一部分。 |
P2A 对话 | 仅适用于对话代理:当没有活跃会话(A2P 单条消息、A2P 对话或 P2A 对话)且传递了 P2A 消息,并且商家在 24 小时内回复时,将发起 P2A 对话。 |
P2A 消息 | 非对话代理:用户发送给代理的 P2A 消息,结算类别为单一消息或基本消息。
对话代理:用户向没有现有对话且代理未返回回复的代理发送的 P2A 消息。 |
可用性
结算事件报告可供在其网络上具有 RBM 流量的所有运营商使用。
形式
结算事件报告使用文件名格式 YYYY/MM/DD/rbm_billable_events_YYYY-MM-DD.csv
。
文件名中的日期即为文件的生成日期。该文件中的记录通常涵盖此日期前 2 天内的活动。
记录中的字段以制表符分隔,且每行有一条记录。
每个结算事件都有一条记录,即与同一代理进行的两次 A2P 对话将在结算报告中生成两个结算事件和两条记录。
可计费事件报告中的每条记录都包含每个事件的以下信息:
字段 | 形式 | 说明 | 示例 |
---|---|---|---|
billing_event_id
|
字符串 | 创建每个新事件时为其生成的 UUID 标识符(随机数字)。 | |
type
|
字符串 | 事件类型:
|
single_message
|
agent_id
|
字符串 | 参与活动的客服人员的标识符。 | rbm-welcome-bot@rbm.goog
|
agent_owner
|
字符串 | 参与了活动的客服人员所有者的电子邮件地址。这是指注册 RBM 代理的一方(大多数情况下为聚合信息网站),但在极少数情况下,也可能是品牌方。此值取自开发者 注册使用 RBM 时提供的“RBM Google 帐号”字段。 | name@aggregator.com
|
billing_party
|
字符串 | 为事件结算方。
|
carrier
|
max_duration_single_message
|
数值 | 用于标识单个消息会话的代理消息未收到响应的时长(以小时为单位)。 | 24
|
max_duration_a2p_conversation
|
数值 | A2P 会话的最长持续时间,以小时为单位。从第一次用户响应到代理的初始消息衡量。 | 24
|
max_duration_p2a_conversation
|
数值 | P2A 会话的最长持续时间,以小时为单位。根据对话中的第一条消息来衡量。 | 24
|
start_time
|
YYYY-mm-ddTHH:00:00Z | 事件的开始的世界协调时间 (UTC) 日期/时间(采用 ISO 8601 格式),四舍五入到最接近的小时。
|
2019-07-25T08:00:00Z
|
duration
|
数值 | 事件的时长,四舍五入至最接近的分钟。
当事件类型为 |
45
|
mt_messages
|
数值 | 事件中在移动设备上终止的消息的数量。 | 11
|
mo_messages
|
数值 | 事件中来自移动设备的消息的数量。 | 9
|
size_kilobytes
|
数值 | 事件中附加到消息的所有文件的大小,四舍五入到最接近的千字节(1kB = 1024 字节)。 | 912
|
agent_name
|
字符串 |
参与活动的客服人员。 |
XYZ Mobile USA
|
owner_name
|
字符串 | 参与了活动的客服人员的所有者。这是注册 RBM 代理的一方。在大多数情况下,指的是集合商家,但在极少数情况下,也可能是品牌。此值取自开发者 注册使用 RBM 时提供的“合作伙伴帐号的首选显示名称”。 | XYZ Mobile
|
示例文件
示例结算报告文件可供下载。
典型的文件大小
活跃合作伙伴的每日报告文件可能约有 53,000 条记录,大小约为 8Mb。
活动日志
活动日志是 RBM 平台上活动的原始数据日志,用于审核可计费事件和构建自定义事件。
可用性
活动日志仅适用于在其网络上具有 RBM 流量且根据自己的服务条款 (ToS) 使用 Jibe Cloud 启用 RCS 活动的运营商。如果您在 Jibe 的服务条款下使用 Jibe Cloud,则将无法访问活动日志。
形式
活动日志的文件名格式是 YYYY/MM/DD/rbm_activity_YYYY-MM-DD.csv
。
文件名中的日期即为文件的生成日期。该文件中的记录通常涵盖此日期前 2 天内的活动。
记录中的字段以制表符分隔,且每行有一条记录。
活动日志中的每条记录均包含针对每个活动事件的以下字段。
字段 | 形式 | 说明 | 示例 |
---|---|---|---|
activity_id
|
字符串 | activity 的标识符。 | |
billing_event_id
|
字符串 | 发生活动的结算事件的标识符。如果 activity 未与任何会话(例如没有相应 delivery_receipt_event 的 text_message )相关联,则可以为空。
| |
agent_id
|
字符串 | 代理的标识符。 | welcome-bot@rbm.goog
|
user_id
|
字符串 | 用户的 MSISDN。 | 918369110173
|
direction
|
字符串 | 消息发送方向:
|
MT
|
time
|
YYYY-mm-ddTHH:MM:SS.SSSZ | 事件提交到 RBM 平台的世界协调时间 (UTC) 日期/时间。 请参阅下面的注意。 | 2019-07-25T00:29:07.033Z
|
type
|
字符串 | 活动的类型:
|
text_message
|
size_bytes
|
字符串 | 附加到 activity 的文件的大小(以字节为单位)。 | 912
|
关于时间戳的注意事项
活动日志中的时间戳会记录将事件提交到 RBM 平台的时间。对于向用户传送内容的事件,在传送消息之前,系统不会将其写入活动日志。
例如,如果在星期三 13:00 向用户发送 RBM 消息,而收件人在星期日 09:00 之前一直处于离线状态,则该事件会显示在为星期日生成的活动日志中。活动日志中该事件的时间戳为星期三 13:00。