請求レポート
パートナー企業は、以下の卸売請求APIを使用して、使用状況とプロビジョニングの正確性を検証するのに役立つ請求レポートを生成できます。卸売請求APIはdeveloper.webex.comからアクセスできます。
-
調整機能—パートナー別、顧客別、またはユーザー別の使用量を表示します。パートナー企業は、このカスタム請求レポート情報を使用して月次請求書を照合し、顧客やユーザーの利用状況に応じて請求を行うことができます。
-
特定時点—顧客ごと、またはユーザーごとの現在のパッケージ割り当て状況を表示します。ポイントインタイムレポートは、パッケージ割り当てのリアルタイムの件数を提供します。パートナー企業はこの情報を使用して、プロビジョニングの正確性を検証し、顧客の注文との整合性を確保できます。
パートナーは、subPartnerOrgId パラメータを使用して、サブパートナー向けのカスタム請求レポートを作成することもできます。
最低限のアクセス要件を満たすパートナー管理者向けに、4つのAPIが提供されています。
|
請求API |
APIの目的 |
パートナー管理者アクセス要件 |
|---|---|---|
|
卸売請求レポートを作成する |
請求書レポートを作成するために使用されます。 |
Read/write |
|
卸売請求レポートを入手する |
生成された請求レポートをダウンロードするために使用します。 |
既読 |
|
卸売請求レポート一覧 |
そのパートナーに対して存在する請求レポートを一覧表示するために使用されます。 |
既読 |
|
卸売請求レポートを削除する |
既存の請求レポートを削除するために使用します。 |
Read/write |
データソース
請求レポートのデータは、Webexが各パートナーについて追跡しているパッケージ割り当てと使用状況データから取得されます。Webexは、パートナー企業への月次請求書を作成するために、顧客およびユーザーのパッケージデータを毎日集計します。請求APIはこのデータを使用し、パートナー管理者がカスタムレポートを生成できるようにします。これらのレポートは、パートナー企業が月次請求書に記載されている使用量を、パートナー、顧客、ユーザーレベルで照合するのに役立ちます。
Webex がパートナーに請求する方法の詳細については、 サービスプロバイダーの請求を参照してください。
卸売請求レポートを作成する
| 1 |
developer.webex.comから、 卸売請求レポート API の作成に移動します。 |
| 2 |
以下のレポートカテゴリからいずれか1つを選択してください。
照合レポートを作成する場合は、照合がデフォルトで選択されているため、何も変更する必要はありません。そのまま次のステップに進んでください。特定時点のレポートを作成する場合は、選択を「特定時点」に変更してください。 |
| 3 |
APIで指定されている形式で 、 billingStartDateと billingEndDateを入力してください 。過去5年間の任意の日付を入力できますが、現在の日付は入力できません。 ポイントインタイムレポートの場合、 billingStartDate および billingEndDate フィールドは必須ではなく、入力しても無視されます。この報告書は常に、現在のパッケージ配分状況を反映しています。 |
| 4 |
レポートの 種類 を入力してください:
|
| 5 |
含める フィールドに、レポートに表示したい追加またはオプションの列を入力します。 各レポートタイプには、必須属性のセットとオプション属性のセットがあります。各レポートに表示するオプション属性を選択できます。オプション属性を含めない場合、レポートには必須属性のみが表示されます。 以下の列は、顧客およびユーザーレポートに含めるようにリクエストできるオプション属性です。
レポートにこれらの属性を表示するには、_顧客_グループIDと_顧客_グループ名を一緒に含める必要があります。 オプションの列を選択すると、顧客およびユーザー照合レポートの列の順序が変更されます。パートナー企業は、新しいCSV形式に対応するために、API統合を更新する必要があります。ポイントインタイムレポートの列順序は変更されません。 現在、列の順序を決定する際には、既存の機能設定がIncludeパラメーターよりも優先されます。例えば、特定の機能設定が顧客に対して有効になっている場合、その機能列は、Include パラメーターに追加しても、古いレポート形式に従って表示されます。これらの設定は近日中に削除する予定です。それらが削除されると、オプションの列はIncludeパラメータを通してのみ要求できるようになります。 |
| 6 |
実行 をクリックしてレポートを生成します。 |
| 7 |
API出力から レポート IDをコピーしてください。この値をGet APIで使用すると、生成された請求レポートを取得できます。 |
次に行うこと
卸売請求レポートの入手 セクションに移動して、レポートのコピーをダウンロードしてください。
卸売請求レポートを入手する
請求レポートが生成されたら、このAPIを使用して特定の請求レポートを取得します。レポートは指定されたURLに出力され、GETリクエスト完了後30分間はダウンロード可能です。
| 1 |
developer.webex.comから、 卸売請求レポートAPIの取得にアクセスしてください。 |
| 2 |
レポートの一意の id 値を入力し、 実行をクリックします。 APIはレポートステータスを出力します。出力には tempDownloadURL パラメータが含まれており、このパラメータからレポートをダウンロードできます。 |
| 3 |
レポートにアクセスしてダウンロードするには、 tempDownloadURL をブラウザにコピーしてください。 |
卸売請求レポート一覧
このAPIを使用して、パートナー組織向けに生成された請求レポートの一覧を取得します。既存のレポートをすべて一覧表示することも、請求期間や請求タイプ(パートナー、顧客、ユーザー)などの指定されたパラメータを満たすレポートのみに一覧を絞り込むこともできます。
オプションのパラメータを入力した場合、APIは指定したパラメータに完全に一致するレポートのみを返します。例えば、請求期間を指定した場合、その特定の請求期間を使用するレポートのみが返されます。対象期間内であっても、日付が完全に一致しないレポートは返送されません。
| 1 |
developer.webex.comから List Wholesale Billing Report APIに移動します。 |
| 2 |
クエリパラメータの下に、使用したい検索パラメータ(例:startDate、endDate、Type、sortBy on)を入力します。 |
| 3 |
[実行] をクリックします。 API は、レポートのリストと、一意のレポート id 、およびステータス (完了、進行中_) を出力します。
|
次に行うこと
ダウンロードしたいレポートについては、 id を記録しておいてください。 卸売請求レポートの入手 にアクセスしてレポートをダウンロードしてください。
卸売請求レポートを削除する
レポートIDに基づいて生成された請求レポートを削除するには、この手順を使用します。レポートを削除したい場合の例をいくつか挙げます。
-
既存の照合請求レポートを再生成する場合は、まず既存のレポートを削除する必要があります。既存のレポートを削除した後、その期間の新しいレポートを作成できます。レポートの生成が失敗した場合、または生成処理が進行中の場合は、レポートを削除することはできません。
特定時点レポートの場合、システムはこれらのレポートを再生成しないため、既存のレポートを削除する必要はありません。各レポートは常に、現在のタイムスタンプ時点のデータを反映しています。
-
生成されたレポートのURLを誤って別の人に送信してしまった場合は、レポートを削除することで、相手がアクセスできないようにすることができます。
| 1 |
developer.webex.comから 卸売請求レポート API の削除に移動します。 |
| 2 |
レポートIDを入力し、実行] をクリックします。 |
請求レポートの項目
請求レポートには以下の項目が含まれます。
|
フィールド |
説明 |
サポートされているレポートタイプ |
サポートされているレポートカテゴリ |
必須属性または任意属性 |
|---|---|---|---|---|
|
パートナー_氏名 |
パートナーの名前 |
パートナー、顧客、ユーザー |
和解、時点 |
必須 |
|
パートナー_組織_ID |
固有のパートナー識別子 |
パートナー、顧客、ユーザー |
和解、時点 |
必須 |
|
購読_ID |
固有の購読識別子 |
パートナー、顧客、ユーザー |
和解、時点 |
必須 |
|
顧客_グループ_ID | 顧客が所属するグループの固有識別子。 請求期間中に顧客がグループ間を移動した場合、使用量はその期間中に顧客が所属していたグループに基づいて分割されます。 |
顧客、ユーザー |
和解、時点 |
オプション |
|
顧客_グループ_名 | 顧客グループの表示名。 請求期間中にグループ名が変更された場合は、最新のグループ名が使用されます。 |
顧客、ユーザー |
和解、時点 |
オプション |
|
顧客_組織_ID |
社内顧客固有識別子 |
顧客、ユーザー |
和解、時点 |
必須 |
|
顧客_外部_ID |
パートナーから提供される顧客固有識別子 |
顧客、ユーザー |
和解、時点 |
必須 |
|
タイプ |
ユーザーまたはワークスペースの種類 |
顧客、ユーザー |
特定時点 |
必須 |
|
購読_者ID |
加入者の固有識別子 |
USER |
和解、時点 |
必須 |
|
USER_ID |
加入者のWebexユーザーID |
USER |
和解、時点 |
必須 |
|
ワークスペース_ID |
一意のワークスペース識別子 |
USER |
和解、時点 |
必須 |
|
サービス_名 |
サービス名 (例:共通_エリア通話_、_Webex通話、_Webexスイート、_Webexミーティング) |
パートナー、顧客、ユーザー |
和解、時点 |
必須 |
|
SKU |
サービスのSKU |
パートナー、顧客、ユーザー |
和解、時点 |
必須 |
|
説明 |
サービス内容の説明 |
パートナー、顧客、ユーザー |
和解、時点 |
必須 |
|
消費量_開始_日付 |
サービス利用開始。この値は、次のフィールドの値と合わせて、使用期間を定義します。 |
パートナー、顧客、ユーザー |
調整 |
必須 |
|
消費量_終了_日付 |
サービス利用終了。この値は、前述の項目と合わせて、使用期間を定義します。 |
パートナー、顧客、ユーザー |
調整 |
必須 |
|
レポート_日付 |
レポートが生成された日時。 |
顧客、ユーザー |
特定時点 |
必須 |
|
量 |
これは、パートナーごと、顧客ごと、またはユーザーごとの集計されたユーザー使用量消費量を表します(レポートおよびデータを表示するレベルによって異なります)。 計算:システムは、各ユーザーの1日あたりの使用量を、その日の使用量に応じて按分計算します。 1日中使用した場合 = 1 半日使用 = 0.5 次に、請求期間内のすべての日における日ごとの合計値を算出し、その請求期間における当該ユーザーの合計数量を計算します。 顧客およびパートナーレベルのレポートでは、すべてのユーザーの合計が集計され、その顧客またはパートナーの合計数量が算出されます。 特定時点:顧客レポートには、顧客ごとのパッケージ割り当て状況が記載されています。各行は、特定の顧客組織内のユーザーまたはワークスペースに割り当てられた特定のパッケージの総数を表します。割り当てられたパッケージがない場合、数量には「0」が表示されます。 ユーザーレポートには、ユーザーまたはワークスペースに割り当てられているパッケージが一覧表示されます。各行には数量「1」が表示されており、これはユーザーまたはワークスペースと、それらに対応する個々のパッケージまたはアドオンを表しています。ユーザーまたはワークスペースに複数のパッケージまたはアドオンが割り当てられている場合、レポートには複数のエントリが表示され、それぞれの数量は1となります。 |
パートナー、顧客、ユーザー |
和解、時点 |
必須 |
|
場所_ID |
固有の位置識別子 |
顧客、ユーザー |
和解、時点 顧客時点レポートにはロケーションIDが含まれていません |
オプション |
|
ライセンス_ID |
ライセンス識別子 このフィールドは卸売パッケージでのみ表示されます 調整レポートの場合、このフィールドが導入される前に割り当てられたライセンスについては、License_ID は空白になります。 請求レポートには、LOCATION_ID と LICENSE_ID の異なる組み合わせに関連付けられている場合、同じ卸売パッケージに対して複数の行が表示されます。 |
顧客、ユーザー |
和解、時点 |
オプション |
オプションの列を選択すると、顧客およびユーザー照合レポートの列の順序が変更されます。以下の順序は、サブスクリプションに卸売SKUのみが含まれているパートナーに適用されます。
ユーザーレベルレポート—パートナー_名、パートナー_組織_ID、サブスクリプション_ID、顧客_グループ_ID、顧客_グループ_名、顧客_組織_ID、顧客_外部_ID、ロケーション__ID 、ライセンス_ID、サブスクライバー[_ID、ユーザー_ID、ワークスペース_[]ID、サービス名、SKU、説明、消費開始__日、消費終了__日、数量
顧客レベルレポート—パートナー_名、パートナー_組織_ID、サブスクリプション_ID、顧客_グループ_ID、顧客_グループ_名、顧客_組織_ID、顧客_外部_ID、ロケーション_ID、ライセンス_ID、サービス_名、SKU、説明_、消費開始_日、消費終了__日、数量
ユーザーにパッケージを割り当てるとWebex Wholesaleの課金が開始され、パッケージの割り当てを削除すると課金が停止します。
顧客組織は、いかなる時点においても、1つの顧客グループにのみ所属できる。現在、組織ごとに複数の顧客グループをサポートする機能は提供されていません。