RBM は、概要レベルとトランザクション レベルでユーザーとエージェントのアクティビティを報告するデータファイルを作成します。データは複数のファイルに分割されます。
| ファイル | 説明 | アクセスできるユーザー |
|---|---|---|
| 請求イベント レポート | 起動されたエージェントとユーザーの間の請求対象イベントの記録 | ネットワークで RBM トラフィックを利用しているすべての携帯通信会社 |
| アクティビティ ログ | 未加工の RBM プラットフォーム アクティビティ データ | ネットワークに RBM トラフィックがあり、独自の利用規約に基づいて Jibe Cloud で RCS アクティビティを有効にしている携帯通信会社 |
生成
請求イベント レポートとアクティビティ ログの生成には 2 日の遅延があります。
Google は、所属する請求セッションが完了した場合にのみアクティビティ イベントをレポートします。セッションが完了するまでに最大 24 時間かかることがあります。請求パイプラインは 1 日に 1 回実行され、完了している（24 時間以上経過している）請求セッションのみが報告されます。
例:
d 日目にメッセージが送信され、課金セッションが開始されますが、1 時間前のパイプライン実行が行われませんでした。そのため、アクティビティ イベントは報告されません。
パイプラインが d+1 に再び実行されたとき、メッセージによって開始されたセッションは 23 時間前のものです。したがって、このメッセージのアクティビティ イベントは d+1 で報告されません。
パイプラインが d+2 に再び実行されると、セッションは完了しており、アクティビティ イベントが課金セッションとともに報告されます。
ストレージとアクセス
データファイルは保存時も転送時も暗号化されます。
SFTP でデータファイルを取得するには、SFTP 公開鍵を指定する必要があります。鍵を生成するには、SFTP ドロップボックス用に Secure Shell（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 にお問い合わせください。
更新と保持
各データファイルは、1 日のプラットフォーム使用量（UTC 時間）を表します。特定の日のレコードが 1 回生成され、その日の終了後 2 日（48 時間）以内に確定されます。これらのファイルをデータ ウェアハウスに読み込むと、当月の指標を更新できます。
考慮すべきアクティビティがない場合、ファイルは生成されません。
各ファイルの名前の日付は、ファイルが生成された日付です。ファイル内のレコードには、ファイルの日付の 2 日前の UTC の日付が含まれます。
ファイルを生成する書き出し処理は、太平洋標準時の午前 2 ～ 4 時の間に行われます。
データファイルは、削除されるまで最大 30 日間保持されます。
請求イベント レポート
請求イベント レポートは、推奨課金単位を使用して基盤となるメッセージから計算された、課金対象イベントの記録です。課金対象イベントには機密情報が含まれますが、ユーザーの PII（MSISDN、ハッシュ化された MSISDN、ユーザーの一意の識別子など）は含まれません。
リリースされたエージェントのみが請求イベントを生成します。まだリリースされていないエージェントやリリースされていないエージェントのアクティビティは、請求レポートに表示されません。
請求レポートでは、イベントに対する課金はメッセージの送信時ではなく、メッセージの配信に基づいて行われることを前提としています。配信前に未配信または取り消されたメッセージによって請求イベントがトリガーされることはありません。
各 RBM エージェントには請求カテゴリがあり、起動に向けてエージェントを送信する前に、エージェント デベロッパーが設定します。請求カテゴリにより、エージェントが送信するメッセージが個別か、または会話型の課金イベントに統合されるかが決まります。
課金対象イベントには次の 5 種類があります。
| イベント | 定義 |
|---|---|
| 基本的なメッセージ | アプリケーション間（A2P）のメッセージが
会話エージェントのみ: 今後 24 時間以内に P2A メッセージが A2P メッセージに対するレスポンスとして配信されると、基本メッセージは A2P 会話の一部になります。それ以外の場合は、セッションが終了します。基本メッセージは、常にエージェントからユーザーに配信されます。 |
| 単一のメッセージ | アプリケーション間（A2P）のメッセージが
会話エージェントのみ: P2A メッセージが 24 時間以内に配信されると、シングル メッセージは A2P 会話の一部になります。それ以外の場合は、セッションが終了します。単一のメッセージは常にエージェントからユーザーに配信されます。 |
| A2P の会話 | 会話エージェントのみに適用: A2P 会話は、A2P シングル メッセージまたは A2P ベーシック メッセージから 24 時間以内に P2A メッセージが配信されると開始されます。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 日前のアクティビティが含まれます。
レコードのフィールドはタブ区切りで示され、1 行に 1 つのレコードが存在します。
請求イベントごとに 1 つのレコードが記録されます。つまり、同じエージェントとの 2 つの A2P 会話では、請求レポートに 2 つの請求イベントと 2 つのレコードが生成されます。
課金対象イベント レポートの各レコードには、各イベントに関する次の情報が含まれています。
| 項目 | 形式 | 説明 | 例 |
|---|---|---|---|
billing_event_id
|
文字列 | 新しいイベントの作成時に生成される UUID 識別子（乱数）。 | |
type
|
文字列 | アクティビティの種類:
|
single_message
|
agent_id
|
文字列 | イベントに参加したエージェントの 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）。1 時間単位で四捨五入された ISO 8601 形式です。
|
2019-07-25T08:00:00Z
|
duration
|
数値 | イベントの継続時間（分単位で四捨五入）。
イベントタイプが |
45
|
mt_messages
|
数値 | イベント内のモバイル終了メッセージの数。 | 11
|
mo_messages
|
数値 | イベント内のモバイル発信メッセージの数。 | 9
|
size_kilobytes
|
数値 | イベントのメッセージに添付されたすべてのファイルのサイズ。最も近いキロバイト（1 KB = 1, 024 バイト）に丸められます。 | 912
|
agent_name
|
文字列 |
イベントに参加したエージェント。 |
XYZ Mobile USA
|
owner_name
|
文字列 | イベントに参加したエージェントのオーナー。これは、RBM エージェントを登録した当事者です。ほとんどの場合、アグリゲータである場合もありますが、まれにブランドである場合もあります。この値は、デベロッパーが RBM を使用するように登録したときに提供された「パートナー アカウントの優先表示名」から取得されます。 | XYZ Mobile
|
サンプル ファイル
サンプルの請求レポート ファイルは、ダウンロードできます。
一般的なファイルサイズ
アクティブなパートナーが提供する日次レポート ファイルは約 53,000 レコードで、サイズは約 8 MB です。
アクティビティ ログ
アクティビティ ログは、RBM プラットフォーム上のアクティビティの元データログで、課金対象イベントの監査とカスタム イベントの作成を目的としています。
対象
アクティビティ ログを利用できるのは、自社のネットワーク上に RBM トラフィックがあり、独自の利用規約に基づいて Jibe Cloud での RCS アクティビティを有効にしている携帯通信会社のみです。Jibe の利用規約に基づいて Jibe Cloud を使用している場合は、アクティビティ ログにアクセスできません。
形式
アクティビティ ログのファイル名の形式は YYYY/MM/DD/rbm_activity_YYYY-MM-DD.csv です。
ファイル名の日付は、ファイルが生成された日付です。通常、ファイル内のレコードには、この日付の 2 日前のアクティビティが含まれます。
レコードのフィールドはタブ区切りで示され、1 行に 1 つのレコードが存在します。
アクティビティ ログの各レコードには、各アクティビティ イベントについて次のフィールドが含まれます。
| 項目 | 形式 | 説明 | 例 |
|---|---|---|---|
activity_id
|
文字列 | アクティビティの識別子。 | |
billing_event_id
|
文字列 | アクティビティが発生した請求イベントの識別子。アクティビティがどのセッションにも関連付けられていない場合（対応する delivery_receipt_event のない text_message など）は空になることがあります。 | |
agent_id
|
文字列 | エージェントの 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
|
文字列 | アクティビティに添付されたファイルのサイズ（バイト単位）。 | 912
|
タイムスタンプに関する注意事項
アクティビティ ログのタイムスタンプには、イベントが RBM プラットフォームに送信された時刻が記録されます。ユーザーにコンテンツを配信するイベントの場合、メッセージが配信されるまで、イベントはアクティビティ ログに書き込まれません。
たとえば、水曜日の 13:00 にユーザーに RBM メッセージを送信し、受信者が日曜日の 09:00 までオフラインの場合、日曜日用に生成されたアクティビティ ログにそのイベントが記録されます。アクティビティ ログのイベントのタイムスタンプは水曜日 13:00 です。