Method: projects.getMetrics

実行数やアクティブ ユーザー数など、スクリプトの指標データを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

指標の取得元となる特定の Deployment を示すオプション フィールド。

MetricsValue

カウントされた実行数を保持する指標値。

JSON 表現 
{
  "value": string,
  "startTime": string,
  "endTime": string
}
フィールド
value

string

カウントされた実行の数を示します。
startTime

string (Timestamp format)

期間の開始時刻を示す必須フィールド。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

期間の終了時間を示す必須フィールド。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。