このページでは、携帯通信会社が請求と監査を行うために RCS for Business が作成するデータファイルについて説明します。RCS for Business の課金モデルに関するよくある質問については、課金に関するよくある質問を参照してください。
ファイル | 説明 | アクセスできるユーザー |
---|---|---|
請求イベント レポート | リリースされたエージェントとユーザー間の課金対象イベントの集計レポート。 | RCS for Business を積極的に運用しているすべての携帯通信会社。 |
アクティビティ ログ | 課金対象イベントを含む、ビジネス向け RCS アクティビティの生データログ。 | RCS for Business を積極的に運用し、独自の利用規約(ToS)に基づいて Google RCS サービスを運用している携帯通信会社。 |
ファイルの生成
各データファイルは、協定世界時(UTC)での RCS for Business の 1 日の使用状況を表します。ファイルは毎日生成されます。生成プロセスには数時間かかることがあり、完了時間は状況によって異なります。
会話型ではないエージェントの場合、ファイルにはファイル生成時間の直前の 24 時間のデータが含まれます。たとえば、5 月 5 日の 11:00 UTC に課金イベント レポートが生成された場合、5 月 4 日の 11:00 UTC から 5 月 5 日の 11:00 UTC までのデータが含まれます。
会話型エージェントの場合、ファイルにはファイル生成時刻の 1 ~ 2 日前の 24 時間のデータが含まれます。たとえば、5 月 5 日の 11:00 UTC に課金イベント レポートが生成された場合、5 月 3 日の 11:00 UTC から 5 月 4 日の 11:00 UTC までのデータが含まれることがあります。
遅延の理由は、会話エージェントの RCS for Business アクティビティが会話にリンクされているためです。この処理には最大 48 時間かかることがあります。この遅延により、RCS for Business は、課金イベントを計算する前に、会話内のすべてのメッセージをキャプチャできます。会話エージェントの詳細については、エージェントの課金カテゴリをご覧ください。
要点:
アクティビティなし: 特定の日にプラットフォーム アクティビティがない場合、ファイルは生成されません。
命名: ファイル名のデータは、ファイル内のデータの日付ではなく、ファイルの生成日です。
保持: ファイルは最大 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 のトラフィックがない場合、ファイルは生成されません。つまり、ファイルが生成されない日もあります。プロセスを効率化するために空のファイルが必要な場合は、rbm-support@google.com 宛にメールでご連絡ください。
請求イベント レポート
課金イベント レポートは、課金イベントの記録です。課金イベントは、エージェントの課金カテゴリと送信するメッセージのタイプに基づいて計算されます。請求イベント レポートは、RCS for Business を積極的に運用しているすべての携帯通信会社で利用できます。
課金イベント レポートには機密情報が含まれますが、MSISDN、ハッシュ化された MSISDN、ユーザー固有の識別子などのユーザーの個人情報(PII)は含まれません。
エージェントの請求カテゴリ
エージェントを作成するときに、オーナーはエージェントがユーザーとどのようにやり取りするかに基づいて課金カテゴリを設定します。請求カテゴリによって、エージェントが送信できるメッセージの数や種類が制限されることはありません。ただし、エージェントに対するメッセージの課金方法を決定します。次の表に、主な 2 つの請求カテゴリを示します。
請求カテゴリ | エージェント タイプ | サンプル ユースケース | 請求方法 |
---|---|---|---|
非会話型 (Basic Message と Single Message のカテゴリを含む。注: これらの 2 つのカテゴリに違いはなくなりました。どちらのカテゴリのエージェントも、会話型以外のエージェントとして課金されます。 |
主に一方向のメッセージを送信するエージェント。 |
|
ユーザーに配信されたメッセージごとに課金されます。 |
会話型 | ユーザーとのやり取りを想定して設計されたエージェント。 |
|
会話ごとに課金: 一方(エージェントまたはユーザー)が 24 時間以内に他方からのメッセージに返信すると、会話が開始されます。会話ウィンドウ(最初の返信から 24 時間)の間は、エージェントとユーザーはメッセージを何度でも交換でき、エージェントには会話の固定料金が請求されます。 メッセージごとに課金: エージェントがメッセージを送信してから 24 時間以内にお客様から返信がない場合、エージェントは会話型でないエージェントと同様に、個々のメッセージに対して課金されます。 |
次の図は、会話型エージェントの A2P 課金セッションの例を示しています。
会話型エージェントと非会話型エージェント
課金対象のカテゴリは、会話型と非会話型の 2 つに大別されます。会話以外のカテゴリには、機能的に同じである Basic Message カテゴリと Single Message カテゴリが含まれます。これらのカテゴリのいずれかに属するエージェントは、会話型エージェント以外のエージェントとして課金されます。
課金カテゴリの主な違いは、会話型エージェントと非会話型エージェントです。
会話型以外のエージェントは、ユーザーに配信するメッセージごとに課金されます。
- このカテゴリは、頻繁な返信を想定していないエージェントに最適です。
会話型エージェントには、会話に対して定額料金が課金されます。会話には、24 時間以内にやり取りされたすべてのメッセージが含まれます。
- このカテゴリは、ユーザーとの間で複数回のやり取りを行うエージェントに最適です。
課金イベント
請求イベント レポートには、5 種類の請求イベントが記録されます。これらのイベントには、A2P メッセージと P2A メッセージが含まれます。
- A2P(Application-to-Person): ビジネスから送信されます。
- P2A(Person-to-Application): ユーザーによって送信されます。
次の表に、会話型エージェントと非会話型エージェントに適用される各課金イベントについて説明します。
イベント | 説明 | 非会話型エージェント | 会話型エージェント |
---|---|---|---|
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 時間以内に返信しない限り、個別の課金イベントとして扱われます。 |
課金イベントと課金カテゴリ
basic_message
と single_message
の課金イベントは、基本メッセージと単一メッセージの課金カテゴリと混同しないでください。
エージェント(課金カテゴリに関係なく)は、
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 つの課金イベントを表すレコードです。レコード内のフィールドはタブで区切られます。たとえば、同じエージェントとの 2 つの A2P 会話では、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 形式で指定し、最も近い時間に丸めます。 A2P メッセージ
P2A メッセージ
|
2019-07-25T08:00:00Z
|
duration
|
数値 | イベントの期間(分単位で四捨五入)。 イベントタイプが |
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
です。ファイル名の日は、ファイルの生成日です。
レコード内のフィールドはタブで区切られ、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 | イベントが RCS for Business プラットフォームに送信された日時(UTC 形式)。タイムスタンプをご覧ください。 | 2019-07-25T00:29:07.033Z
|
type
|
文字列 | アクティビティの種類:
|
text_message
|
size_bytes
|
文字列 | アクティビティに添付されたファイルのサイズ(バイト単位)。 | 912
|
タイムスタンプ
アクティビティ ログのタイムスタンプは、イベントが RCS for Business プラットフォームに送信された日時を記録します。ユーザーにコンテンツを配信するイベントの場合、メッセージが配信されるまでイベントはアクティビティ ログに記録されません。
たとえば、ビジネス向け RCS メッセージが水曜日の 13:00 にユーザーに送信され、受信者が日曜日の 9:00 までオフラインの場合、イベントは日曜日に生成されたアクティビティ ログに表示されますが、タイムスタンプは水曜日の 13:00 になります。