Method: stats.getSession
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Obtenez le nombre de sessions de recherche, le pourcentage de sessions réussies avec des statistiques sur les requêtes de clics pour le client.
Remarque:Pour s'exécuter, cette API nécessite un compte utilisateur final standard.
Requête HTTP
GET https://cloudsearch.googleapis.com/v1/stats/session
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
Paramètres |
fromDate |
object (Date )
Toutes les statistiques disponibles entre la date de début et la date de fin sont renvoyées. La date de début doit être comprise dans l'année et la date de fin doit être supérieure ou égale à la date de début.
|
toDate |
object (Date )
|
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 :
Champs |
stats[] |
object (CustomerSessionStats )
|
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.
CustomerSessionStats
Représentation JSON |
{
"date": {
object (Date )
},
"searchSessionsCount": string
} |
Champs |
date |
object (Date )
Date à laquelle les statistiques sur les sessions ont été calculées. Les statistiques sont calculées le jour suivant, vers minuit (heure du Pacifique), puis renvoyées.
|
searchSessionsCount |
string (int64 format)
Nombre de sessions de recherche le jour même
|
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.getSession\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.GetCustomerSessionStatsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [CustomerSessionStats](#CustomerSessionStats)\n - [JSON representation](#CustomerSessionStats.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nGet the # of search sessions, % of successful sessions with a click query statistics for customer.\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/session`\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)`)` All available stats from fromDate to toDate are returned. fromDate should be within the year and toDate \\\u003e= fromDate. |\n| `toDate` | `object (`[Date](/workspace/cloud-search/docs/reference/rest/v1/Date)`)` |\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/getSession#CustomerSessionStats) } ] } ``` |\n\n| Fields ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------|\n| `stats[]` | `object (`[CustomerSessionStats](/workspace/cloud-search/docs/reference/rest/v1/stats/getSession#CustomerSessionStats)`)` |\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\nCustomerSessionStats\n--------------------\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------|\n| ``` { \"date\": { object (/workspace/cloud-search/docs/reference/rest/v1/Date) }, \"searchSessionsCount\": string } ``` |\n\n| Fields ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `date` | `object (`[Date](/workspace/cloud-search/docs/reference/rest/v1/Date)`)` The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned. |\n| `searchSessionsCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The count of search sessions on the day |"]]