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

MetricsGranularity

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

Enum
UNSPECIFIED_GRANULARITY รายละเอียดเมตริกเริ่มต้นที่ใช้เพื่อค้นหาเมตริก
WEEKLY แสดงเมตริกรายสัปดาห์
DAILY แสดงเมตริกรายวันในช่วง 7 วัน

MetricsFilter

ตัวกรองที่ใช้ลดขอบเขตของคำขอ

การแสดง JSON 
{
  "deploymentId": string
}
ช่อง
deploymentId

string

ฟิลด์ที่ไม่บังคับซึ่งระบุการทำให้ใช้งานได้ที่ต้องการดึงข้อมูลเมตริก

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"