取得指令碼的指標資料,例如執行次數和活躍使用者人數。
HTTP 要求
GET https://script.googleapis.com/v1/projects/{scriptId}/metrics
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
scriptId |
必填欄位,表示要取得指標的指令碼。 |
查詢參數
參數 | |
---|---|
metricsGranularity |
必填欄位,指出傳回的指標精細程度。 |
metricsFilter |
選填欄位,包含要套用至要求的篩選器。這樣就能將傳回的指標範圍限制為篩選器中指定的指標。 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體會含有以下結構的資料:
包含特定指令碼使用統計資料的資源 (依據要求中提供的篩選器和遮罩)。
JSON 表示法 |
---|
{ "activeUsers": [ { object ( |
欄位 | |
---|---|
activeUsers[] |
活躍使用者人數。 |
totalExecutions[] |
總執行作業數。 |
failedExecutions[] |
失敗的執行作業數量。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/script.metrics
詳情請參閱 OAuth 2.0 總覽。
MetricsGranularity
要傳回資料的指標精細程度。
列舉 | |
---|---|
UNSPECIFIED_GRANULARITY |
用於查詢沒有指標的預設指標精細程度。 |
WEEKLY |
代表每週指標。 |
DAILY |
代表過去 7 天內的每日指標。 |
MetricsFilter
用來縮小要求範圍的篩選器。
JSON 表示法 |
---|
{ "deploymentId": string } |
欄位 | |
---|---|
deploymentId |
選填欄位,代表要從中擷取指標的特定部署作業。 |
MetricsValue
顯示執行作業數的指標值。
JSON 表示法 |
---|
{ "value": string, "startTime": string, "endTime": string } |
欄位 | |
---|---|
value |
指出計算的執行作業次數。 |
startTime |
必填欄位,指出間隔的開始時間。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例: |
endTime |
指定間隔結束時間的必填欄位。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例: |