Method: stats.getIndex
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recebe estatísticas de itens indexados agregadas em todas as fontes de dados. Essa API só retorna estatísticas de datas anteriores, não do dia atual.
Observação:essa API exige uma conta de usuário final padrão para ser executada.
Solicitação HTTP
GET https://cloudsearch.googleapis.com/v1/stats/index
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
Parâmetros |
fromDate |
object (Date )
Início do período para recuperar estatísticas. Esse valor precisa estar dentro de um ano da data atual.
|
toDate |
object (Date )
Fim do período para extrair estatísticas. Esse valor precisa estar dentro de um ano da data atual e ser maior que "fromDate".
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:
Representação JSON |
{
"stats": [
{
object (CustomerIndexStats )
}
],
"averageIndexedItemCount": string
} |
Campos |
stats[] |
object (CustomerIndexStats )
Resumo das contagens de itens indexados, uma para cada dia no intervalo solicitado.
|
averageIndexedItemCount |
string (int64 format)
Contagem média de itens para o período em que o faturamento foi feito.
|
Escopos de autorização
Requer um dos seguintes escopos do 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
Para mais informações, consulte o guia de autorização.
CustomerIndexStats
Agregação de itens por código de status a partir da data especificada.
Representação JSON |
{
"date": {
object (Date )
},
"itemCountByStatus": [
{
object (ItemCountByStatus )
}
]
} |
Campos |
date |
object (Date )
A data em que as estatísticas foram calculadas.
|
itemCountByStatus[] |
object (ItemCountByStatus )
Número de itens agregados por código de status.
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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. |"]]