報告和記錄

RBM 會建立資料檔案,用於回報摘要和交易層級的使用者和代理程式活動。資料會分成多個檔案:

檔案 說明 有權存取的使用者
帳單事件報表 已啟動代理程式和使用者之間的收費事件記錄 自家網路提供 RBM 流量的所有電信業者
活動記錄 原始 RBM 平台活動資料 採用 RBM 流量的電信業者,並根據自家的《服務條款》(ToS) 透過 Jibe Cloud 啟用 RCS 活動

產生

帳單事件報表和活動記錄的產生延遲時間會延遲兩天。

只有在其所屬的計費工作階段完成時,Google 才會報告活動事件。一個工作階段最多可能需要 24 小時才能完成,我們的計費管道每天都會執行一次,並且只會回報確認已完成 (因此至少已 24 小時) 的帳單工作階段。

例如:

  • 系統會在第 d 天傳送訊息並啟動帳單工作階段,但錯過管道執行作業 1 小時。因此,系統不會回報任何活動事件。

  • 當管道在 d+1 上再次執行時,啟動訊息的工作階段只有 23 小時。因此,d+1 不會回報此訊息的活動事件。

  • 當管道在 d+2 上再次執行時,工作階段已完成,因此系統會回報活動事件和帳單工作階段。

儲存空間與存取權

靜態資料和傳輸中的資料檔案都會經過加密。

如要透過 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 聯絡。

重新整理與保留

每個資料檔案都代表一天中平台的使用情況 (世界標準時間)。一天的記錄產生一次,並在當天結束後的 2 天 (48 小時) 內完成結算。如果您將這些檔案載入資料倉儲系統,可以更新當月指標。

如果沒有合適的活動,系統就不會產生檔案。

每個檔案名稱中的日期都是產生檔案的日期。檔案中的記錄內容會涵蓋檔案日期前 2 天的世界標準時間。

產生檔案的匯出程序會在太平洋標準時間凌晨 2 點至 4 點間執行。

資料檔案最多會保留 30 天,之後就會刪除。

帳單事件報表

帳單事件報表是依據建議的計費單位,根據基本訊息計算的收費事件記錄。可計費事件包含機密資訊,但沒有使用者 PII (例如,沒有 MSISDN、經過雜湊處理的 MSISDN 或任何使用者專屬 ID)。

只有啟動的代理程式會產生計費事件。尚未啟動或未啟動代理程式的活動,不會顯示在帳單報表中。

帳單報表會假設事件是針對訊息的傳送而收費,而不是在訊息傳送時收費。傳送前無法傳送或遭撤銷的訊息,則不會觸發帳單事件。

每個 RBM 代理程式都有一個「Billing Category」,由代理程式開發人員在提交代理程式以進行啟動前設定。帳單類別可決定代理程式傳送的訊息是否獨立,或是否可合併為對話計費事件。

計費事件分為五種類型:

活動 定義
基本訊息

給人的訊息 (A2P) 訊息,

  • 最多 160 個半形字元
  • 僅包含文字

僅限對話代理程式:如果在接下來 24 小時內傳送 P2A 訊息做為 A2P 訊息的回應,則基本訊息會成為 A2P 對話的一部分,否則工作階段就會終止。基本訊息一律會從服務專員傳送給使用者。

單一訊息

給人的訊息 (A2P) 訊息,

  • 包含多媒體或文字,超過 160 個字元

僅限對話代理程式:如果 P2A 訊息在接下來 24 小時內傳送,則單一訊息會成為 A2P 對話的一部分;否則,工作階段會終止。代理程式一律會從服務專員傳送給使用者。

A2P 對話 僅適用於對話代理程式:如果 P2A 訊息在 A2P 單一訊息或 A2P 基本訊息後的 24 小時內傳送,系統就會啟動 A2P 對話。請注意,如果 P2A 訊息在多則 A2P 訊息的 24 小時內傳送,則只有在緊接 P2A 訊息之前的 A2P 訊息才會用來建立對話工作階段。這則 A2P 訊息以及未來 24 小時內傳送的所有訊息,都屬於新的 A2P 對話。
P2A 對話 僅適用於對話型代理程式:如果沒有執行中的工作階段 (A2P 單一訊息、A2P Conversation 或 P2A Conversation),以及 P2A 訊息且商家在 24 小時內回覆,系統就會啟動 P2A 對話。
P2A 訊息 非對話代理程式:使用者向代理程式傳送 P2A 訊息,訊息的帳單類別為單一訊息或基本訊息。

對話代理程式:使用者向代理程式傳送 P2A 訊息,但該代理程式目前沒有任何對話,且代理程式不會傳回回覆。

服務提供狀況

凡是在自家網路具有 RBM 流量的電信業者都能使用帳單事件報表。

形式

帳單事件報表的檔案名稱格式為 YYYY/MM/DD/rbm_billable_events_YYYY-MM-DD.csv

檔案名稱中的日期即為產生檔案的日期。檔案中的記錄通常涵蓋這個日期前 2 天的活動。

記錄中的欄位是以定位點分隔,且每行有一筆記錄。

每個計費事件都會產生一筆記錄,也就是說,與同一個代理程式進行兩個 A2P 對話,會在帳單報表中產生兩個帳單事件和兩筆記錄。

收費事件報表中的每筆記錄都包含每個事件的下列資訊:

欄位 形式 說明 範例
billing_event_id 字串 每次建立新事件時,都會產生一組 UUID ID。
type 字串 事件類型:
  • basic_message
  • single_message
  • a2p_conversation
  • p2a_conversation
  • p2a_message
single_message
agent_id 字串 參與事件的服務專員 ID。 rbm-welcome-bot@rbm.goog
agent_owner 字串 參與活動的服務專員擁有的電子郵件地址。在大多數情況下,這是註冊 RBM 代理程式的一方,但在極少數情況下,可能是品牌。這個值取自開發人員 註冊使用 RBM 時提供的「RBM Google 帳戶」欄位。 name@aggregator.com
billing_party 字串 活動費用的付款方。
  • google
  • 電信業者
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 活動開始的日期/時間 (世界標準時間),以 ISO 8601 格式四捨五入至最接近的小時數。
  • 如果是 a2p_conversationp2a_conversation 事件,這就是工作階段開始的時間。
  • 如果是 single_messagebasic_message 事件,這是指事件發生的時間。
2019-07-25T08:00:00Z
duration 數字 事件的時間長度,會四捨五入至最接近的分鐘數。

如果事件類型為 single_messagebasic_message,這個值會是 0。

45
mt_messages 數字 事件中由行動裝置終止的訊息數量。 11
mo_messages 數字 事件中來自行動裝置的訊息數量。 9
size_kilobytes 數字 事件中訊息附加的所有檔案大小,四捨五入至最接近的 KB 數 (1 kB = 1, 024 個位元組)。 912
agent_name 字串

參與活動的服務專員。

XYZ Mobile USA
owner_name 字串 參與活動的服務專員擁有者。這是指註冊 RBM 代理程式的一方。在大多數情況下,這是集結網站,但在少數情況下,可能是品牌。這個值取自開發人員 註冊使用 RBM 時提供的「合作夥伴帳戶偏好的顯示名稱」。 XYZ Mobile

範例檔案

您可以下載帳單報表範例檔案。

一般檔案大小

有效合作夥伴的每日報表檔案約可達 53,000 筆記錄,大小約為 8 MB。

活動記錄

活動記錄是 RBM 平台上活動記錄的原始資料記錄,用於稽核可計費事件及建構自訂事件。

服務提供狀況

活動記錄僅適用於具有 RBM 流量的電信業者,且根據其《服務條款》(ToS) 透過 Jibe Cloud 啟用 RCS 活動。如果您在 Jibe 的 ToS 下使用 Jibe Cloud,則無法存取活動記錄。

形式

活動記錄使用檔案名稱格式 YYYY/MM/DD/rbm_activity_YYYY-MM-DD.csv

檔案名稱中的日期即為產生檔案的日期。檔案中的記錄通常涵蓋這個日期前 2 天的活動。

記錄中的欄位是以定位點分隔,且每行有一筆記錄。

活動記錄中的每筆記錄都包含以下每個活動事件的欄位。

欄位 形式 說明 範例
activity_id 字串 活動的 ID。
billing_event_id 字串 活動發生帳單事件的 ID。如果活動未與任何工作階段建立關聯 (例如沒有對應 delivery_receipt_eventtext_message),則可留空。
agent_id 字串 代理程式的 ID。 welcome-bot@rbm.goog
user_id 字串 使用者的 MSISDN。 918369110173
direction 字串 傳送訊息的方向:
  • MT (行動裝置終止服務) 供服務專員之間的使用者活動使用
  • MO (行動裝置來源) 適用於使用者和服務專員活動
MT
time YYYY-mm-ddTHH:MM:SS.SSSZ 將活動提交至 RBM 平台的日期/時間 (世界標準時間)。 請參閱下方的注意事項 2019-07-25T00:29:07.033Z
type 字串 活動類型:
  • text_message
  • file_transfer
  • rich_card/carousel
  • suggestion_tap
  • delivery_receipt_event
  • read_receipt_event
  • spam_report
text_message
size_bytes 字串 活動中附加的檔案大小,以位元組為單位。 912

時間戳記注意事項

活動記錄中的時間戳記會記錄事件提交至 RBM 平台的時間。對於將內容傳送給使用者的事件,訊息送達之前不會寫入活動記錄。

舉例來說,如果在星期三 13:00 將 RBM 訊息傳送給使用者,而收件者在週日 09:00 就處於離線狀態,則該事件會出現在星期日產生的活動記錄中。活動記錄中的事件時間戳記為星期三 13:00。