ユーザー使用状況レポートでは、ドメイン内の特定のユーザーに関する Google Workspace サービスの使用状況に関する情報が返されます。 これらのレポートは、カスタマイズしたり、特定の使用状況の情報でフィルタリングしたりできます。 各レポートのデフォルトおよび最長期間は過去 450 日間です。
ユーザー使用状況レポートは、顧客契約に従い、合法的な目的にのみ使用することがあります。これらのレポートは Google Workspace と Education に適用されます。
すべてのユーザーの使用状況アクティビティを取得する
アカウント内のすべてのユーザー アクティビティのレポートを取得するには、次の GET HTTP リクエストを使用し、認証のドキュメントで説明されている認証トークンを含めます。次の例では、読みやすくするために改行を挿入しています。
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date ?parameters=application: user usage parameter,... &filters=application: user usage parameter relational operator usage parameter's value,... &maxResults=number of events listed on each page of the report
dates 値は使用が発生した日付で、タイムスタンプは ISO 8601 形式（yyyy-mm-dd）です。クエリ文字列パラメータとレスポンス プロパティの詳細については、API リファレンスをご覧ください。ユーザー使用状況レポートのパラメータについては、ユーザー使用状況パラメータのリファレンスをご覧ください。
次の例では、アカウントのすべてのユーザー アクティビティに関するレポートを取得します。
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all /dates/2013-03-03?maxResults=2
次の例では、特定の顧客アカウントのすべてのユーザー アクティビティに関するレポートを取得します。
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all /dates/2013-03-03?customerId=C03az79cb
次の例では、アカウントのユーザーの最終ログイン タイムスタンプに関するレポートを取得します。API レスポンスの例については、JSON レスポンスの例をご覧ください。
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time&maxResults=2
次の例では、アカウント ユーザーの最終ログイン タイムスタンプに関するレポートを取得し、特定の時間以降にログインしたユーザーでフィルタしています。API レスポンスの例については、JSON レスポンスの例をご覧ください。
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time&filters=accounts:last_login_time >2010-10-28T10:26:35.000Z"
次の例では、アカウントのユーザーの最終ログインのタイムスタンプと停止中のステータスに関するレポートを取得しています。API レスポンスの例については、JSON レスポンスの例をご覧ください。
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time,accounts:is_disabled"
特定のユーザーの使用アクティビティを取得する
アカウントでの特定のユーザーのアクティビティに関するレポートを取得するには、次の GET HTTP リクエストを使用し、承認に関するドキュメントで説明されている承認トークンを含めます。次の例では、読みやすくするために改行を挿入しています。
GET https://admin.googleapis.com/admin/reports/v1/usage/users/userKey/dates/yyyy-mm-dd date ?parameters=application: user usage parameter,... &filters=application: user usage parameter relational operator usage parameter's value,... &maxResults=number of events listed on each page of the report
userKey には、レポート内のユーザーのメインのメールアドレスか、ユーザーの一意の Google Workspace profileId のいずれかを指定できます。dates 値は使用が発生した日付で、タイムスタンプは ISO 8601 形式（yyyy-mm-dd）です。クエリ文字列パラメータとレスポンス プロパティの詳細については、API リファレンスをご覧ください。ユーザー使用状況レポートのパラメータについては、ユーザー使用状況パラメータのリファレンスをご覧ください。
次の例では、john@example.com の使用状況レポートを取得します。
https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03
使用状況レポートの JSON レスポンスの例
成功すると、HTTP 200 ステータス コードが返されます。レスポンスでは、ステータス コードとともにレポートが返されます。
ユーザー レポートの JSON レスポンス
{
"kind": "reports#usageReports",
"warnings": [
{
"code": warning machine-readable code,
"message": warning human-readable message,
"data": [
{
"key": key for key-value pair that gives detailed warning information,
"value": value for key-value pair giving detailed warning information
}
]
}
],
"nextPageToken": "N:NNN:NNN:N:C03az79cb",
"usageReports": [
{
"kind": "usageReport",
"date": "2013-03-03",
"entity": {
"type": "USER",
"customerId": "C03az79cb",
"userEmail": "liz@example.com",
"profileId": "user's unique Google Workspace ID"
},
"parameters": [
{
"name": "accounts:is_disabled",
"boolValue": false
},
{
"name": "accounts:disabled_reason",
"stringValue": "reason description"
},
{
"name": "accounts:first_name",
"stringValue": "Liz"
},
{
"name": "accounts:is_2sv_enforced",
"boolValue": false
},
{
"name": "accounts:is_2sv_enrolled",
"boolValue": false
},
{
"name": "accounts:last_name",
"stringValue": "Smith"
},
{
"name": "accounts:creation_time",
"datetimeValue": "2010-10-28T10:26:35.000Z"
},
{
"name": "accounts:last_login_time",
"datetimeValue": "1970-01-01T00:00:00.000Z"
},
{
"name": "accounts:last_sso_time",
"datetimeValue": "1970-01-01T00:00:00.000Z"
}
]
}
]
}