第32章 組み込み機能を超える 3scale API 分析値のエクスポート

デフォルトの機能では提供されない情報を取得できるように、組み込まれた 3scale 分析の機能を拡張するスクリプトを作成します。

Account Management API および Analytics API を使用すると (Enterprise のみ)、必要な情報を希望の形式で取得するスクリプトを作成することができます。本項のユースケースを使用して、必要なデータを 3scale から取得する独自のシナリオに役立てることができます。

カスタムスクリプトが重要な理由

3scale では、API Dashboard で利用可能な機能を継続的に改善しています。しかし、お客様が当社の開発プランに先立ち、まだサポートされていない非常に特殊な機能を必要とする場合があります。

API 管理のニーズを満たすために、3scale 管理ポータルはすべてのデータにアクセスするのに必要なツールを提供します。スクリプトの作成にはリソースが必要ですが、カスタマイズしたスクリプトでは、さまざまなユースケースを実装するための完全な柔軟性と制御性が得られます。

32.1. 3scale を使用してアプリケーションの使用状況に関するデータを抽出する例

あるお客様は、毎週、数千人もの新規開発者を受け入れていました。3scale では必要な作業 (キーのプロビジョニング、サインアップワークフロー、電子メールによる連絡など) が自動化されているため、このお客様は受け入れプロセスにある程度対応することができていました。しかし、お客様にとって非常に重要だが、3scale では実施できないことがありました。

お客様は多数の開発者を受け入れていたため、運用およびマーケティングチームが新規開発者とより効果的に交流できるように、API の使用状況に応じて新規開発者を分類するためのシンプルな手段が必要でした。このような機能は、少なくとも求められるレベルの詳細さでは、3scale で提供される組み込み解析ツールではまだ利用することができませんでした。しかし、すべてのデータにはシステムからアクセスすることができたので、3scale の Account API および Analytics API を使用してそのデータを抽出することができました。

例: お客様の要求

お客様は、過去 10 日間に無料の評価版プランにサインアップした新規開発者の数を知り、それをいくつかのグループに分けたいと考えました。

まず、サインアップはしたがお客様の API を全く使用しなかった開発者の数を知りたいと考えました。

次に、API を使用した開発者を以下の 2 つのグループに分けたいと考えました。

  • ある期間 (10 日間のうち初めの 5 日間など) API を使用した後、使用を止めた開発者。これらの開発者は、使ってはみたがアクティブではなくなったグループです。
  • API を継続的に使用している開発者。このグループについては、使用率の増加 (または減少) を知りたいと考えました。

この情報は、3scale の組み込み解析機能で利用可能です。問題は、集約データとして表示するビューがないことで、これは非常に面倒な状況です。