- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- 承認スコープ
- MetricsGranularity
- MetricsFilter
- MetricsValue
- 試してみる
実行回数やアクティブ ユーザー数など、スクリプトの指標データを取得する。
HTTP リクエスト
GET https://script.googleapis.com/v1/projects/{scriptId}/metrics
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
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 日間の 1 日の指標を表します。 |
MetricsFilter
リクエストの範囲を絞り込むために使用するフィルタ。
JSON 表現 |
---|
{ "deploymentId": string } |
フィールド | |
---|---|
deploymentId |
指標を取得する特定のデプロイを示すオプション フィールド。 |
MetricsValue
カウントされた実行回数を保持する指標値。
JSON 表現 |
---|
{ "value": string, "startTime": string, "endTime": string } |
フィールド | |
---|---|
value |
カウントされた実行回数を示します。 |
startTime |
間隔の開始時間を示す必須フィールド。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
endTime |
期間の終了時刻を示す必須フィールド。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |