Method: projects.getMetrics

Nhận dữ liệu chỉ số cho các tập lệnh, chẳng hạn như số lượt thực thi và người dùng đang hoạt động.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Các tham số
scriptId

string

Trường bắt buộc cho biết tập lệnh cần nhận chỉ số.

Tham số truy vấn

Các tham số
metricsGranularity

enum (MetricsGranularity)

Trường bắt buộc cho biết mức độ chi tiết của các chỉ số được trả về.
metricsFilter

object (MetricsFilter)

Trường không bắt buộc chứa các bộ lọc để áp dụng cho yêu cầu. Điều này giới hạn phạm vi của các chỉ số được trả về cho các chỉ số được chỉ định trong bộ lọc.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Tài nguyên chứa số liệu thống kê về việc sử dụng của một tập lệnh nhất định, dựa trên bộ lọc và mặt nạ đã cung cấp trong yêu cầu.

Biểu diễn dưới dạng JSON 
{
  "activeUsers": [
    {
      object (MetricsValue)
    }
  ],
  "totalExecutions": [
    {
      object (MetricsValue)
    }
  ],
  "failedExecutions": [
    {
      object (MetricsValue)
    }
  ]
}
Các trường
activeUsers[]

object (MetricsValue)

Số lượng người dùng đang hoạt động.
totalExecutions[]

object (MetricsValue)

Tổng số lần thực thi.
failedExecutions[]

object (MetricsValue)

Số lần thực thi không thành công.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

MetricsGranularity

Độ chi tiết của chỉ số để trả về dữ liệu.

Enum
UNSPECIFIED_GRANULARITY Mức độ chi tiết mặc định của chỉ số được dùng để truy vấn không có chỉ số nào.
WEEKLY Thể hiện các chỉ số hằng tuần.
DAILY Thể hiện các chỉ số hằng ngày trong khoảng thời gian 7 ngày.

MetricsFilter

Bộ lọc dùng để giảm phạm vi của yêu cầu.

Biểu diễn dưới dạng JSON 
{
  "deploymentId": string
}
Các trường
deploymentId

string

Trường không bắt buộc cho biết quá trình triển khai cụ thể để truy xuất chỉ số.

MetricsValue

Giá trị chỉ số chứa số lần thực thi được tính.

Biểu diễn dưới dạng JSON 
{
  "value": string,
  "startTime": string,
  "endTime": string
}
Các trường
value

string

Cho biết số lần thực thi được tính.
startTime

string (Timestamp format)

Trường bắt buộc cho biết thời gian bắt đầu của khoảng thời gian.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Trường bắt buộc cho biết thời gian kết thúc của khoảng thời gian.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".