- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- MetricsGranularity
- MetricsFilter
- MetricsValue
- Pruébala
Obtén datos de métricas para las secuencias de comandos, como la cantidad de ejecuciones y 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 |
Campo obligatorio que indica la secuencia de comandos para la que se deben obtener las métricas. |
Parámetros de consulta
Parámetros | |
---|---|
metricsGranularity |
Campo obligatorio que indica el nivel de detalle de las métricas que se muestran. |
metricsFilter |
Campo opcional que contiene los filtros para aplicar a la solicitud. Esto limita el alcance 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 ( |
Campos | |
---|---|
activeUsers[] |
Cantidad de usuarios activos. |
totalExecutions[] |
Cantidad total de ejecuciones. |
failedExecutions[] |
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.
Enumeradores | |
---|---|
UNSPECIFIED_GRANULARITY |
Nivel de detalle de la métrica predeterminado que no se utiliza para 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 |
Campo opcional que indica una implementación específica para recuperar métricas. |
MetricsValue
Valor de métricas que contiene la cantidad de ejecuciones contadas.
Representación JSON |
---|
{ "value": string, "startTime": string, "endTime": string } |
Campos | |
---|---|
value |
Indica la cantidad de ejecuciones contadas. |
startTime |
Campo obligatorio que indica la hora de inicio del intervalo. Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
endTime |
Campo obligatorio que indica la hora de finalización del intervalo. Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |