Method: projects.getMetrics

קבלת נתוני מדדים לגבי סקריפטים, כמו מספר ההפעלות והמשתמשים הפעילים.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

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