Method: projects.getMetrics

داده‌های معیارهای اسکریپت‌ها، مانند تعداد اجراها و کاربران فعال را دریافت کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
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 "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" .