ジェネシスクラウド
拡張されたデータアクセスとページネーションを備えた新しい使用状況クエリサービスの近日リリース
| 発表日 | 発効日 | Aha! アイデア |
|---|---|---|
| 2025-04-21 | - | - |
Genesys Cloud は、既存の public-api-usage-query-service に代わる新しい usage-query-service を導入し、顧客が使用状況データにアクセスして操作する方法を改善しました。2025 年 3 月 31 日より、この新しいサービスを使用して、公開 API の使用だけでなく、より広範なデータセットに対して非同期クエリを実行できるようになります。新しいサービスは、完全なページ区切りとページ サイズ制御をサポートします。
この変更はなぜ重要なのでしょうか?
この変更の目的は、顧客がプラットフォームの使用状況にアクセスし、よりよく把握できるようにし、将来的にはパブリック API の使用を超えて他のデータセットへの拡張をサポートすることです。以前は、パブリック API 使用エンドポイントでは、一部のシステム レベルの組織 ID を除外するなどの厳密なフィルターが適用され、ページ区切りがありませんでした。
新しいサービスにより、お客様は次のことが可能になります。
- クライアント ID、プラットフォーム、ユーザー ID、HTTP メソッドなどによる高度なフィルターを含め、クエリをより細かく制御できます。
- 以前は非表示だった完全なデータにアクセスします (たとえば、purecloud や purecloud-builtin などの OAuth クライアントが含まれるようになりました)。
- 非同期クエリ ジョブを使用して、データをより高速かつ確実に受信します。
- 結果をページ分けすることで、大規模な結果セットの制限を回避し、出力サイズを管理する機能を獲得します。
制限
このサービスによって提供されるデータには、課金対象データだけでなく、すべての使用アクティビティが含まれます。顧客は課金を決定するためにこの API を使用しないでください。サービスでは、何が課金対象で何が課金対象外かは定義されません。
利用可能な新しいエンドポイント
- POST /api/v2/usage/aggregates/query/jobs
- GET /api/v2/usage/aggregates/query/jobs/{jobId}
- POST /api/v2/usage/client/{clientId}/aggregates/query/jobs
- GET /api/v2/usage/client/{clientId}/aggregates/query/jobs/{jobId}
廃止予定のエンドポイント
- さまざまな api/v2/usage/query および api/v2/oauth/clients/{clientId}/usage エンドポイント
移行の詳細
お客様には、使用状況データの完全かつカスタマイズ可能なビューを実現するために、新しいエンドポイントに移行することをお勧めします。
