Method: projects.getMetrics

Obtenez des données de métriques pour les scripts, telles que le nombre d'exécutions et d'utilisateurs actifs.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
scriptId

string

Champ obligatoire indiquant le script pour lequel obtenir des métriques.

Paramètres de requête

Paramètres
metricsGranularity

enum (MetricsGranularity)

Champ obligatoire indiquant le niveau de précision des métriques renvoyées.

metricsFilter

object (MetricsFilter)

Champ facultatif contenant les filtres à appliquer à la requête. Cela permet de limiter le champ d'application des métriques renvoyées à celles spécifiées dans le filtre.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Ressource contenant les statistiques d'utilisation d'un script donné, en fonction du filtre et du masque fournis dans la requête.

Représentation JSON
{
  "activeUsers": [
    {
      object (MetricsValue)
    }
  ],
  "totalExecutions": [
    {
      object (MetricsValue)
    }
  ],
  "failedExecutions": [
    {
      object (MetricsValue)
    }
  ]
}
Champs
activeUsers[]

object (MetricsValue)

Nombre d'utilisateurs actifs

totalExecutions[]

object (MetricsValue)

Nombre total d'exécutions.

failedExecutions[]

object (MetricsValue)

Nombre d'exécutions ayant échoué.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

MetricsGranularity

Précision de la métrique pour laquelle renvoyer des données.

Enums
UNSPECIFIED_GRANULARITY Précision de la métrique par défaut utilisée pour n'interroger aucune métrique.
WEEKLY Représente les métriques hebdomadaires.
DAILY Représente les métriques quotidiennes sur une période de sept jours.

MetricsFilter

Filtre utilisé pour réduire le champ d'application de la requête.

Représentation JSON
{
  "deploymentId": string
}
Champs
deploymentId

string

Champ facultatif indiquant un déploiement spécifique à partir duquel extraire les métriques.

MetricsValue

Valeur des métriques contenant le nombre d'exécutions comptées.

Représentation JSON
{
  "value": string,
  "startTime": string,
  "endTime": string
}
Champs
value

string

Indique le nombre d'exécutions comptées.

startTime

string (Timestamp format)

Champ obligatoire indiquant l'heure de début de l'intervalle.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Champ obligatoire indiquant l'heure de fin de l'intervalle.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".