MailboxActivity* レポート
MailboxActivity* REST URI は Office 365 組織メールボックスの作成と削除に関するサマリー統計を提供します。同じ全体構造を持ちながら、データをまとめる期間のみが少しずつ異なる (日次、週次、月次、年次) 4 つのレポートがあります。簡略化のために、これら 4 つのレポートについてこのトピック 1 つで詳しく説明します。.
最終更新日: 2015年9月17日
適用対象: Office 365
REST URI
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityDaily[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityWeekly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityMonthly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityYearly[?ODATA options]
フィールド
以下のフィールドを、$select、$filter および $orderby ODATA2 クエリ オプションで指定できます。$select オプションが指定されない場合、すべてのフィールドが返されます。
名前 |
WCF 型* |
EDM 型* |
[入力/出力]** 説明 |
値の例 |
提供されたバージョン |
---|---|---|---|---|---|
Date |
System.DateTime |
Edm.DateTime |
[入力/出力] レポート期間の終了日時。レポート期間の詳細については下を参照してください。 |
短い形式の日付 (たとえば、 03/10/2013) または引用符付きの日付/時刻 (たとえば、"03/10/2013 4:55 PM") |
2013-V1 |
AccountCreated |
long |
Edm.Int64 |
[入力/出力] その期間中に作成された Office 365 メールボックスの数。 |
265 |
2013-V1 |
AccountDeleted |
long |
Edm.Int64 |
[入力/出力] その期間中に削除された Office 365 メールボックスの数。 |
72 |
2013-V1 |
TenantGuid |
System.guid |
Edm.Guid |
[入力/出力] 組織の GUID。 |
16a58f78-539f-47f7-b9bf-02a63867d73b |
2013-V1 |
TenantName |
string |
指定なし |
[入力/出力] 組織のドメイン名。 |
example.onmicrosoft.com |
2013-V1 |
TotalNumberOfActiveMailboxes |
long |
Edm.Int64 |
[入力/出力] レポート期間中にアクティブだったメールボックスの総計。 |
1242 |
2013-V1 |
*WCF 型は、Visual Studio に Windows Communications Framework (WCF) Service Reference を作成する場合にフィールドに割り当てられる .NET Framework データ型を参照します。EDM 型は、Atom 形式のレポートで返される ADO.NET エンティティ データ モデル (EDM) 型を参照します。
**[入力/出力]: 入力パラメーターとレポート出力列のセクションを参照してください。
解説
レポート内の各エントリにはメタデータの複数のフィールドが含まれます。詳しくは、「Office 365 レポート Web サービスが返す一般的なメタデータ」を参照してください。
4 つの種類のレポートは、各レポートのエントリに対応する時間の長さだけが異なります。日付フィールドで報告される時間は時間間隔の終了時間を表します。日付と時刻は、HTTPS GET X-timezone ヘッダで指定されたタイム ゾーンで報告されます。タイム ゾーンが指定されていない場合、UTC 時間が使用されます。報告される時間間隔は以下に示す方法で計算されます。
レポート名 |
期間の計算方法 |
---|---|
日次 (GroupActivityDaily) |
報告する日は正確に午前 0 時 (00:00) に始まり、その同じ日の夜 12 時直前 (23.59:59.9999...) に終了します。報告される最後の日は、データが利用可能な最後の丸 1 日で、当日を含みません。Date フィールドに返される日時は、その日のレポートの最後の日時を表します。 |
週次 (GroupActivityWeekly) |
報告する週は、正確に土曜日の午前 0 時 (00:00:00) に始まり、次の金曜日の夜 12 時前 (23:59:59.9999...) に終わります。直近に報告されるエントリは当日を含むエントリなので、通常、 レポートを要求した時点より後まで続きます。Date フィールドに返される日時は、その週のレポートの最後の日時を表します。 |
月次 (GroupActivityMonthly) |
報告する月は、正確にその月の最初の日の午前 0 時 (00:00:00) に始まり、その月の最後の日の夜 12 時前 (23:59:59.9999...) に終わります。直近に報告されるエントリは当日を含むエントリなので、通常、レポートを要求した時点より後まで続きます。Date フィールドに返される日時は、その月のレポートの最後の日時を表します。 |
年次 (GroupActivityYearly) |
報告する年は、正確にそのカレンダー年度の 1 月 1 日の午前 0 時 (00:00:00) に始まり、その同じカレンダー年度の 12 月 31 日の夜 12 時前 (23:59:59.9999...) に終わります。直近に報告されるエントリは当日を含むエントリなので、通常、レポートを要求した時点より後まで続きます。Date フィールドに返される日時は、その月のレポートの最後の日時を表します。 |
例
次のリクエストとレスポンスの組は、メールボックスの月ごとのアクティビティ レポートを JSON 形式で取得する方法を示しています。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityMonthly?$format=Json
{
"d":
{
"results":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2012-11-30T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2012-11-30T00%3A00%3A00')",
"type":"TenantReporting.MailboxActivityReport"
},
"TenantGuid":"16a58f78-5e9f-47f7-bebf-02ae3867d73b",
"TenantName":"example.onmicrosoft.com",
"Date":"\/Date(1354233600000)\/",
"TotalNumberOfActiveMailboxes":"0",
"AccountCreated":"0",
"AccountDeleted":"0"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2012-12-31T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2012-12-31T00%3A00%3A00')",
"type":"TenantReporting.MailboxActivityReport"
},
"TenantGuid":"16a58f78-5e9f-47f7-bebf-02ae3867d73b",
"TenantName":"example.onmicrosoft.com",
"Date":"\/Date(1356912000000)\/",
"TotalNumberOfActiveMailboxes":"0",
"AccountCreated":"0",
"AccountDeleted":"0"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2013-01-31T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityMonthly(datetime'2013-01-31T00%3A00%3A00')",
"type":"TenantReporting.MailboxActivityReport"
},
"TenantGuid":"16a58f78-5e9f-47f7-bebf-02ae3867d73b",
"TenantName":"example.onmicrosoft.com",
"Date":"\/Date(1359590400000)\/",
"TotalNumberOfActiveMailboxes":"1",
"AccountCreated":"0",
"AccountDeleted":"0"
}
]
}
}
次のリクエストとレスポンスの組は、過去 4 日間のアクティブなメールボックスの総数を、新しい順に日ごとで取得する方法を示しています。このクエリは Date と TotalNumberOfActiveMailboxes の数をリクエストし、情報を Atom 形式でリクエストしています。分かりやすいようにリクエストとレスポンスには改行が加えてあります。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityDaily?
$select=Date,TotalNumberOfActiveMailboxes&
$top=4&
$orderby=Date%20desc&
$format=Atom
<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/"
xmlns="http://www.w3.org/2005/Atom"
xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices"
xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxActivityDaily</id>
<title type="text">MailboxActivityDaily</title>
<updated>2013-01-31T05:23:09Z</updated>
<link rel="self" title="MailboxActivityDaily" href="MailboxActivityDaily" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityDaily(datetime'2013-01-29T00%3A00%3A00')</id>
<category term="TenantReporting.MailboxActivityReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailboxActivityReport" href="MailboxActivityDaily(datetime'2013-01-29T00%3A00%3A00')" />
<title />
<updated>2013-01-31T05:23:09Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
<d:TotalNumberOfActiveMailboxes m:type="Edm.Int64">0</d:TotalNumberOfActiveMailboxes>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityDaily(datetime'2013-01-28T00%3A00%3A00')</id>
<category term="TenantReporting.MailboxActivityReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailboxActivityReport" href="MailboxActivityDaily(datetime'2013-01-28T00%3A00%3A00')" />
<title />
<updated>2013-01-31T05:23:09Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-28T00:00:00</d:Date>
<d:TotalNumberOfActiveMailboxes m:type="Edm.Int64">0</d:TotalNumberOfActiveMailboxes>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityDaily(datetime'2013-01-27T00%3A00%3A00')</id>
<category term="TenantReporting.MailboxActivityReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailboxActivityReport" href="MailboxActivityDaily(datetime'2013-01-27T00%3A00%3A00')" />
<title />
<updated>2013-01-31T05:23:09Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-27T00:00:00</d:Date>
<d:TotalNumberOfActiveMailboxes m:type="Edm.Int64">0</d:TotalNumberOfActiveMailboxes>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailboxActivityDaily(datetime'2013-01-26T00%3A00%3A00')</id>
<category term="TenantReporting.MailboxActivityReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailboxActivityReport" href="MailboxActivityDaily(datetime'2013-01-26T00%3A00%3A00')" />
<title />
<updated>2013-01-31T05:23:09Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-01-26T00:00:00</d:Date>
<d:TotalNumberOfActiveMailboxes m:type="Edm.Int64">0</d:TotalNumberOfActiveMailboxes>
</m:properties>
</content>
</entry>
</feed>
入力パラメーターとレポート出力列
フィールド表の [入力/出力] という表記には次の意味があります。
フィールド表で [入力] が付いているフィールドは、主に $filter=、$orderby= およびレポートが返すエントリを制限する他のクエリ オプションで使用するためのものです。フィールド表で [入力] が付いているフィールドは、$select= オプションに含めることができ、レポート エントリに表示されますが、有用なデータは入っていません。
フィールド表で [入力/出力] が付いているフィールドは、列選択 ($select=) およびエントリ制限 ($filter= と $orderby=) オプションの両方で使用できます。これらのフィールドを $select= オプションに含めると、レポート エントリに表示され、利用可能な場合には有用なデータが入っています。
互換性
MailboxActivityDaily、MailboxActivityWeekly、MailboxActivityMonthly および MailboxActivityYearly の各レポートは Office 365 サービス バージョン 2013-V1 で導入されました。バージョン管理の詳細は、「Office 365 レポート Web サービスのバージョン管理」をご覧ください。
対応する PowerShell コマンドレット
MailboxActivity* レポートは、Get-MailboxActivityReport Windows PowerShell コマンドレットと同じ情報を返します。
権限
レポートにアクセスするアカウントには、その Office 365 組織の管理権限が必要です。このレポートを Office 365 コントロール パネルで表示できる場合、そのアカウントには REST Web サービスからデータを取得する権限があります。このレポートでは、ユーザーを参照のみ可受信者の役割に割り当てる必要があります。既定の Office 365 権限構造では、次の管理者権限があるユーザーはこのレポートにアクセスできます: 課金管理者、全体管理者、パスワード管理者、サービス管理者、ユーザー管理の管理者。
データの細分性、永続性、可用性
これらのレポートにより利用できる情報は、HTTP X-timezone ヘッダーの呼び出し元アプリケーションにより報告されているタイムゾーンにおける真夜中から始まる日単位で分けることができます。
このレポートの情報は、1 年間またはサブスクリプションをキャンセルするまで利用可能です。
イベントがレポートに表示されるまで、最大で 24 時間遅れる場合があります。