ConnectionbyClientType* レポート
ConnectionbyClientType* REST URI は、使用されたクライアント アプリケーションの種類別に整理された、確立された Office 365 Exchange Online 接続に関する概要統計情報を提供します。全体構造は同じで、データの集計間隔 (日次、週次、月次、および年次) のみが異なる 4 つのレポートがあります。簡単にするために、4 つのレポートの詳細をまとめて説明します。
最終更新日: 2015年9月17日
適用対象: Office 365
REST URI
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeDaily[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeWeekly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeMonthly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeYearly[?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 |
ClientType |
string |
Edm.String |
[入力/出力] Exchange Online にアクセスするために使用するクライアント アプリケーションの種類。 |
Lync 2013 |
2013-V1 |
Count |
long |
Edm.Int64 |
[入力/出力] クライアントの種類ごとの、レポート期間中に行われた接続の数。 |
72 |
2013-V1 |
TenantGuid |
System.guid |
Edm.Guid |
[入力/出力] 組織の GUID。 |
16a58f78-539f-47f7-b9bf-02a63867d73b |
2013-V1 |
TenantName |
string |
Edm.String |
[入力/出力] 組織のプライマリ ドメイン名。 |
example.onmicrosoft.com |
2013-V1 |
*WCF 型は、Visual Studio で Windows Communications Framework (WCF) サービス参照が作成されたときにフィールドに割り当てられる .NET Framework データ型を参照します。EDM 型は、Atom 形式のレポートで返される ADO.NET エンティティ データ モデル (EDM) 型を参照します。
**[入力/出力]: 詳しくは、「入力パラメーターとレポート出力列」のセクションを参照してください。
解説
レポート内の各エントリにはメタデータの複数のフィールドが含まれます。詳しくは、「Office 365 レポート Web サービスが返す一般的なメタデータ」を参照してください。
4 種類のレポートは、各レポートのエントリに対応する時間の長さだけが異なります。日付フィールドで報告される時刻は時間間隔の終了時間を表します。日付と時刻は、HTTPS GET X-timezone ヘッダで指定されたタイム ゾーンで報告されます。タイム ゾーンが指定されていない場合は、UTC 時間が使用されます。報告される時間間隔は以下に示す方法で計算されます。
レポート名 |
期間の計算方法 |
---|---|
日次 (ConnectionbyClientTypeDaily) |
レポート日は、正確に午前 0 時 (00:00) に始まり、その同じ日の夜 12 時直前 (23.59:59.9999...) に終了します。報告される最後の日は、データが利用可能な最後の丸 1 日で、当日を含みません。Date フィールドに返される日時は、そのレポート日の終わりを表します。 |
週次 (ConnectionbyClientTypeWeekly) |
レポート週は、正確に土曜日の午前 0 時 (00:00:00) に始まり、次の金曜日の夜 12 時直前 (23:59:59.9999...) に終わります。直近に報告されるエントリは当日を含むエントリなので、通常、レポートを要求した時点より後まで続きます。Date フィールドに返される日時は、そのレポート週の終わりを表します。 |
月次 (ConnectionbyClientTypeMonthly) |
レポート月は、正確にその月の最初の日の午前 0 時 (00:00:00) に始まり、その月の最後の日の夜 12 時前 (23:59:59.9999...) に終わります。直近に報告されるエントリは当日を含むエントリなので、通常、レポートを要求した時点より後まで続きます。Date フィールドに返される日時は、そのレポート月の終わりを表します。 |
年次 (ConnectionbyClientTypeYearly) |
レポート年は、正確にその暦年の 1 月 1 日の午前 0 時 (00:00:00) に始まり、その同じ暦年の 12 月 31 日の夜 12 時前 (23:59:59.9999...) に終わります。直近に報告されるエントリは当日を含むエントリなので、通常、レポートを要求した時点より後まで続きます。Date フィールドに返される日時は、そのレポート月の終わりを表します。 |
例
以下の要求と応答のペアは、クライアント タイプ別の月単位の接続数を示すレポートを JSON 形式で取得する方法を示しています。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeMonthly?
$select=Date,ClientType,Count&
$format=Json
{
"d":
{
"results":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"type":"TenantReporting.ConnectionByClientTypeReport"
},
"Date":"\/Date(1375228800000)\/",
"ClientType":"MAPI",
"Count":"0"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"type":"TenantReporting.ConnectionByClientTypeReport"
},
"Date":"\/Date(1375228800000)\/",
"ClientType":"POP3",
"Count":"0"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"type":"TenantReporting.ConnectionByClientTypeReport"
},
"Date":"\/Date(1375228800000)\/",
"ClientType":"IMAP",
"Count":"0"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"type":"TenantReporting.ConnectionByClientTypeReport"
},
"Date":"\/Date(1375228800000)\/",
"ClientType":"EAS",
"Count":"0"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"type":"TenantReporting.ConnectionByClientTypeReport"
},
"Date":"\/Date(1375228800000)\/",
"ClientType":"OWA",
"Count":"0"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
"type":"TenantReporting.ConnectionByClientTypeReport"
},
"Date":"\/Date(1375228800000)\/",
"ClientType":"EWS",
"Count":"0"
}
]
}
}
入力パラメーターとレポート出力列
フィールド表の [入力/出力] という表記には次の意味があります。
フィールド表で [入力] が付いているフィールドは、主に $filter=、$orderby= およびレポートが返すエントリを制限する他のクエリ オプションで使用するためのものです。フィールド表で [入力] が付いているフィールドは、$select= オプションに含めることができ、レポート エントリに表示されますが、有用なデータは入っていません。
フィールド表で [入力/出力] が付いているフィールドは、列選択 ($select=) およびエントリ制限 ($filter= と $orderby=) オプションの両方で使用できます。これらのフィールドを $select= オプションに含めると、レポート エントリに表示され、利用可能な場合には有用なデータが入っています。
互換性
ConnectionbyClientTypeDaily、ConnectionbyClientTypeWeekly、ConnectionbyClientTypeMontly、および ConnectionbyClientTypeYearly レポートが Office 365 サービス バージョン 2013-V1 で導入されました。バージョン管理の詳細については、「Office 365 レポート Web サービスのバージョン管理」を参照してください。
対応する PowerShell コマンドレット
ConnectionbyClientType* レポートは、Get-ConnectionByClientTypeReport Windows PowerShell コマンドレットと同じ情報を返します。
権限
レポートにアクセスするアカウントには、その Office 365 組織の管理権限が必要です。このレポートを Office 365 コントロール パネルで表示できる場合、そのアカウントには REST Web サービスからデータを取得する権限があります。このレポートでは、ユーザーを参照のみ可受信者の役割に割り当てる必要があります。既定の Office 365 権限構造では、次の管理者権限があるユーザーはこのレポートにアクセスできます: 課金管理者、全体管理者、パスワード管理者、サービス管理者、ユーザー管理の管理者。
データの細分性、永続性、可用性
これらのレポートにより利用できる情報は、HTTP X-timezone ヘッダーの呼び出し元アプリケーションにより報告されているタイムゾーンにおける真夜中から始まる日単位で分けることができます。
このレポートの情報は、1 年間またはサブスクリプションをキャンセルするまで利用可能です。
イベントがレポートに表示されるまで、最大で 24 時間遅れる場合があります。