Method: projects.getMetrics

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Obtén datos de métricas de las 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 las secuencias de comandos para las que se deben obtener métricas.

Parámetros de consulta

Parámetros
metricsGranularity

enum (MetricsGranularity)

Campo obligatorio que indica el nivel de detalle de las métricas que se muestran.

metricsFilter

object (MetricsFilter)

Campo opcional que contiene filtros para aplicar a la solicitud. Esto limita el alcance de las métricas que se muestran a las que se especifican 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 suministrados 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 de ejecuciones totales.

failedExecutions[]

object (MetricsValue)

Cantidad de ejecuciones fallidas.

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.

Nivel de detalle de métricas

El nivel de detalle de la métrica para la que se muestran los datos.

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

Filtro de métricas

Filtro utilizado para reducir el alcance de la solicitud.

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

string

Campo opcional que indica una implementación específica para recuperar métricas.

Valor de métricas

Valor de métricas que contiene la cantidad de ejecuciones registradas.

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 resolución en nanosegundos y hasta nueve dígitos decimales. 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 resolución en nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".