- 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 |
Campo obrigatório que indica o script que vai receber as métricas. |
Parâmetros de consulta
Parâmetros | |
---|---|
metricsGranularity |
Campo obrigatório que indica qual granularidade das métricas é retornada. |
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 ( |
Campos | |
---|---|
activeUsers[] |
Número de usuários ativos. |
totalExecutions[] |
Número total de execuções. |
failedExecutions[] |
Número de execuções com falha. |
Escopos de autorização
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 |
Campo opcional que indica uma implantação específica da qual recuperar 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 |
Indica o número de execuções contadas. |
startTime |
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: |
endTime |
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: |