このページでは、携帯通信会社が請求と監査を行う際に役立つように RBM が作成するデータファイルについて説明します。RBM 課金モデルに関するよくある質問については、RBM の課金に関するよくある質問をご覧ください。
| ファイル | 説明 | アクセスできるユーザー |
|---|---|---|
| 請求イベント レポート | 開始されたエージェントとユーザー間の課金対象イベントの集計レポート。 | RBM（RCS ビジネス メッセージ）を積極的に運用しているすべての携帯通信会社。 |
| アクティビティ ログ | 課金対象イベントを含む、RBM アクティビティの元データログ。 | RBM（RCS ビジネス メッセージ）を積極的に運用し、独自の利用規約（ToS）に基づいて Google RCS サービスを運用している携帯通信会社。 |
ファイルの生成
各データファイルは、協定世界時（UTC）で 1 日間の RBM 使用量を表します。ファイルは毎日生成されます。生成プロセスには数時間かかることがあります。完了時間は変動します。
会話以外のエージェントの場合、ファイルにはファイルの生成時間の直前 24 時間のデータが含まれます。たとえば、5 月 5 日午前 11 時（UTC）に課金イベント レポートが生成された場合、5 月 4 日午前 11 時（UTC）から 5 月 5 日午前 11 時（UTC）までのデータが含まれます。
会話型エージェントの場合、ファイルにはファイル生成時間の 1 ～ 2 日前の 24 時間のデータが含まれます。たとえば、5 月 5 日午前 11 時（UTC）に課金イベント レポートが生成された場合、5 月 3 日午前 11 時（UTC）から 5 月 4 日午前 11 時（UTC）までのデータが含まれる場合があります。
遅延の理由は、会話エージェントの RBM アクティビティが会話にリンクされており、完了までに最大 48 時間かかる可能性があるためです。この遅延により、RBM は課金イベントを計算する前に会話内のすべてのメッセージをキャプチャできます。会話型エージェントの詳細については、エージェントの課金カテゴリをご覧ください。
要点:
アクティビティなし: 特定の日にプラットフォーム アクティビティがない場合、ファイルは生成されません。
命名: ファイル名の日付は、ファイルの生成日であり、内部のデータの日付ではありません。
保持: ファイルは最大 30 日間保存されてから削除されます。
これらのファイルを使用して、最新のプラットフォーム使用状況指標でデータ ウェアハウスを更新できます。
ファイルの保存とアクセス
データファイルは保存時と転送時に暗号化されます。
セキュア ファイル転送プロトコル（SFTP）でデータファイルを取得するには、SFTP 公開鍵を指定します。鍵を生成するには、SFTP ドロップボックス用にセキュアシェル（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 までお問い合わせください。
請求イベント レポート
課金イベント レポートは、課金イベントのレコードです。これは、エージェントの課金カテゴリと送信するメッセージの種類に基づいて計算されます。請求イベント レポートは、RBM（RCS ビジネス メッセージ）を積極的に運用しているすべての携帯通信会社が利用できます。
課金イベント レポートには機密情報が含まれますが、MSISDN、ハッシュ化された MSISDN、ユーザーの一意の識別子などの個人を特定できる情報（PII）は含まれません。
エージェントの請求カテゴリ
エージェントを作成する際、オーナーはエージェントがユーザーとどのようにやり取りするかに基づいて課金カテゴリを設定します。請求カテゴリは、エージェントが送信できるメッセージの数や種類を制限するものではありません。ただし、エージェントへのメッセージの課金方法は決まります。主な 2 つの課金カテゴリを次の表に示します。
| 請求カテゴリ | エージェント タイプ | サンプル ユースケース | 請求方法 |
|---|---|---|---|
会話以外 （基本メッセージと単一メッセージのカテゴリが含まれます。注: これらの 2 つのカテゴリに違いはありません。どちらのカテゴリに属するエージェントも、会話型以外のエージェントとして課金されます）。 |
主に一方向のメッセージを送信するエージェント。 |
|
ユーザーに配信されたメッセージごとに課金されます。 |
| 会話型 | ユーザーとのやり取りを想定して設計されたエージェント。 |
|
会話ごとに課金: 一方の当事者（エージェントまたはユーザー）が 24 時間以内にもう一方の当事者からのメッセージに返信すると、会話が開始されます。会話ウィンドウ（最初の返信から 24 時間後）中、エージェントとユーザーは任意の数のメッセージを交換できます。エージェントには、会話に対して固定料金が請求されます。 メッセージ単位で課金: エージェントがメッセージを送信し、ユーザーが 24 時間以内に返信しなかった場合、会話型以外のエージェントと同様に、エージェントは個々のメッセージに対して課金されます。 |
会話型エージェントと非会話型エージェント
課金カテゴリは、会話型と非会話型の 2 つに大きく分けられます。会話以外のカテゴリには、基本メッセージ カテゴリと単一メッセージ カテゴリが含まれます。これらのカテゴリは機能的に同じです。これらのカテゴリのいずれかに該当するエージェントは、会話型エージェントとして請求されます。
課金カテゴリの主な違いは、会話型エージェントと非会話型エージェントにあります。
会話型以外のエージェントは、ユーザーに送信するメッセージごとに課金されます。
- このカテゴリは、返信が頻繁に行われないエージェントに最適です。
会話型エージェントは、会話ごとに定額料金が請求されます。会話には、24 時間以内にやり取りされたすべてのメッセージが含まれます。
- このカテゴリは、ユーザーとのマルチターンの会話を行うエージェントに最適です。
課金イベント
請求イベント レポートには、5 種類の請求イベントが記録されます。これらのイベントには、A2P メッセージと P2A メッセージが含まれます。
- A2P（アプリケーション対個人）: 企業から送信されます。
- P2A（ユーザーからアプリ）: ユーザーが送信します。
次の表に、会話型以外のエージェントと会話型エージェントに適用される各課金イベントを示します。
| イベント | 説明 | 会話型以外のエージェント | 会話エージェント |
|---|---|---|---|
basic_message
|
160 文字以下のテキストのみを含む A2P メッセージ。テキストに openGraph タグが設定されたウェブサイトの URL が含まれている場合、パートナーに追加料金なしでメッセージに画像のプレビューが表示されることがあります。 | ユーザーが返信したかどうかにかかわらず、常に個別の課金イベントとして扱われます。 | ユーザーが 24 時間以内に返信しない限り、個別の請求イベントとして扱われます。その場合、メッセージは a2p_conversation の一部になります。 |
single_message
|
マルチメディアや 160 文字を超えるテキストを含む A2P メッセージ。 | ユーザーが返信したかどうかにかかわらず、常に個別の課金イベントとして扱われます。 | ユーザーが 24 時間以内に返信しない限り、個別の請求イベントとして扱われます。その場合、メッセージは a2p_conversation の一部になります。 |
a2p_conversation（ビジネス主導）
|
ユーザーが A2P メッセージを受信してから 24 時間以内に、既存の会話の外部で A2P メッセージに返信したときに開始されます。 | なし。会話以外のエージェントは、このタイプのイベントを生成しません。 | 複数の A2P メッセージの送信から 24 時間以内に P2A メッセージが配信された場合、会話の開始には P2A メッセージの直前に送信された A2P メッセージのみが使用されます。この A2P メッセージと、今後 24 時間以内に配信されるメッセージは、a2p_conversation の一部です。 |
p2a_conversation（ユーザー開始） |
エージェントが P2A メッセージを受信してから 24 時間以内に、既存の会話の外部で P2A メッセージに返信すると開始されます。 | なし。会話以外のエージェントは、このタイプのイベントを生成しません。 | 複数の P2A メッセージの送信から 24 時間以内に A2P メッセージが配信された場合、会話の開始には A2P メッセージの直前に送信された P2A メッセージのみが使用されます。この P2A メッセージと、今後 24 時間以内に配信されるメッセージは、p2a_conversation の一部です。
|
p2a_message
|
任意のタイプの P2A メッセージ。 | エージェントが返信したかどうかにかかわらず、常に個別の課金イベントとして扱われます。 | エージェントが 24 時間以内に返信しない限り、個別の課金イベントとして扱われます。 |
課金イベントと請求カテゴリ
請求イベントの basic_message と single_message は、請求カテゴリの「基本メッセージ」と「単一メッセージ」と混同しないでください。
どのエージェントでも（請求カテゴリに関係なく）
basic_messageとsingle_messageの請求イベントを生成できます。基本メッセージと単一メッセージの課金カテゴリは、会話以外のエージェントを分類するために使用されます。これらの課金カテゴリのエージェントは、会話型課金イベント（
a2p_conversationsまたはp2a_conversations）を生成しません。代わりに、個々のbasic_message、single_message、p2a_messageの課金イベントを生成します。
請求レポートの生成
課金イベントを生成するエージェントは、テスター以外のトラフィックがあるエージェントのみです。テスト用の電話番号からのアクティビティは、お支払いイベント レポートには表示されません。
これらのレポートでは、イベントはメッセージの送信時ではなく、メッセージの配信時に課金されることを前提としています。配信されなかったメッセージや、配信前にキャンセルされたメッセージは、課金イベントをトリガーしません。
請求レポートの形式
請求イベント レポートのファイル名の形式は rbm_billable_events_YYYY-MM-DD.csv です。ファイル名の日付は、ファイルの生成日です。
レポートの各行は、1 つの課金イベントを表すレコードです。レコード内のフィールドはタブで区切られています。たとえば、同じエージェントとの A2P 会話が 2 回ある場合、請求イベントが 2 つ生成され、請求イベント レポートに 2 つのレコードが作成されます。
レポートの各レコードには、請求イベントごとに次の情報が含まれます。
| フィールド | 形式 | 説明 | 例 |
|---|---|---|---|
billing_event_id
|
文字列 | UUID 識別子。新しいイベントの作成時に生成される乱数。 | 242f1d9f-7c3f-4e5b-ab3f-818f188fa3ff
|
type
|
文字列 | イベントの種類:
|
single_message
|
agent_id
|
文字列 | イベントに参加したエージェントの一意の識別子。 | rbm-welcome-bot@rbm.goog
|
agent_owner
|
文字列 | エージェントを作成したパートナー アカウントの現在の所有者のメールアドレス。 | name@aggregator.com
|
billing_party
|
文字列 | イベントの請求を行う当事者。
|
carrier
|
max_duration_single_message
|
数値 | 会話開始ウィンドウが閉じてメッセージが 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 形式で、1 時間単位に丸められます。 A2P メッセージ
P2A メッセージ
|
2019-07-25T08:00:00Z
|
duration
|
数値 | イベントの所要時間（分単位で四捨五入）。 イベントタイプが |
45
|
mt_messages
|
数値 | イベント内のモバイル終了（A2P）メッセージの数。 | 11
|
mo_messages
|
数値 | イベント内のモバイル起源（P2A）メッセージの数。 | 9
|
size_kilobytes
|
数値 | イベント内のメールに添付されているすべてのファイルのサイズ（KB 単位、1 KB = 1, 024 バイト）。 | 912
|
agent_name
|
文字列 |
イベントに参加したエージェントの名前。 |
XYZ Mobile USA
|
owner_name
|
文字列 | エージェントが作成されたパートナー アカウントの現在の所有者の名前。 | XYZ Mobile
|
課金イベント レポートの例
請求レポートのサンプル ファイルはこちらからダウンロードできます。
一般的なファイルサイズ
有効な RBM パートナーからの日次レポートには、約 53,000 件のレコードが含まれ、サイズは約 8 MB です。
アクティビティ ログ
アクティビティ ログには、RBM プラットフォームでのアクティビティに関する元のデータが記録されます。これらのログを使用して、課金イベントを監査し、カスタム イベントを作成できます。
注: アクティビティ ログには、テスター以外の電話番号からのトラフィックのみが含まれます。
アクティビティ ログには、詳細な取引情報や加入者の MSISDN などの個人情報（PII）が含まれているため、携帯通信会社が独自の利用規約に基づいて RCS を運用している場合にのみ利用できます。ネットワークに RBM トラフィックがあり、Google の利用規約に基づいて Google RCS で RCS アクティビティを有効にしている場合、アクティビティ ログにアクセスすることはできません。
アクティビティ ログの形式
アクティビティ ログのファイル名の形式は rbm_activity_YYYY-MM-DD.csv です。ファイル名の日付は、ファイルの生成日です。
レコード内のフィールドはタブで区切られ、1 行に 1 つのレコードが記述されます。
アクティビティ ログの各レコードには、アクティビティごとに次のフィールドが含まれています。
| フィールド | 形式 | 説明 | 例 |
|---|---|---|---|
activity_id
|
文字列 | アクティビティの一意の識別子。 | b422e1d3-ac99-442a-853d-a875d5e61762
|
billing_event_id
|
文字列 | 関連付けられている課金イベントの一意の識別子。アクティビティが課金イベントに関連付けられていない場合は空白にできます（対応する delivery_receipt_event のない text_message など）。 |
91yeb201-7c3b-412b-98d2-b0a0f7abe536
|
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
|
文字列 | アクティビティに添付されているファイルのサイズ（バイト単位）。 | 912
|
タイムスタンプ
アクティビティ ログのタイムスタンプには、イベントが RBM プラットフォームに送信された日時が記録されます。ユーザーにコンテンツを配信するイベントの場合、メッセージが配信されるまで、イベントはアクティビティ ログに記録されません。
たとえば、水曜日の 13:00 にユーザーに RBM メッセージが送信され、受信者が日曜日の 9:00 までオフラインだった場合、イベントは日曜日に生成されたアクティビティ ログに表示されますが、タイムスタンプは水曜日の 13:00 になります。