CsActiveUser* レポート
CsActiveUser* REST URI は、レポート期間中の Office 365 Lync Online アクティブ ユーザーの数に関するサマリー統計を提供します。各ユーザーは、カウントされるために、ログオンしてレポート期間中にピアツーピアまたは会議のリソースを使用している必要があります。使用する全体的な構造が同じで、データを要約する時間間隔 (毎日、毎週、毎月、毎年) だけが異なる 4 つのレポートがあります。簡略化のために、それら 4 つのレポートの詳細がこの 1 つのトピックで示されます。
最終更新日: 2015年9月17日
適用対象: Office 365
REST URI
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsActiveUserDaily[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsActiveUserWeekly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsActiveUserMonthly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsActiveUserYearly[?ODATA options]
フィールド
以下のフィールドを、$select、$filter および $orderby ODATA2 クエリ オプションで指定できます。$select オプションが指定されない場合、すべてのフィールドが返されます。
名前 |
WCF 型* |
EDM 型* |
[入力/出力]** 説明 |
値の例 |
提供されたバージョン |
---|---|---|---|---|---|
ActiveUsers |
長整数型 |
Edm.Int64 |
[入力/出力] レポート期間中にアクティブなユーザーの数です。 各ユーザーは、カウントされるために、Lync Online にログオンしてレポート期間中にオーディオまたはビデオのリソースを使用している必要があります。 |
1042 |
2013-V1 |
Date |
System.DateTime |
Edm.DateTime |
[入力/出力] レポート期間の終了日時。 レポート期間の詳細については次のセクションを参照してください。 |
短い形式の日付 (たとえば、03/10/2013) または引用符付きの 日付/時刻 (たとえば、"03/10/2013 4:55 PM") |
2013-V1 |
ID |
長整数型 |
Edm.Int64 |
[入力/出力] レポート レコードのインデックス番号。 |
72 |
2013-V1 |
TenantGuid |
System.guid |
Edm.Guid |
[入力/出力] 組織の GUID。 |
16a58f78-539f-47f7-b9bf-02a63867d73b |
2013-V1 |
TenantName |
文字列 |
Edm.String |
[入力/出力] 組織名。 |
example.onmicrosoft.com |
2013-V1 |
*WCF 型は、Visual Studio に Windows Communications Framework (WCF) Service Reference を作成する場合にフィールドに割り当てられる .NET Framework データ型を参照します。EDM 型は、Atom 形式のレポートで返される ADO.NET エンティティ データ モデル (EDM) 型を参照します。
**[入力/出力]: 詳しくは、「入力パラメーターとレポート出力列」のセクションを参照してください。
解説
組織のユーザーがアクティブなユーザー数としてレポートに含められるためには、 Lync クライアントを実行しているコンピューターから、Office 365 組織ユーザー アカウントにログオンしたセッションまたは会議に参加する必要があります。同様に、「ゲスト」 参加者は、レポートのデータには含まれません。
レポートには、会議の参加者のうち電話やタブレットなどのモバイル デバイスを使用した参加者は含まれません。このため、会議のすべての参加者がモバイル デバイスを使用していた場合、その会議はレポートに表示されません。
返される会議の時間には、組織のユーザーが開催する会議に費やされた時間だけが含まれます。 会議を開催できなくても会議に参加することは可能な、さまざまな Lync Online プランがあるため、特定のテナント内で開催される会議の数が常にゼロを返す場合があります。
レポート内の各エントリにはメタデータの複数のフィールドが含まれます。詳しくは、「Office 365 レポート Web サービスが返す一般的なメタデータ」を参照してください。
4 種類のレポートは、レポートの各エントリがカバーする時間だけが異なります。日付フィールドで報告される時間は時間間隔の終了時間を表します。日付と時刻は、HTTPS GET X-timezone ヘッダで指定されたタイム ゾーンで報告されます。タイム ゾーンが指定されていない場合は、UTC 時間が使用されます。報告される時間間隔は以下に示す方法で計算されます。
レポート名 |
期間の計算方法 |
---|---|
毎日 (CsActiveUserDaily) |
報告する日は正確に午前 0 時 (00:00) に始まり、その同じ日の夜 12 時直前 (23.59:59.9999...) に終了します。報告される最後の日は、データが利用可能な最後の丸 1 日で、当日を含みません。Date フィールドに返される日時は、その日のレポートの最後の時刻を表します。 |
毎週 (CsActiveUserWeekly) |
報告する週は、正確に日曜日の午前 0 時 (00:00:00) に始まり、次の土曜日の夜 12 時前 (23:59:59.9999...) に終わります。直近に報告されるエントリは当日を含むエントリなので、通常、レポートを要求した時点より後まで続きます。Date フィールドに返される日時は、その週のレポートの最後の時刻を表します。 |
毎月 (CsActiveUserMonthly) |
報告する月は、正確にその月の最初の日の午前 0 時 (00:00:00) に始まり、その月の最後の日の夜 12 時前 (23:59:59.9999...) に終わります。直近に報告されるエントリは当日を含むエントリなので、通常、レポートを要求した時点より後まで続きます。Date フィールドに返される日時は、その月のレポートの最後の時刻を表します。 |
年間 (CsActiveUserYearly) |
報告する年は、正確にそのカレンダー年度の 1 月 1 日の午前 0 時 (00:00:00) に始まり、その同じカレンダー年度の 12 月 31 日の夜 12 時前 (23:59:59.9999...) に終わります。直近に報告されるエントリは当日を含むエントリなので、通常、レポートを要求した時点より後まで続きます。Date フィールドに返される日時は、その月のレポートの最後の時刻を表します。 |
例
以下に示す要求と応答のペアは、週ごとのアクティブな Lync ユーザー数を一覧で示すレポートの取得方法を例示しています。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsActiveUserWeekly?
$select=Date,ActiveUsers&
$format=Json
{
"d":
{
"results":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsActiveUserWeekly(datetime'2013-05-05T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsActiveUserWeekly(datetime'2013-05-05T00%3A00%3A00')",
"type":"TenantReporting.CsActiveUserReport"
},
"Date":"\/Date(1367712000000)\/",
"ActiveUsers":"5"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsActiveUserWeekly(datetime'2013-05-12T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsActiveUserWeekly(datetime'2013-05-12T00%3A00%3A00')",
"type":"TenantReporting.CsActiveUserReport"
},
"Date":"\/Date(1368316800000)\/",
"ActiveUsers":"5"
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsActiveUserWeekly(datetime'2013-05-19T00%3A00%3A00')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsActiveUserWeekly(datetime'2013-05-19T00%3A00%3A00')",
"type":"TenantReporting.CsActiveUserReport"
},
"Date":"\/Date(1368921600000)\/",
"ActiveUsers":"3"
}
]
}
}
以下に示す要求と応答のペアは、2013 年 5 月 1 日から 5 月 15 日までの期間について、時間の流れとは逆の方向に、日ごとのアクティブな Lync ユーザー数を取得する方法を例示しています。このクエリは、Date および ActiveUsers の数を要求し、Atom 形式での情報を要求します。要求と応答をわかりやすくするために改行が追加されました。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsActiveUserDaily?
$select=Date,ActiveUsersCount&
$filter=Date%20ge%20datetime'2013-05-01T00:00:00'%20and%20Date%20le%20datetime'2013-05-15T00:00:00'&
$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/CsActiveUserDaily</id>
<title type="text">CsActiveUserDaily</title>
<updated>2013-06-25T19:01:23Z</updated>
<link rel="self" title="CsActiveUserDaily" href="CsActiveUserDaily" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsActiveUserDaily(datetime'2013-05-14T00%3A00%3A00')</id>
<category term="TenantReporting.CsActiveUserReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<title />
<updated>2013-06-25T19:01:23Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-05-14T00:00:00</d:Date>
<d:ActiveUsers m:type="Edm.Int64">5</d:ActiveUsersCount>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsActiveUserDaily(datetime'2013-05-13T00%3A00%3A00')</id>
<category term="TenantReporting.CsActiveUserReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<title />
<updated>2013-06-25T19:01:23Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-05-13T00:00:00</d:Date>
<d:ActiveUsers m:type="Edm.Int64">5</d:ActiveUsersCount>
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsActiveUserDaily(datetime'2013-05-10T00%3A00%3A00')</id>
<category term="TenantReporting.CsActiveUserReport" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<title />
<updated>2013-06-25T19:01:23Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Date m:type="Edm.DateTime">2013-05-10T00:00:00</d:Date>
<d:ActiveUsers m:type="Edm.Int64">5</d:ActiveUsersCount>
</m:properties>
</content>
</entry>
</feed>
入力パラメーターとレポート出力列
フィールド表の [入力/出力] という表記には次の意味があります。
[フィールド] 表で [入力] が付いているフィールドは、主に $filter=、$orderby= およびレポートが返すエントリを制限する他のクエリ オプションで使用するためのものです。[フィールド] 表で [入力] が付いているフィールドは、$select= オプションに含めることができ、レポート エントリに表示されますが、有用なデータは入っていません。
[フィールド] 表で [入力/出力] が付いているフィールドは、列選択 ($select=) およびエントリ制限 ($filter= と $orderby=) オプションの両方で使用できます。これらのフィールドを $select= オプションに含めると、レポート エントリに表示され、利用可能な場合には有用なデータが入っています。
互換性
CsActiveUserDaily、CsActiveUserWeekly、CsActiveUserMonthly、および CsActiveUserYearly の各レポートは、Office 365 サービス バージョン 2013-V1 で導入されました。バージョン管理の詳細については、「Office 365 レポート Web サービスのバージョン管理」を参照してください。
対応する PowerShell コマンドレット
CsActiveUser* レポートは、Get-CsActiveUserReport Windows PowerShell コマンドレットと同じ情報を返します。
権限
レポートにアクセスするアカウントには、その Office 365 組織の管理権限が必要です。レポートがサービス記述文書に含まれており $metadata 文書がユーザーに返される場合、REST Web サービスからデータを取得する権限があります。このレポートでは、ユーザーを参照のみ可受信者の役割に割り当てる必要があります。既定の Office 365 権限構造では、次の管理者権限があるユーザーはこのレポートにアクセスできます: 課金管理者、全体管理者、パスワード管理者、サービス管理者、ユーザー管理の管理者。
データの細分性、永続性、可用性
これらのレポートにより利用できる情報は、HTTP X-timezone ヘッダーの呼び出し元アプリケーションにより報告されているタイムゾーンにおける真夜中から始まる日単位で分けることができます。
このレポートの情報は、1 年間またはサブスクリプションをキャンセルするまで利用可能です。
イベントがレポートに表示されるまで、最大で 24 時間遅れる場合があります。