Reports API: お客様の使用状況レポート

顧客使用状況レポートには、ドメイン全体における、すべてのユーザーの Google Workspace サービスの使用状況の情報が集約されています。 ユーザーの使用状況レポートには、アカウント全体の Google Workspace サービスの使用状況に関する情報が表示されます。この使用状況情報は、アプリケーションの種類別に整理され、アプリケーション固有のパラメータで構成されています。各レポートのデフォルト期間と最大期間は過去 450 日間です。

使用状況レポートは、顧客契約に基づく法的な目的でのみ使用することができます。また、このレポートは Google Workspace と Education にも適用されます。

お客様の利用状況レポートを取得する

アカウント アクティビティ レポートを取得するには、次の GET HTTP リクエストを使用し、承認ドキュメントに記載されている認証トークンを含めます。読みやすくするために、次の例では改行を返します。

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&maxResults=number of events listed on each page of the report

dates 値は使用量の日付で、タイムスタンプは ISO 8601 形式(yyyy-mm-dd)です。アカウントのタイムゾーンを使用することをおすすめします。リクエストのクエリ文字列とレスポンスのプロパティの詳細については、API リファレンス顧客使用状況レポートのパラメータのリファレンスをご覧ください。

次の例は、2013 年 3 月 3 日以降に過去 30 日間にアカウントに正常にログインされたすべてのログイン数と、承認済みアプリケーションのリスト(アプリケーションごとのユーザー認証数を含む)を取得します。maxResults クエリ文字列は、このレポートがレポートページごとに 2 つのイベントを返すことを示しています。

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

顧客使用状況レポートの 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": "CUSTOMER",
    "customerId": "C03az79cb"
   },
   "parameters": [
    {
     "name": "accounts:num_1day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_30day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_7day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_disabled_accounts",
     "intValue": "5"
    },
    {
     "name": "accounts:authorized_apps",
     "msgValue": [
      {
       "client_id": "1234.apps.googleusercontent.com",
       "client_name": "www.example.com",
       "num_users": 2
      },
      {
       "client_id": "4567.apps.googleusercontent.com",
       "client_name": "Example",
       "num_users": 1
      },
     ...
     ]
    }
   ]
  }
 ]
}