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

دقة المقياس المطلوب عرض بيانات له.

عمليات التعداد
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"