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 و مرجع پارامترهای گزارش استفاده مشتری مراجعه کنید.
مثال زیر گزارشی با مجموع همه ورودهای موفقیت آمیز به حساب شما در 30 روز گذشته و لیستی از برنامه های کاربردی مجاز، با تعداد مجوزهای کاربر در هر برنامه، از 03/03/2013 دریافت می کند. رشته پرس و جو maxResults نشان می دهد که این گزارش دو رویداد را در هر صفحه گزارش برمی گرداند:
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
},
...
]
}
]
}
]
}
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Reports API: Customers Usage Report\n\nThe Customers usage report\naggregates Google Workspace service usage information, for all users, across an entire domain.\nThe user usage report returns Google Workspace service usage information across your account.\nThis usage information is organized by application type which is composed of parameters specific to that application.\nThe default and maximum time period for each report is the last 450 days.\n\nThese usage report may be used only for lawful purposes in accordance with your Customer Agreement. Also, these\nreports apply to Google Workspace and Education.\n\nRetrieve a customer usage report\n--------------------------------\n\nTo retrieve report of your account activities use the following `GET` HTTP request and include the authorization token\ndescribed in the [authorization documentation](/workspace/admin/reports/v1/guides/authorizing). For readability,\nthe following example is formatted with line returns: \n\n```\nGET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date\n?parameters=app name: usage parameter,...\n&customerId=the customer's ID\n&maxResults=number of events listed on each page of the report\n```\n\nThe `dates` value is the date the usage occurred and the timestamp is in the [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601), yyyy-mm-dd. We recommend you use your account's time zone for this. For more information about the request's query strings and response properties, see the [API Reference](/workspace/admin/reports/v1/reference/customerUsageReports/get) and the [customer usage report parameters reference](/workspace/admin/reports/v1/reference/usage-ref-appendix-a/customers).\n\nThe following example gets a report with the total of all successful logins to your account in the past 30 days and a list\nof authorized applications, with the number of user authorizations per application, starting 2013-03-03. The `maxResults`\nquery string shows this report returns two events per report page: \n\n```\nGET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03\n?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2\n```\n\n#### JSON response for customer usage report\n\n```carbon\n{\n \"kind\": \"reports#usageReports\",\n \"warnings\": [\n {\n \"code\": warning machine-readable code,\n \"message\": warning human-readable message,\n \"data\": [\n {\n \"key\": key for key-value pair that gives detailed warning information,\n \"value\": value for key-value pair giving detailed warning information\n }\n ]\n }\n ],\n \"nextPageToken\": \"N:NNN:NNN:N:C03az79cb\",\n \"usageReports\": [\n {\n \"kind\": \"usageReport\",\n \"date\": \"2013-03-03\",\n \"entity\": {\n \"type\": \"CUSTOMER\",\n \"customerId\": \"C03az79cb\"\n },\n \"parameters\": [\n {\n \"name\": \"accounts:num_1day_logins\",\n \"intValue\": \"1\"\n },\n {\n \"name\": \"accounts:num_30day_logins\",\n \"intValue\": \"1\"\n },\n {\n \"name\": \"accounts:num_7day_logins\",\n \"intValue\": \"1\"\n },\n {\n \"name\": \"accounts:num_disabled_accounts\",\n \"intValue\": \"5\"\n },\n {\n \"name\": \"accounts:authorized_apps\",\n \"msgValue\": [\n {\n \"client_id\": \"1234.apps.googleusercontent.com\",\n \"client_name\": \"www.example.com\",\n \"num_users\": 2\n },\n {\n \"client_id\": \"4567.apps.googleusercontent.com\",\n \"client_name\": \"Example\",\n \"num_users\": 1\n },\n ...\n ]\n }\n ]\n }\n ]\n}\n```"]]
