Method: projects.getMetrics

Rufen Sie Messwertdaten für Skripts ab, z. B. die Anzahl der Ausführungen und aktive Nutzer.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
scriptId

string

Pflichtfeld, das das Script angibt, für das Messwerte abgerufen werden sollen.

Abfrageparameter

Parameter
metricsGranularity

enum (MetricsGranularity)

Pflichtfeld, das angibt, welcher Detaillierungsgrad von Messwerten zurückgegeben wird.

metricsFilter

object (MetricsFilter)

Optionales Feld mit Filtern, die auf die Anfrage angewendet werden sollen. Dadurch wird der Umfang der zurückgegebenen Messwerte auf die im Filter angegebenen Werte begrenzt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Ressource mit Nutzungsstatistiken für ein bestimmtes Skript, basierend auf dem angegebenen Filter und der in der Anfrage vorhandenen Maske.

JSON-Darstellung
{
  "activeUsers": [
    {
      object (MetricsValue)
    }
  ],
  "totalExecutions": [
    {
      object (MetricsValue)
    }
  ],
  "failedExecutions": [
    {
      object (MetricsValue)
    }
  ]
}
Felder
activeUsers[]

object (MetricsValue)

Anzahl der aktiven Nutzer

totalExecutions[]

object (MetricsValue)

Gesamtzahl der Ausführungen.

failedExecutions[]

object (MetricsValue)

Anzahl der fehlgeschlagenen Ausführungen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

MetricsGranularity

Der Detaillierungsgrad des Messwerts, für den Daten zurückgegeben werden sollen.

Enums
UNSPECIFIED_GRANULARITY Standardmäßiger Detaillierungsgrad für Messwerte, der verwendet wird, um keine Messwerte abzufragen.
WEEKLY Stellt wöchentliche Messwerte dar.
DAILY Stellt tägliche Messwerte über einen Zeitraum von 7 Tagen dar.

MetricsFilter

Filter, mit dem der Umfang der Anfrage reduziert wird.

JSON-Darstellung
{
  "deploymentId": string
}
Felder
deploymentId

string

Optionales Feld, das eine bestimmte Bereitstellung angibt, aus der Messwerte abgerufen werden sollen.

MetricsValue

Messwert, der die Anzahl der gezählten Ausführungen enthält.

JSON-Darstellung
{
  "value": string,
  "startTime": string,
  "endTime": string
}
Felder
value

string

Gibt die Anzahl der gezählten Ausführungen an.

startTime

string (Timestamp format)

Pflichtfeld, das die Startzeit des Intervalls angibt.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Pflichtfeld, das die Endzeit des Intervalls angibt.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".