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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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"