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 des filtres à appliquer à la requête. Cela limite la portée 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 des statistiques d'utilisation pour un script donné, en fonction du filtre et du masque fournis présents 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 des métriques 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 des métriques.

MetricsValue

Valeur de métrique indiquant le nombre d'exécutions comptabilisées.

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

string

Indique le nombre d'exécutions comptabilisées.
startTime

string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. 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.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".