Method: projects.getMetrics

Visualizza i dati delle metriche relative agli script, ad esempio il numero di esecuzioni e gli utenti attivi.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
scriptId

string

Campo obbligatorio che indica lo script per il quale ottenere le metriche.

Parametri di ricerca

Parametri
metricsGranularity

enum (MetricsGranularity)

Campo obbligatorio che indica il livello di granularità delle metriche restituito.

metricsFilter

object (MetricsFilter)

Campo facoltativo contenente i filtri da applicare alla richiesta. Questo limita l'ambito delle metriche restituite a quelle specificate nel filtro.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Risorsa contenente le statistiche sull'utilizzo per un determinato script, in base al filtro e alla maschera forniti presenti nella richiesta.

Rappresentazione JSON
{
  "activeUsers": [
    {
      object (MetricsValue)
    }
  ],
  "totalExecutions": [
    {
      object (MetricsValue)
    }
  ],
  "failedExecutions": [
    {
      object (MetricsValue)
    }
  ]
}
Campi
activeUsers[]

object (MetricsValue)

Numero di utenti attivi.

totalExecutions[]

object (MetricsValue)

Numero di esecuzioni totali.

failedExecutions[]

object (MetricsValue)

Numero di esecuzioni non riuscite.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

MetricsGranularity

La granularità della metrica per la quale restituire i dati.

Enum
UNSPECIFIED_GRANULARITY Granularità della metrica predefinita utilizzata per non eseguire query su nessuna metrica.
WEEKLY Rappresenta le metriche settimanali.
DAILY Rappresenta le metriche giornaliere per un periodo di 7 giorni.

MetricsFilter

Filtro utilizzato per ridurre l'ambito della richiesta.

Rappresentazione JSON
{
  "deploymentId": string
}
Campi
deploymentId

string

Campo facoltativo che indica un deployment specifico da cui recuperare le metriche.

MetricsValue

Valore delle metriche che contiene il numero di esecuzioni conteggiate.

Rappresentazione JSON
{
  "value": string,
  "startTime": string,
  "endTime": string
}
Campi
value

string

Indica il numero di esecuzioni conteggiate.

startTime

string (Timestamp format)

Campo obbligatorio che indica l'ora di inizio dell'intervallo.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Campo obbligatorio che indica l'ora di fine dell'intervallo.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".