このページでは、携帯通信会社が請求と監査を行う際に役立つよう、RCS for Business が作成するデータファイルについて説明します。
| ファイル | 説明 | アクセスできるユーザー |
|---|---|---|
| 請求レポート | リリースされたエージェントとユーザー間の課金対象イベントの集計レポート。 | RCS for Business を積極的に運用しているすべての携帯通信会社。 |
| アクティビティ ログ | 課金対象イベントを含む、RCS for Business アクティビティの元データログ。 | RCS for Business を積極的に運用し、独自の利用規約(ToS)に基づいて Google RCS サービスを運用している携帯通信会社。 |
RCS for Business では、米国以外のトラフィックに標準の課金モデルを使用します。詳細については、お支払いに関するよくある質問をご覧ください。
ファイル生成
各データファイルは、太平洋標準時(PST)での RCS for Business の 1 日の使用量を表します。ファイルは毎日生成され、前日 24 時間(午前 0 時から午前 0 時まで)のアクティビティが反映されます。生成プロセスには数時間かかることがあり、完了時間は異なる場合があります。
- 会話型ではないエージェントの場合、ファイルには、ファイルが生成された日の直前の 24 時間のデータが含まれます。たとえば、5 月 5 日に生成されたレポートには、5 月 4 日午前 0 時から 5 月 5 日午前 0 時までのデータが含まれます。指定された時間は PST タイムゾーンです。
会話型エージェントの場合、ファイルにはファイル生成時刻の 1 ~ 2 日前の 24 時間のデータが含まれます。たとえば、5 月 5 日に生成されたレポートには、5 月 2 日または 5 月 3 日の 24 時間のデータが含まれます。指定された時間は PST タイムゾーンです。
遅延が発生する理由は、会話エージェントの RCS for Business アクティビティがセッションにリンクされているためです。セッションが完了するまでに最大で 24 時間かかることがあります。この遅延により、RCS for Business は、課金対象イベントを計算する前に、会話内のすべてのメッセージをキャプチャできます。会話エージェントの詳細については、エージェントの課金カテゴリをご覧ください。
要点:
- アクティビティなし: デフォルトでは、特定の日付にプラットフォーム アクティビティがない場合、ファイルは生成されません。ただし、必要に応じて空のファイルを受け取るようにオプトインできます。オプトインするには、rbm-support@google.com までお問い合わせください。
- 命名: ファイル名のデータは、ファイル内のデータの日付ではなく、ファイルの生成日です。
- 保持: ファイルは最長 63 日間保存されてから削除されます。
これらのファイルを使用して、最新のプラットフォーム使用状況指標でデータ ウェアハウスを更新できます。
ファイル ストレージとアクセス
データファイルは保存データの暗号化と転送時の暗号化が行われます。
セキュア ファイル転送プロトコル(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 エラーが表示されますが、これは想定内です。
レポートする RCS for Business のトラフィックがない場合、ファイルは生成されません。つまり、ファイルが生成されない日もある可能性があります。プロセスを効率化するために空のファイルが必要な場合は、RCS for Business サポートチームにお問い合わせください。
お支払いとご請求に関するレポート
請求レポートは、課金対象イベントの記録です。課金対象イベントは、エージェントの請求カテゴリと送信するメッセージのタイプに基づいて計算されます。請求レポートは、RCS for Business を積極的に運用しているすべての携帯通信会社で利用できます。
請求レポートには機密情報が含まれますが、MSISDN、ハッシュ化された MSISDN、ユーザー固有の識別子などのユーザーの個人情報(PII)は含まれません。
エージェントの請求カテゴリ
エージェントを作成するときに、オーナーはエージェントがユーザーとどのようにやり取りするかに基づいて課金カテゴリを設定します。請求カテゴリは、エージェントが送信できるメッセージの数や種類を制限しません。ただし、メッセージに対するエージェントの課金方法を決定します。次の表に、2 つの主な課金カテゴリを示します。
| 請求カテゴリ | エージェント タイプ | サンプル ユースケース | 請求方法 |
|---|---|---|---|
| 非会話型 | 主に一方向のメッセージを送信するエージェント。 |
|
ユーザーに配信されたメッセージごとに課金されます。 |
| 会話型 | ユーザーとのやり取りを想定して設計されたエージェント。 |
|
会話ごとに課金: 一方(エージェントまたはユーザー)が 24 時間以内に他方からのメッセージに返信すると、会話が開始されます。会話ウィンドウ(最初の返信から 24 時間)の間、エージェントとユーザーは任意の数のメッセージをやり取りできます。エージェントには、会話の固定料金が請求されます。 メッセージごとに課金される場合: エージェントが送信したメッセージに 24 時間以内にお客様から返信がない場合、エージェントは会話エージェントでないエージェントと同様に、個々のメッセージに対して課金されます。 |
次の図は、会話型エージェントの A2P 課金セッションの例を示しています。
会話エージェントと非会話型エージェント
課金カテゴリには、会話型と非会話型の 2 つの主なカテゴリがあります。
請求カテゴリの主な違いは、会話エージェントと非会話型エージェントの間にあります。
会話エージェント以外のエージェントは、ユーザーに配信したメッセージごとに課金されます。
- このカテゴリは、頻繁な返信を想定していないエージェントに最適です。
会話エージェントには、会話に対してフラットレートが請求されます。会話には、24 時間以内にやり取りされたすべてのメッセージが含まれます。
- このカテゴリは、ユーザーと複数のターンからなる会話を行うエージェントに最適です。
請求対象イベント数
請求レポートには、5 種類の課金対象イベントが記録されます。これらのイベントには、A2P イベントと P2A イベントと呼ばれる MT イベントと MO イベントが含まれます。
- A2P(Application-to-Person)は MT(Mobile Terminated): 企業が送信するメッセージ。
- P2A(Person-to-Application)は MO(Mobile Originated): ユーザーが開始したメッセージまたはアクション。
次の表に、非会話エージェントと会話エージェントに適用される各課金対象イベントを示します。
| イベント | 説明 | 非会話エージェント | 会話エージェント |
|---|---|---|---|
basic_message
|
160 文字以下のテキストのみを含む A2P メッセージ。テキストに Open Graph タグを含むウェブサイトの URL が含まれている場合、パートナーに追加料金が発生することなく、メッセージに画像のプレビューが表示されることがあります。 | ユーザーが返信するかどうかに関係なく、常に個別の課金対象イベントとして扱われます。 | ユーザーが 24 時間以内に返信しない限り、個別の課金対象イベントとして扱われます。この場合、メッセージは a2p_conversation の一部になります。 |
single_message
|
リッチ コンテンツを含む A2P メッセージ、または 160 文字を超えるテキストのみのメッセージ。 | ユーザーが返信するかどうかに関係なく、常に個別の課金対象イベントとして扱われます。 | ユーザーが 24 時間以内に返信しない限り、個別の課金対象イベントとして扱われます。この場合、メッセージは a2p_conversation の一部になります。 |
a2p_conversation(ビジネス開始)
|
ユーザーが既存の会話以外で A2P メッセージを受信してから 24 時間以内に返信した場合に開始されます。 | なし。会話エージェント以外のエージェントは、このタイプのイベントを生成しません。 | 複数の A2P メッセージの 24 時間以内に P2A メッセージが配信された場合、P2A メッセージの直前の A2P メッセージのみが会話の開始に使用されます。この A2P メッセージと、その後の 24 時間以内に配信されたメッセージは、a2p_conversation の一部です。 |
p2a_conversation(ユーザー主導)
|
エージェントが既存の会話以外で P2A メッセージを受信してから 24 時間以内に返信した場合に開始されます。 | なし。会話エージェント以外のエージェントは、このタイプのイベントを生成しません。 | 複数の P2A メッセージの 24 時間以内に A2P メッセージが配信された場合、A2P メッセージの直前の P2A メッセージのみが会話の開始に使用されます。この P2A メッセージと、その後の 24 時間以内に配信されたメッセージは、p2a_conversation の一部です。 |
p2a_message
|
任意のタイプの P2A メッセージ。 | エージェントが返信するかどうかに関係なく、常に個別の課金対象イベントとして扱われます。 | エージェントが 24 時間以内に返信しない限り、個別の課金対象イベントとして扱われます。 |
請求カテゴリと課金対象イベント
エージェントの請求方法を理解するには、エージェントの請求カテゴリと請求対象イベントの違いを理解することが重要です。
- 請求カテゴリは、エージェントの作成時に選択する固定の分類です。エージェントの課金方法(メッセージ単位(非会話型エージェント)または会話単位(会話エージェント))を決定します。
- 課金対象イベントは、課金目的で追跡される RCS for Business エージェントとユーザー間のやり取りです(例:
basic_message、single_message、a2p_conversation)。
請求レポートの生成
テストユーザー以外のトラフィックのみが請求対象イベントを生成します。テスト用の電話番号からのアクティビティは、請求レポートに表示されません。
これらのレポートは、メッセージが送信されたときではなく、メッセージが配信されたときにイベントが課金されることを前提としています。配信されなかったメッセージや、配信前にキャンセルされたメッセージは、課金対象のイベントをトリガーしません。
請求レポートの形式
請求レポートのファイル名の形式は rbm_billable_events_YYYY-MM-DD.csv です。ファイル名の日は、ファイル生成日です。
レポートの各行は、1 つの課金対象イベントを表すレコードです。レコード内のフィールドはタブで区切られます。たとえば、同じエージェントとの 2 つの A2P 会話では、2 つの個別の課金対象イベントと、請求レポートに 2 つのレコードが生成されます。
ファイルはバイト オーダー マークなしで UTF-8 エンコードされ、行末にはラインフィードが使用されます。各ファイルの 1 行目は、フィールド名を含むヘッダー行です。
レポートの各レコードには、課金対象イベントごとに次の情報が含まれています。
| フィールド | 形式 | 説明 | 例 |
|---|---|---|---|
billing_event_id
|
文字列 | 課金対象イベントを区別する生成された ID。 | 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 形式、最も近い時間に丸められます)。 A2P メッセージ
P2A メッセージ
|
2019-07-25T08:00:00Z
|
duration
|
数値 | イベントの所要時間(分単位で四捨五入)。 会話以外のイベントの場合、値は 0 です。 |
45
|
mt_messages
|
数値 | イベント内のモバイル終端(A2P)メッセージの数。 | 11
|
mo_messages
|
数値 | イベント内のモバイル発信(P2A)メッセージの数。 | 9
|
size_kilobytes
|
数値 | イベント内のメッセージに添付されたすべてのファイルのサイズ。最も近いキロバイトに丸められます(1 KB は 1, 024 バイトに相当します)。 | 912
|
agent_name
|
文字列 |
イベントに参加したエージェントの名前。 |
XYZ Mobile USA
|
owner_name
|
文字列 | エージェントが作成されたパートナー アカウントの現在の所有者の名前。 | XYZ Mobile
|
請求レポートのサンプル
サンプル レポートはダウンロードできます。
一般的なファイルサイズ
アクティブな RCS for Business パートナーからの日次レポートのサイズは、携帯通信会社のネットワークで生成されたアクティビティの量によって異なります。たとえば、レポートに 53,000 件のレコードがある場合、ファイルのサイズは約 8 MB になります。
アクティビティ ログ
アクティビティ ログには、RCS for Business プラットフォームでのアクティビティに関する生データが記録されます。これらのログを使用して、課金対象イベントを監査し、カスタム イベントを作成できます。
アクティビティ ログには、詳細な取引情報や加入者の MSISDN などの個人情報(PII)が含まれているため、携帯通信会社が独自の利用規約に基づいて RCS を運用している場合にのみ利用できます。ネットワークで RCS for Business トラフィックがあり、Google の利用規約に基づいて Google RCS で RCS アクティビティを有効にしている場合、アクティビティ ログにアクセスすることはできません。
アクティビティ ログの形式
アクティビティ ログでは、ファイル名形式 rbm_activity_YYYY-MM-DD.csv が使用されます。ファイル名の date は、ファイルの生成日です。
レコード内のフィールドはタブで区切られ、1 行に 1 つのレコードがあります。
ファイルはバイト オーダー マークなしで UTF-8 エンコードされ、行末にはラインフィードが使用されます。各ファイルの 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 | イベントが RCS for Business プラットフォームに送信された日時(UTC 形式)。タイムスタンプをご覧ください。 | 2019-07-25T00:29:07.033Z
|
type
|
文字列 | アクティビティの種類:
|
text_message
|
size_bytes
|
文字列 | アクティビティに添付されたファイルのサイズ(バイト単位)。 | 912
|
タイムスタンプ
アクティビティ ログのタイムスタンプは、イベントが RCS for Business プラットフォームに送信された日時を記録します。ユーザーにコンテンツを配信するイベントの場合、メッセージが配信されるまでイベントはアクティビティ ログに記録されません。
たとえば、水曜日の 13:00 に RCS for Business メッセージがユーザーに送信され、受信者が日曜日の 9:00 までオフラインの場合、イベントは日曜日に生成されたアクティビティ ログに表示されますが、タイムスタンプは水曜日の 13:00 になります。