Method: projects.getMetrics

Pobierz dane dotyczące skryptów, takie jak liczba 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 chcesz pobrać wskaźniki.

Parametry zapytania

Parametry
metricsGranularity

enum (MetricsGranularity)

Pole wymagane, 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 danych 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 wykorzystania danego skryptu określone na podstawie dostarczonego filtra i maski w żądaniu.

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.

MetricsGranularity

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

Wartości w polu enum
UNSPECIFIED_GRANULARITY Domyślna szczegółowość wskaźników używana do wysyłania zapytań o brak danych.
WEEKLY Reprezentuje dane tygodniowe.
DAILY Odzwierciedla dane dzienne z okresu 7 dni.

MetricsFilter

Filtr używany do ograniczenia zakresu żądania.

Zapis JSON
{
  "deploymentId": string
}
Pola
deploymentId

string

Opcjonalne pole wskazujące konkretne wdrożenie, z którego mają być pobierane wskaźniki.

MetricsValue

Wartość wskaźników, w której zliczono liczbę wykonań.

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

string

Wskazuje liczbę zliczonych wykonań.

startTime

string (Timestamp format)

Pole wymagane do określania czasu rozpoczęcia przedziału czasu.

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

endTime

string (Timestamp format)

Wymagane pole wskazujące czas zakończenia przedziału.

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