Method: projects.getMetrics

Pobieraj dane o wydajności skryptów, np. liczbę uruchomień i aktywnych użytkowników.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
scriptId

string

Wymagane pole wskazujące skrypt, dla którego mają zostać pobrane wskaźniki.

Parametry zapytania

Parametry
metricsGranularity

enum (MetricsGranularity)

Wymagane pole wskazujące szczegółowość zwracanych danych.
metricsFilter

object (MetricsFilter)

Opcjonalne pole zawierające filtry, które można zastosować do żądania. Ogranicza to zakres zwracanych danych do tych określonych w filtrze.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zasób zawierający statystyki użytkowania danego skryptu na podstawie podanego w żądaniu filtra i maski.

Zapis JSON 
{
  "activeUsers": [
    {
      object (MetricsValue)
    }
  ],
  "totalExecutions": [
    {
      object (MetricsValue)
    }
  ],
  "failedExecutions": [
    {
      object (MetricsValue)
    }
  ]
}
Pola
activeUsers[]

object (MetricsValue)

Liczba aktywnych użytkowników.
totalExecutions[]

object (MetricsValue)

Liczba wszystkich wykonań.
failedExecutions[]

object (MetricsValue)

Liczba nieudanych wykonań.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/script.metrics

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.

Dane – szczegółowość

Szczegółowość wskaźnika, dla którego zostaną zwrócone dane.

Wartości w polu enum
UNSPECIFIED_GRANULARITY Domyślna szczegółowość danych używana w przypadku braku danych.
WEEKLY Reprezentują dane tygodniowe.
DAILY Reprezentuje dane dzienne z 7 dni.

MetricsFilter

Filtr użyty do ograniczenia zakresu żądania.

Zapis JSON 
{
  "deploymentId": string
}
Pola
deploymentId

string

Opcjonalne pole wskazujące określone wdrożenie, z którego należy pobrać wskaźniki.

MetricsValue

Wartość danych, w której znajduje się liczba policzonych wykonań.

Zapis JSON 
{
  "value": string,
  "startTime": string,
  "endTime": string
}
Pola
value

string

Wskazuje liczbę zliczonych wykonań.
startTime

string (Timestamp format)

Pole wymagane, które wskazuje czas rozpoczęcia interwału.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Pole wymagane, które wskazuje czas zakończenia interwału.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".