Method: projects.getMetrics

รับข้อมูลเมตริกสําหรับสคริปต์ เช่น จํานวนการดําเนินการและผู้ใช้ที่ใช้งานอยู่

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
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

เมตริกแบบละเอียด

ความละเอียดของเมตริกที่จะแสดงผลข้อมูล

Enum
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 "ซูลู" ที่มีความละเอียดระดับนาโนวินาทีและเป็นตัวเลขเศษส่วนไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

endTime

string (Timestamp format)

ช่องที่ต้องกรอกสําหรับเวลาสิ้นสุดของช่วงเวลา

การประทับเวลาในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดระดับนาโนวินาทีและเป็นตัวเลขเศษส่วนไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"