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.

מדדים מפורטים

רמת הפירוט של המדד שעבורו יש להחזיר נתונים.

Enums
UNSPECIFIED_GRANULARITY רמת הפירוט שמוגדרת כברירת מחדל לשליחת שאילתות לגבי מדדים כלשהם.
WEEKLY מייצג מדדים שבועיים.
DAILY המדד הזה מייצג מדדים יומיים על פני תקופה של 7 ימים.

מסנן ערכים

המסנן משמש לצמצום של היקף הבקשה.

ייצוג JSON 
{
  "deploymentId": string
}
שדות
deploymentId

string

שדה אופציונלי שמציין פריסה ספציפית שממנה רוצים לאחזר מדדים.

ערך ערכים

ערך מדדים שכולל את מספר ההפעלות שנספר.

ייצוג JSON 
{
  "value": string,
  "startTime": string,
  "endTime": string
}
שדות
value

string

מציין את מספר ההפעלות שנספרו.
startTime

string (Timestamp format)

זהו שדה חובה שמציין את שעת ההתחלה של המרווח.

חותמת זמן בפורמט "Zulu" של RFC3339 UTC, עם רזולוציית ננו-שניות ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z"
endTime

string (Timestamp format)

זהו שדה חובה שמציין את שעת הסיום של המרווח.

חותמת זמן בפורמט "Zulu" של RFC3339 UTC, עם רזולוציית ננו-שניות ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z"