標準の請求レポートとアクティビティ ログ

このページでは、携帯通信会社が請求と監査を行う際に役立つよう、RCS for Business が作成するデータファイルについて説明します。

ファイル 説明 アクセスできるユーザー
請求レポート リリースされたエージェントとユーザー間の請求対象イベントの集計レポート。 RCS ビジネス メッセージを積極的に運用しているすべての携帯通信会社。
アクティビティ ログ 請求対象イベントを含む、RCS for Business アクティビティの生データログ。 RCS for Business を積極的に運用し、独自の利用規約に基づいて Google RCS サービスを運用している携帯通信会社。

RCS for Business では、米国以外のトラフィックに標準の請求モデルを使用します。詳細については、 請求に関するよくある質問をご覧ください。

ファイルの生成

各データファイルは、米国太平洋標準時(PST)での RCS ビジネス メッセージの使用状況を 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 宛てにメールでご連絡ください。
  • 命名: ファイル名の date は、ファイル生成日であり、ファイル内のデータの日付ではありません。
  • 保持: ファイルは最大 63 日間保存されてから削除されます。

これらのファイルを使用して、最新のプラットフォーム使用状況指標でデータ ウェアハウスを更新できます。

ファイルの保存とアクセス

データファイルは、保存時も転送時も暗号化されます。

セキュア ファイル転送プロトコル(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 エラーが表示されますが、これは想定される動作です。

報告する RCS for Business トラフィックがない場合、ファイルは生成されません。つまり、ファイルが生成されない日もあります。プロセスを効率化するために空の ファイルが必要な場合は、 RCS for Business サポートチームにお問い合わせください

請求レポート

請求レポートは、請求対象イベントの記録です。これは、エージェントの請求カテゴリと送信するメッセージのタイプに基づいて計算されます。請求レポートは、RCS for Business を積極的に運用しているすべての携帯通信会社が利用できます。

請求レポートには機密情報が含まれますが、MSISDN、ハッシュ化された MSISDN、ユーザーの一意の識別子などのユーザー個人情報(PII)は含まれません。

エージェントの請求カテゴリ

エージェントを作成する際、オーナーはエージェントとユーザーのやり取りの方法に基づいて請求カテゴリ を設定します。請求カテゴリによって、エージェントが送信できるメッセージの数やタイプが制限されることはありません。ただし、メッセージに対するエージェントの請求方法が決定されます。主な 2 つの請求カテゴリを次の表に示します。

請求カテゴリ エージェント タイプ サンプル ユースケース お支払い方法
会話型ではない 主に一方向のメッセージを送信するエージェント。
  • OTP
  • アラート
  • プロモーションの特典
ユーザーに配信されたメッセージごとに請求されます。
会話型 ユーザーとのやり取りを目的としたエージェント。
  • 適切な商品を見つける
  • チケットの予約
  • 問題のトラブルシューティング

会話ごとに請求: 一方(エージェントまたはユーザー)が 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 メッセージ。テキストに openGraph タグを含むウェブサイトの 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_messagesingle_messagea2p_conversation など)。

請求レポートの生成

請求対象イベントを生成するのは、テスター トラフィック以外のトラフィックを持つエージェントのみです。テスト用の電話番号からのアクティビティは、請求レポートに表示されません。

これらのレポートでは、イベントはメッセージが送信されたときではなく、メッセージが配信されたときに請求されることを前提としています。未配信のメッセージや、配信前にキャンセルされたメッセージでは、請求対象イベントはトリガーされません。

請求レポートの形式

請求レポートでは、ファイル名の形式として rbm_billable_events_YYYY-MM-DD.csv が使用されます。 ファイル名の date は、ファイル生成日です。

レポートの各行は、1 つの請求対象イベントを表すレコードです。レコード内のフィールドはタブで区切られます。たとえば、同じエージェントとの 2 つの A2P 会話では、2 つの別々の請求対象イベントと、請求レポートに 2 つのレコードが生成されます。

レポートの各レコードには、請求対象イベントごとに次の情報が含まれます。

フィールド 形式 説明
billing_event_id 文字列 請求対象イベントを区別する生成された ID。 242f1d9f-7c3f-4e5b-ab3f-818f188fa3ff
type 文字列 イベントのタイプ:
  • basic_message
  • single_message
  • a2p_conversation
  • p2a_conversation
  • p2a_message
single_message

p2a_rich_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 メッセージ

  • single_message イベントと basic_message イベントの場合、これはメッセージがユーザーに配信された時刻です。
  • a2p_conversation イベントの場合、これは会話の最初のメッセージがユーザーに配信された時刻です。

P2A メッセージ

  • `single_message` イベントと `basic_message` イベントの場合、これはユーザーがメッセージを送信した時刻です。
  • p2a_conversation イベントの場合、これは会話の最初のメッセージがユーザーによって送信された時刻です。
2019-07-25T08:00:00Z
duration 数値 イベントの期間(最も近い分に切り上げ)。

会話型ではないイベントの場合、値は 0 です。

45
mt_messages 数値 イベント内のモバイル終端(A2P)メッセージの数。 11
mo_messages 数値 イベント内のモバイル発信(P2A)メッセージの数。 9
size_kilobytes 数値 イベント内のメッセージに添付されたすべてのファイルのサイズ(最も近いキロバイトに切り上げ)。1 KB は 1024 バイトです。 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 つのレコードがあります。

アクティビティ ログの各レコードには、アクティビティごとに次のフィールドが含まれます。

フィールド 形式 説明
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(モバイル終端)
  • ユーザーからエージェントへのアクティビティの場合は MO(モバイル発信)
MT
time YYYY-mm-ddTHH:MM:SS.SSSZ イベントが RCS for Business プラットフォームに送信された日時(UTC 形式)。タイムスタンプをご覧ください。 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

タイムスタンプ

アクティビティ ログのタイムスタンプには、イベントが RCS ビジネス メッセージ プラットフォームに送信された時刻が記録されます。ユーザーにコンテンツを配信するイベントの場合、メッセージが配信されるまでイベントはアクティビティ ログに記録されません。

たとえば、RCS for Business メッセージが水曜日の 13:00 にユーザーに送信され、受信者が日曜日の 9:00 までオフラインの場合、イベントは日曜日に生成されたアクティビティ ログに表示されますが、タイムスタンプは水曜日の 13:00 になります。