対象: 新Office365 Office 365 Enterprise, Office 365 Business, Office 365 Education
(この記事は 2014 年 10 月 29 日に Office Blogs に投稿された記事 Client library for Office 365 admin reporting web service now availableの翻訳です。最新情報については、翻訳元の記事をご参照ください。)
今回は、中国・北京で Office ビッグ データ チームのプログラム マネージャーを務める Julien Pierre とソフトウェア エンジニアを務める Toney Sui の記事をご紹介します。
Office 365 を既に導入し、複数の IT サービスの正常性を 1 か所で常に確認できる一元的な監視ソリューション (ヘルプ デスクやレポート ダッシュボードなど) も利用しているお客様に、嬉しいお知らせがあります。このような一元的な監視ソリューションを扱う開発者や独立系ソフトウェア ベンダー (ISV) の皆様には、そのソリューションで OData API を使用して、他の IT サービスと共に Office 365 を監視していただけるようになりました。この Office 365 Reporting Web Service Client Library という新しいクライアント ライブラリは、.NET で提供されており、これによってレポート データを簡単にエクスポートできます。
このライブラリは nuget.org (英語)で入手可能です。
API へのアクセスを簡素化するクライアントライブラリ
開発者は、Office 365 で提供されている REST ベースの API を使用して、OneDrive for Business でのユーザー アクティビティのログや Exchange および Lync 関連のさまざまなレポートなど、テナント管理者向けレポートのデータにアクセスできます。REST API を直接使用するコードを作成して、データをフェッチしたり簡単なクエリを実行したりすることが可能です。ただし、特定のレポートで何十万件にもなる可能性のあるレコードを処理しつつ、適切な URL を作成し、対象のストア上でデータの整合性を維持したい場合などに、完全なデータ セットを適切にフェッチするには、特別なロジックが必要になります。そこで、このクライアント ライブラリを使用すれば、Office 365 レポート Web サービスにアクセスする際、従来の方法で API にアクセスする場合よりもシンプルなコードで実行できます。このライブラリは、.NET でのみ提供されています。
このクライアント ライブラリを利用すると、以下のことを実現できます。
- レポートからのデータをフェッチする
- クエリの対象となる期間を指定する
- データを続けてエクスポートする場合、最後にフェッチしたレコードを記憶する
- 独自のレコードおよびトレース ロガー プロセッサを実装する
例として、メールボックスの使用状況に関する詳細レポートをフェッチするための .NET 向け C# コードを以下にご紹介します。
期間の開始日時と終了日時を指定しない場合、1 回目のクエリでは最も古い上位 1,000 件のレコードがフェッチされ、すべてのデータが 1,000 件ごとに段階的にフェッチされます。
上記のコード サンプルを Visual Studio 2013 で実行した例
クライアント ライブラリでは、API によって取得する各レコードについて VisitReport メソッドが使用されます。このメソッドでは、.csv ファイル、サード パーティ製ビジネス インテリジェンス ソフトウェア、SQL Server データベースに保存するなど、レコードをご要件に応じた方法で処理することが可能です。
Visual Studio 2013 でレコードのプロパティを参照した例
現時点でクライアントライブラリがサポートしているレポート
現時点でサポートされているレポートは、以下のとおりです。
- GroupActivity
- GroupActivityDaily
- GroupActivityMonthly
- GroupActivityWeekly
- GroupActivityYearly
- MailboxActivity
- MailboxActivityDaily
- MailboxActivityMonthly
- MailboxActivityWeekly
- MailboxActivityYearly
- MailboxUsage
- MailboxUsageDetail
- StaleMailbox
- StaleMailboxDetail
管理者が利用できるすべてのレポートの詳細については、「Office 365 レポート Web サービス」を参照してください。
注:ご利用いただいている Office 365 サブスクリプションによっては、上記のうち一部のレポートが含まれていない場合があります。サブスクリプションで提供されているレポートを確認するには、Office 365 管理センターでOffice 365 のレポート セクションを確認してください。
お問い合わせ先
ご不明な点については、StackOverflow (英語)で [O365RwsClient] のタグを付けてお問い合わせください。
Yammer の Office 365 テクニカル ネットワーク (英語)でも Office 365 チームに問い合わせることができます。
このライブラリに関する貴重なご意見、ご感想 (英語)をお待ちしております。
—Julien Pierre