Method: stats.getIndex
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
אחזור נתונים סטטיסטיים של פריטים שנוספו לאינדקס, שמצטברים מכל מקורות הנתונים. ה-API הזה מחזיר נתונים סטטיסטיים רק לגבי תאריכים קודמים, ולא לגבי היום הנוכחי.
הערה: כדי להפעיל את ה-API הזה, נדרש חשבון משתמש קצה רגיל.
בקשת HTTP
GET https://cloudsearch.googleapis.com/v1/stats/index
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של שאילתה
פרמטרים |
fromDate |
object (Date )
תאריך ההתחלה של טווח התאריכים שבו רוצים לאחזר נתונים סטטיסטיים. הערך צריך להיות בטווח של שנה מהתאריך הנוכחי.
|
toDate |
object (Date )
תאריך הסיום של טווח התאריכים שבו רוצים לאחזר נתונים סטטיסטיים. הערך הזה חייב להיות בטווח של שנה מהתאריך הנוכחי, וגדול מערך 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 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],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. |"]]