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 の概要をご覧ください。

指標の粒度

データを返す指標の粒度。

列挙型
UNSPECIFIED_GRANULARITY 指標なしのクエリに使用されるデフォルトの指標の粒度。
WEEKLY 週間指標を表します。
DAILY 7 日間の毎日の指標を表します。

指標フィルタ

リクエストの範囲を絞り込むために使用されるフィルタ。

JSON 表現
{
  "deploymentId": string
}
フィールド
deploymentId

string

指標を取得する特定のデプロイを示すオプション フィールド。

指標値

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

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")。