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

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

טיפוסים בני מנייה (enums)
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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

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