Method: stats.getIndex
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
آمار اقلام نمایه شده را در همه منابع داده جمع آوری می کند. این API فقط آمار تاریخ های قبلی را برمی گرداند. آمار روز جاری را بر نمی گرداند.
توجه: این API برای اجرا به یک حساب کاربری نهایی استاندارد نیاز دارد.
درخواست HTTP
GET https://cloudsearch.googleapis.com/v1/stats/index
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
fromDate | object ( Date ) شروع محدوده تاریخ برای بازیابی آمار. این مقدار باید در عرض 1 سال از تاریخ جاری باشد. |
toDate | object ( Date ) پایان محدوده تاریخ برای بازیابی آمار. این مقدار باید در عرض 1 سال از تاریخ جاری و بیشتر از fromDate باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"stats": [
{
object (CustomerIndexStats)
}
],
"averageIndexedItemCount": string
} |
| فیلدها |
|---|
stats[] | object ( CustomerIndexStats ) خلاصه تعداد آیتم های نمایه شده، یکی برای هر روز در محدوده درخواستی. |
averageIndexedItemCount | string ( int64 format) میانگین تعداد اقلام برای محدوده تاریخی معینی که صورت‌حساب برای آن انجام شده است. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/cloud_search.stats.indexing -
https://www.googleapis.com/auth/cloud_search.stats -
https://www.googleapis.com/auth/cloud_search
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
CustomerIndexStats
تجمیع اقلام توسط کد وضعیت در تاریخ مشخص شده.
| فیلدها |
|---|
date | object ( Date ) تاریخی که آمار برای آن محاسبه شد. |
itemCountByStatus[] | object ( ItemCountByStatus ) تعداد موارد تجمیع شده بر اساس کد وضعیت. |
،
آمار اقلام نمایه شده را در همه منابع داده جمع آوری می کند. این API فقط آمار تاریخ های قبلی را برمی گرداند. آمار روز جاری را بر نمی گرداند.
توجه: این API برای اجرا به یک حساب کاربری نهایی استاندارد نیاز دارد.
درخواست HTTP
GET https://cloudsearch.googleapis.com/v1/stats/index
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
fromDate | object ( Date ) شروع محدوده تاریخ برای بازیابی آمار. این مقدار باید در عرض 1 سال از تاریخ جاری باشد. |
toDate | object ( Date ) پایان محدوده تاریخ برای بازیابی آمار. این مقدار باید در عرض 1 سال از تاریخ جاری و بیشتر از fromDate باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"stats": [
{
object (CustomerIndexStats)
}
],
"averageIndexedItemCount": string
} |
| فیلدها |
|---|
stats[] | object ( CustomerIndexStats ) خلاصه تعداد آیتم های نمایه شده، یکی برای هر روز در محدوده درخواستی. |
averageIndexedItemCount | string ( int64 format) میانگین تعداد اقلام برای محدوده تاریخی معینی که صورت‌حساب برای آن انجام شده است. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/cloud_search.stats.indexing -
https://www.googleapis.com/auth/cloud_search.stats -
https://www.googleapis.com/auth/cloud_search
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
CustomerIndexStats
تجمیع اقلام توسط کد وضعیت در تاریخ مشخص شده.
| فیلدها |
|---|
date | object ( Date ) تاریخی که آمار برای آن محاسبه شد. |
itemCountByStatus[] | object ( ItemCountByStatus ) تعداد موارد تجمیع شده بر اساس کد وضعیت. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: stats.getIndex\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.GetCustomerIndexStatsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [CustomerIndexStats](#CustomerIndexStats)\n - [JSON representation](#CustomerIndexStats.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nGets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day.\n\n**Note:** This API requires a standard end user account to execute.\n\n### HTTP request\n\n`GET https://cloudsearch.googleapis.com/v1/stats/index`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `fromDate` | `object (`[Date](/workspace/cloud-search/docs/reference/rest/v1/Date)`)` Start of the date range to retrieve statistics for. This value must be within 1 year of the current date. |\n| `toDate` | `object (`[Date](/workspace/cloud-search/docs/reference/rest/v1/Date)`)` End of the date range to retrieve statistics for. This value must be within 1 year of the current date and greater than fromDate. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"stats\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/stats/getIndex#CustomerIndexStats) } ], \"averageIndexedItemCount\": string } ``` |\n\n| Fields ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `stats[]` | `object (`[CustomerIndexStats](/workspace/cloud-search/docs/reference/rest/v1/stats/getIndex#CustomerIndexStats)`)` Summary of indexed item counts, one for each day in the requested range. |\n| `averageIndexedItemCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Average item count for the given date range for which billing is done. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.stats.indexing`\n- `https://www.googleapis.com/auth/cloud_search.stats`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nCustomerIndexStats\n------------------\n\nAggregation of items by status code as of the specified date.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"date\": { object (/workspace/cloud-search/docs/reference/rest/v1/Date) }, \"itemCountByStatus\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/stats.index.datasources#ItemCountByStatus) } ] } ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `date` | `object (`[Date](/workspace/cloud-search/docs/reference/rest/v1/Date)`)` The date for which statistics were calculated. |\n| `itemCountByStatus[]` | `object (`[ItemCountByStatus](/workspace/cloud-search/docs/reference/rest/v1/stats.index.datasources#ItemCountByStatus)`)` Number of items aggregrated by status code. |"]]
