Method: projects.getMetrics

Obtén datos de métricas para secuencias de comandos, como la cantidad de ejecuciones y los usuarios activos.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
scriptId

string

Campo obligatorio que indica la secuencia de comandos para la que se obtendrán métricas.

Parámetros de consulta

Parámetros
metricsGranularity

enum (MetricsGranularity)

Campo obligatorio que indica qué nivel de detalle de las métricas se muestra.
metricsFilter

object (MetricsFilter)

Campo opcional que contiene los filtros que se aplicarán a la solicitud. Esto limita el permiso de las métricas que se muestran a las especificadas en el filtro.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Recurso que contiene estadísticas de uso para una secuencia de comandos determinada, según el filtro y la máscara proporcionados presentes en la solicitud.

Representación JSON 
{
  "activeUsers": [
    {
      object (MetricsValue)
    }
  ],
  "totalExecutions": [
    {
      object (MetricsValue)
    }
  ],
  "failedExecutions": [
    {
      object (MetricsValue)
    }
  ]
}
Campos
activeUsers[]

object (MetricsValue)

Cantidad de usuarios activos
totalExecutions[]

object (MetricsValue)

Cantidad total de ejecuciones.
failedExecutions[]

object (MetricsValue)

Cantidad de ejecuciones con errores.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

MetricsGranularity

El nivel de detalle de la métrica para la que se mostrarán los datos.

Enumeraciones
UNSPECIFIED_GRANULARITY El nivel de detalle de la métrica predeterminado que se usa para no consultar ninguna métrica.
WEEKLY Representa las métricas semanales.
DAILY Representa las métricas diarias durante un período de 7 días.

MetricsFilter

Es el filtro que se usa para reducir el alcance de la solicitud.

Representación JSON 
{
  "deploymentId": string
}
Campos
deploymentId

string

Campo opcional que indica una implementación específica de la que se recuperarán métricas.

MetricsValue

Valor de la métrica que contiene la cantidad de ejecuciones contabilizadas.

Representación JSON 
{
  "value": string,
  "startTime": string,
  "endTime": string
}
Campos
value

string

Indica la cantidad de ejecuciones contadas.
startTime

string (Timestamp format)

Campo obligatorio que indica la hora de inicio del intervalo.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Campo obligatorio que indica la hora de finalización del intervalo.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".