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 世界標準時間「Zulu」的時間戳記格式，解析度不超過奈秒，最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

指定間隔結束時間的必填欄位。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。