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 .

МетрикиДетализация

Детализация метрики, для которой возвращаются данные.

Перечисления
UNSPECIFIED_GRANULARITY Детализация метрик по умолчанию используется для запроса метрик.
WEEKLY Представляет еженедельные показатели.
DAILY Представляет ежедневные показатели за период в 7 дней.

МетрикаФильтр

Фильтр, используемый для уменьшения объема запроса.

JSON-представление 
{
  "deploymentId": string
}
Поля
deploymentId

string

Необязательное поле, указывающее конкретное развертывание, из которого нужно получить метрики.

МетрикаЗначение

Значение метрики, содержащее подсчитанное количество выполнений.

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" .