Method: projects.getMetrics

获取脚本的指标数据，例如执行次数和活跃用户数。

HTTP 请求

GET https://script.googleapis.com/v1/projects/{scriptId}/metrics

网址采用 gRPC 转码语法。

路径参数

参数
scriptId

string

必填字段，指示要为其获取指标的脚本。

查询参数

参数
metricsGranularity

enum (MetricsGranularity)

必填字段，用于指示所返回指标的粒度。
metricsFilter

object (MetricsFilter)

可选字段，包含要应用于请求的过滤条件。这样就能将返回的指标范围限制为过滤器中指定的指标。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

资源包含给定脚本的使用情况统计信息（基于请求中存在的过滤条件和掩码）。

JSON 表示法 
{
  "activeUsers": [
    {
      object (MetricsValue)
    }
  ],
  "totalExecutions": [
    {
      object (MetricsValue)
    }
  ],
  "failedExecutions": [
    {
      object (MetricsValue)
    }
  ]
}
字段
activeUsers[]

object (MetricsValue)

活跃用户数。
totalExecutions[]

object (MetricsValue)

总执行次数。
failedExecutions[]

object (MetricsValue)

失败的执行次数。

授权范围

需要以下 OAuth 作用域：

  • https://www.googleapis.com/auth/script.metrics

有关详情，请参阅 OAuth 2.0 概览。

MetricsGranularity

要为其返回数据的指标粒度。

枚举
UNSPECIFIED_GRANULARITY 用于查询无指标的默认指标粒度。
WEEKLY 表示每周指标。
DAILY 表示 7 天内的每日指标。

MetricsFilter

用于缩小请求范围的过滤器。

JSON 表示法 
{
  "deploymentId": string
}
字段
deploymentId

string

可选字段，指示要从中检索指标的特定部署。

MetricsValue

包含统计的执行次数的指标值。

JSON 表示法 
{
  "value": string,
  "startTime": string,
  "endTime": string
}
字段
value

string

表示统计的执行次数。
startTime

string (Timestamp format)

表示间隔开始时间的必填字段。

时间戳，采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

表示间隔结束时间的必填字段。

时间戳，采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。