Method: stats.getIndex
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Récupère les statistiques sur les éléments indexés agrégées pour toutes les sources de données. Cette API ne renvoie que des statistiques pour les dates précédentes. Elle ne renvoie pas de statistiques pour le jour en cours.
Remarque:Pour s'exécuter, cette API nécessite un compte utilisateur final standard.
Requête HTTP
GET https://cloudsearch.googleapis.com/v1/stats/index
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
Paramètres |
fromDate |
object (Date )
Début de la plage de dates pour laquelle vous souhaitez récupérer des statistiques. Cette valeur doit être comprise dans un délai d'un an à compter de la date actuelle.
|
toDate |
object (Date )
Fin de la plage de dates pour laquelle vous souhaitez récupérer des statistiques. Cette valeur doit être comprise dans un délai d'un an à compter de la date actuelle et être supérieure à "fromDate".
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :
Représentation JSON |
{
"stats": [
{
object (CustomerIndexStats )
}
],
"averageIndexedItemCount": string
} |
Champs |
stats[] |
object (CustomerIndexStats )
Récapitulatif du nombre d'articles indexés, un pour chaque jour de la période demandée.
|
averageIndexedItemCount |
string (int64 format)
Nombre moyen d'articles pour la période de facturation donnée.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/cloud_search.stats.indexing
https://www.googleapis.com/auth/cloud_search.stats
https://www.googleapis.com/auth/cloud_search
Pour en savoir plus, consultez le guide d'autorisation.
CustomerIndexStats
Agrégation des éléments par code d'état à la date spécifiée.
Représentation JSON |
{
"date": {
object (Date )
},
"itemCountByStatus": [
{
object (ItemCountByStatus )
}
]
} |
Champs |
date |
object (Date )
Date à laquelle les statistiques ont été calculées.
|
itemCountByStatus[] |
object (ItemCountByStatus )
Nombre d'articles regroupés par code d'état.
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]