Method: projects.getMetrics | Apps Script | Google for Developers (original) (raw)
- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- MetricsGranularity
- MetricsFilter
- MetricsValue
- Faça um teste
Receba dados de métricas para scripts, como número de execuções e usuários ativos.
Solicitação HTTP
GET https://script.googleapis.com/v1/projects/{scriptId}/metrics
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros | |
|---|---|
| scriptId | string Campo obrigatório que indica o script que vai receber as métricas. |
Parâmetros de consulta
| Parâmetros | |
|---|---|
| metricsGranularity | enum (MetricsGranularity) Campo obrigatório que indica qual granularidade das métricas é retornada. |
| metricsFilter | object (MetricsFilter) Campo opcional que contém filtros a serem aplicados à solicitação. Isso limita o escopo das métricas retornadas ao especificado no filtro. |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Recurso que contém estatísticas de uso de um determinado script, com base no filtro e na máscara fornecidos, presentes na solicitação.
| Representação JSON |
|---|
| { "activeUsers": [ { object (MetricsValue) } ], "totalExecutions": [ { object (MetricsValue) } ], "failedExecutions": [ { object (MetricsValue) } ] } |
| Campos | |
|---|---|
| activeUsers[] | object (MetricsValue) Número de usuários ativos. |
| totalExecutions[] | object (MetricsValue) Número total de execuções. |
| failedExecutions[] | object (MetricsValue) Número de execuções com falha. |
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/script.metrics
Para mais informações, consulte a Visão geral do OAuth 2.0.
MetricsGranularity
A granularidade da métrica para a qual retornar dados.
| Enums | |
|---|---|
| UNSPECIFIED_GRANULARITY | Granularidade de métrica padrão usada para consultar métricas. |
| WEEKLY | Representa métricas semanais. |
| DAILY | Representa as métricas diárias de um período de sete dias. |
MetricsFilter
Filtro usado para reduzir o escopo da solicitação.
| Representação JSON |
|---|
| { "deploymentId": string } |
| Campos | |
|---|---|
| deploymentId | string Campo opcional que indica uma implantação específica para extrair métricas. |
MetricsValue
Valor de métrica que contém o número de execuções contabilizadas.
| Representação JSON |
|---|
| { "value": string, "startTime": string, "endTime": string } |
| Campos | |
|---|---|
| value | string Indica o número de execuções contadas. |
| startTime | string (Timestamp format) Campo obrigatório que indica o horário de início do intervalo.Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z". |
| endTime | string (Timestamp format) Campo obrigatório que indica o horário de término do intervalo.Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z". |