- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- MetricsGranularity
- MetricsFilter
- MetricsValue
- ลองใช้งาน
รับข้อมูลเมตริกสำหรับสคริปต์ เช่น จำนวนการดำเนินการและผู้ใช้ที่ใช้งานอยู่
คำขอ HTTP
GET https://script.googleapis.com/v1/projects/{scriptId}/metrics
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
scriptId |
ช่องที่ต้องกรอกซึ่งระบุสคริปต์เพื่อรับเมตริก |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
metricsGranularity |
ช่องที่ต้องกรอกซึ่งระบุรายละเอียดของเมตริกที่แสดงขึ้น |
metricsFilter |
ช่องที่ไม่บังคับซึ่งมีตัวกรองที่จะใช้กับคำขอ ซึ่งจะจำกัดขอบเขตของเมตริกที่ส่งคืนกลับไปยังเมตริกที่ระบุไว้ในตัวกรอง |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
ทรัพยากรที่มีสถิติการใช้งานสำหรับสคริปต์ที่ระบุ โดยอิงตามตัวกรองและมาสก์ที่ให้ไว้ซึ่งอยู่ในคำขอ
การแสดง JSON |
---|
{ "activeUsers": [ { object ( |
ช่อง | |
---|---|
activeUsers[] |
จำนวนผู้ใช้ที่ใช้งานอยู่ |
totalExecutions[] |
จำนวนการดำเนินการทั้งหมด |
failedExecutions[] |
จำนวนการดำเนินการที่ไม่สำเร็จ |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/script.metrics
สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0
MetricsGranularity
รายละเอียดของเมตริกที่จะแสดงข้อมูล
Enum | |
---|---|
UNSPECIFIED_GRANULARITY |
รายละเอียดเมตริกเริ่มต้นที่ใช้ในการค้นหาไม่มีเมตริก |
WEEKLY |
แสดงเมตริกรายสัปดาห์ |
DAILY |
แสดงเมตริกรายวันในระยะเวลา 7 วัน |
MetricsFilter
ตัวกรองที่ใช้เพื่อลดขอบเขตของคำขอ
การแสดง JSON |
---|
{ "deploymentId": string } |
ช่อง | |
---|---|
deploymentId |
ช่องที่ไม่บังคับระบุการติดตั้งใช้งานที่เฉพาะเจาะจงเพื่อเรียกข้อมูลเมตริก |
MetricsValue
ค่าเมตริกที่เก็บจำนวนการดำเนินการที่นับ
การแสดง JSON |
---|
{ "value": string, "startTime": string, "endTime": string } |
ช่อง | |
---|---|
value |
ระบุจำนวนการดำเนินการที่นับ |
startTime |
ช่องที่ต้องกรอกซึ่งระบุเวลาเริ่มต้นของช่วง การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: |
endTime |
ช่องที่ต้องกรอกซึ่งระบุเวลาสิ้นสุดของช่วง การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: |