Method: projects.getMetrics

Dapatkan data metrik untuk skrip, seperti jumlah eksekusi dan pengguna aktif.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
scriptId

string

Kolom wajib diisi yang menunjukkan skrip yang metriknya akan didapatkan.

Parameter kueri

Parameter
metricsGranularity

enum (MetricsGranularity)

Kolom wajib diisi yang menunjukkan perincian metrik yang ditampilkan.

metricsFilter

object (MetricsFilter)

Kolom opsional yang berisi filter untuk diterapkan pada permintaan. Tindakan ini akan membatasi cakupan metrik yang ditampilkan ke metrik yang ditentukan dalam filter.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Resource yang berisi statistik penggunaan untuk skrip tertentu, berdasarkan filter dan mask yang disediakan dalam permintaan.

Representasi JSON
{
  "activeUsers": [
    {
      object (MetricsValue)
    }
  ],
  "totalExecutions": [
    {
      object (MetricsValue)
    }
  ],
  "failedExecutions": [
    {
      object (MetricsValue)
    }
  ]
}
Kolom
activeUsers[]

object (MetricsValue)

Jumlah pengguna aktif.

totalExecutions[]

object (MetricsValue)

Jumlah total eksekusi.

failedExecutions[]

object (MetricsValue)

Jumlah eksekusi yang gagal.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/script.metrics

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

MetricsGranularity

Perincian metrik yang datanya akan ditampilkan.

Enum
UNSPECIFIED_GRANULARITY Perincian metrik default yang digunakan untuk tidak mengkueri metrik apa pun.
WEEKLY Mewakili metrik mingguan.
DAILY Menggambarkan metrik harian selama periode 7 hari.

MetricsFilter

Filter yang digunakan untuk mengurangi cakupan permintaan.

Representasi JSON
{
  "deploymentId": string
}
Kolom
deploymentId

string

Kolom opsional yang menunjukkan deployment tertentu untuk mengambil metrik.

MetricsValue

Nilai metrik yang menyimpan jumlah eksekusi yang dihitung.

Representasi JSON
{
  "value": string,
  "startTime": string,
  "endTime": string
}
Kolom
value

string

Menunjukkan jumlah eksekusi yang dihitung.

startTime

string (Timestamp format)

Kolom wajib diisi yang menunjukkan waktu mulai interval.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Kolom wajib diisi yang menunjukkan waktu berakhir interval.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".