Se usó la API de Cloud Translation para traducir esta página.

Script Service

Este servicio proporciona acceso a los activadores y a la publicación de secuencias de comandos.

Clases

Nombre	Descripción breve
`AuthMode`	Una enumeración que identifica qué categorías de servicios autorizados puede ejecutar Apps Script a través de una función activada.
`AuthorizationInfo`	Objeto que se usa para determinar si el usuario debe autorizar esta secuencia de comandos a fin de usar uno o más servicios y proporcionar la URL para un diálogo de autorización.
`AuthorizationStatus`	Una enumeración que denota el estado de autorización de una secuencia de comandos.
`CalendarTriggerBuilder`	Compilador para activadores de calendario.
`ClockTriggerBuilder`	Un compilador para activadores de reloj.
`DocumentTriggerBuilder`	Un compilador para activadores de documentos.
`EventType`	Una enumeración que denota el tipo de evento activado.
`FormTriggerBuilder`	Un compilador para activadores de formularios.
`InstallationSource`	Una enumeración que indica cómo se instaló la secuencia de comandos como complemento para el usuario actual.
`ScriptApp`	Acceder a la publicación y los activadores de secuencias de comandos y manipularlos
`Service`	Acceder a la publicación de secuencias de comandos y manipularlas
`SpreadsheetTriggerBuilder`	Compilador para activadores de hojas de cálculo.
`StateTokenBuilder`	Permite que las secuencias de comandos creen tokens de estado que se pueden utilizar en las APIs de devolución de llamada (como los flujos de OAuth).
`Trigger`	Un activador de secuencia de comandos
`TriggerBuilder`	Un compilador genérico para activadores de secuencias de comandos
`TriggerSource`	Una enumeración que indica la fuente del evento que hace que el activador se active.

`AuthMode`

Propiedades

Propiedad	Tipo	Descripción
`NONE`	`Enum`	Un modo que no permite el acceso a ningún servicio que requiera autorización.
`CUSTOM_FUNCTION`	`Enum`	Es un modo que permite el acceso a un subconjunto limitado de servicios para usar en funciones de hojas de cálculo personalizadas.
`LIMITED`	`Enum`	Es un modo que permite el acceso a un subconjunto limitado de servicios.
`FULL`	`Enum`	Es un modo que permite el acceso a todos los servicios que requieren autorización.

`AuthorizationInfo`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`getAuthorizationStatus()`	`AuthorizationStatus`	Obtiene un valor que indica si el usuario debe autorizar esta secuencia de comandos para usar uno o más servicios (por ejemplo, `ScriptApp.AuthorizationStatus.REQUIRED`).
`getAuthorizationUrl()`	`String`	Obtiene la URL de autorización que se puede usar para otorgar acceso a la secuencia de comandos.

`AuthorizationStatus`

Propiedades

Propiedad	Tipo	Descripción
`REQUIRED`	`Enum`	El usuario debe autorizar esta secuencia de comandos para usar uno o más servicios.
`NOT_REQUIRED`	`Enum`	El usuario otorgó a esta secuencia de comandos todas las autorizaciones que requiere actualmente.

`CalendarTriggerBuilder`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`create()`	`Trigger`	Crea el activador y lo muestra.
`onEventUpdated()`	`CalendarTriggerBuilder`	Especifica un activador que se activa cuando se crea, actualiza o borra una entrada de calendario.

`ClockTriggerBuilder`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`after(durationMilliseconds)`	`ClockTriggerBuilder`	Especifica la duración mínima (en milisegundos) después de la hora actual en la que se ejecuta el activador.
`at(date)`	`ClockTriggerBuilder`	Especifica cuándo se ejecuta el activador.
`atDate(year, month, day)`	`ClockTriggerBuilder`	Especifica que el activador se activa en la fecha dada, de forma predeterminada cerca de la medianoche (+/- 15 minutos).
`atHour(hour)`	`ClockTriggerBuilder`	Especifica la hora en la que se ejecuta el activador.
`create()`	`Trigger`	Crea el activador.
`everyDays(n)`	`ClockTriggerBuilder`	Especifica que se ejecute el activador cada `n` días.
`everyHours(n)`	`ClockTriggerBuilder`	Especifica que se ejecute el activador cada `n` horas.
`everyMinutes(n)`	`ClockTriggerBuilder`	Especifica que se ejecute el activador cada `n` minutos.
`everyWeeks(n)`	`ClockTriggerBuilder`	Especifica que se ejecute el activador cada `n` semanas.
`inTimezone(timezone)`	`ClockTriggerBuilder`	Especifica la zona horaria para la fecha y la hora especificadas en las que se ejecuta el activador.
`nearMinute(minute)`	`ClockTriggerBuilder`	Especifica el minuto en el que se ejecuta el activador (más o menos 15 minutos).
`onMonthDay(day)`	`ClockTriggerBuilder`	Especifica la fecha en el mes en el que se ejecuta el activador.
`onWeekDay(day)`	`ClockTriggerBuilder`	Especifica el día de la semana en que se ejecuta el activador.

`DocumentTriggerBuilder`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`create()`	`Trigger`	Crea y muestra el activador nuevo.
`onOpen()`	`DocumentTriggerBuilder`	Especifica un activador que se activará cuando se abra el documento.

`EventType`

Propiedades

Propiedad	Tipo	Descripción
`CLOCK`	`Enum`	El activador se activa una vez que el evento basado en el tiempo alcanza un tiempo específico.
`ON_OPEN`	`Enum`	El activador se activa cuando el usuario abre el archivo de Documentos, Hojas de cálculo o Formularios de Google.
`ON_EDIT`	`Enum`	El activador se activa una vez que el usuario edita el archivo de Hojas de cálculo de Google (por ejemplo, si ingresa un valor nuevo en una celda, lo que cuenta como una edición en lugar de un cambio).
`ON_FORM_SUBMIT`	`Enum`	El activador se activa cuando el usuario responde un formulario de Google.
`ON_CHANGE`	`Enum`	El activador se activa cuando el usuario cambia el archivo de Hojas de cálculo de Google (por ejemplo, si agrega una fila, lo que cuenta como un cambio en lugar de una edición).
`ON_EVENT_UPDATED`	`Enum`	El activador se activa cuando se crea, actualiza o borra un evento en el Calendario de Google especificado.

`FormTriggerBuilder`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`create()`	`Trigger`	Crea y muestra el activador nuevo.
`onFormSubmit()`	`FormTriggerBuilder`	Especifica un activador que se activará cuando se envíe una respuesta al formulario.
`onOpen()`	`FormTriggerBuilder`	Especifica un activador que se activará cuando se abra la vista de edición del formulario.

`InstallationSource`

Propiedades

Propiedad	Tipo	Descripción
`APPS_MARKETPLACE_DOMAIN_ADD_ON`	`Enum`	El administrador instaló el complemento para el dominio del usuario.
`NONE`	`Enum`	La secuencia de comandos no se está ejecutando como complemento.
`WEB_STORE_ADD_ON`	`Enum`	El usuario instaló el complemento desde Chrome Web Store.

`ScriptApp`

Propiedades

Propiedad	Tipo	Descripción
`AuthMode`	`AuthMode`	Una enumeración que identifica qué categorías de servicios autorizados puede ejecutar Apps Script a través de una función activada.
`AuthorizationStatus`	`AuthorizationStatus`	Una enumeración que denota el estado de autorización de una secuencia de comandos.
`EventType`	`EventType`	Una enumeración que denota el tipo de evento activado.
`InstallationSource`	`InstallationSource`	Una enumeración que indica cómo se instaló la secuencia de comandos en el usuario como complemento.
`TriggerSource`	`TriggerSource`	Una enumeración que indica la fuente del evento que hace que el activador se active.
`WeekDay`	`Weekday`	Una enumeración que representa los días de la semana.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`deleteTrigger(trigger)`	`void`	Quita el activador determinado para que ya no se ejecute.
`getAuthorizationInfo(authMode)`	`AuthorizationInfo`	Obtiene un objeto que se usa para determinar si el usuario debe autorizar esta secuencia de comandos a fin de usar uno o más servicios y proporcionar la URL para un diálogo de autorización.
`getIdentityToken()`	`String`	Obtiene un token de identidad de OpenID Connect para el usuario real, si se otorgó el alcance `openid`.
`getInstallationSource()`	`InstallationSource`	Muestra un valor de enumeración que indica cómo se instaló la secuencia de comandos como complemento para el usuario actual (por ejemplo, si el usuario la instaló personalmente a través de Chrome Web Store o si un administrador del dominio lo instaló para todos los usuarios).
`getOAuthToken()`	`String`	Obtiene el token de acceso de OAuth 2.0 para el usuario efectivo.
`getProjectTriggers()`	`Trigger[]`	Obtiene todos los activadores instalables asociados con el proyecto y el usuario actuales.
`getScriptId()`	`String`	Obtiene el ID único del proyecto de la secuencia de comandos.
`getService()`	`Service`	Obtiene un objeto que se usa para controlar la publicación de la secuencia de comandos como una app web.
`getUserTriggers(document)`	`Trigger[]`	Obtiene todos los activadores instalables que pertenecen a este usuario en el documento determinado, solo para esta secuencia de comandos o este complemento.
`getUserTriggers(form)`	`Trigger[]`	Obtiene todos los activadores instalables que posee este usuario en el formato especificado, solo para esta secuencia de comandos o este complemento.
`getUserTriggers(spreadsheet)`	`Trigger[]`	Obtiene todos los activadores instalables que pertenecen a este usuario en la hoja de cálculo determinada, solo para esta secuencia de comandos o este complemento.
`invalidateAuth()`	`void`	Invalida la autorización que tiene el usuario efectivo para ejecutar la secuencia de comandos actual.
`newStateToken()`	`StateTokenBuilder`	Crea un compilador para un token de estado que se puede usar en una API de devolución de llamada (como un flujo de OAuth).
`newTrigger(functionName)`	`TriggerBuilder`	Inicia el proceso de creación de un activador instalable que, cuando se activa, llama a una función determinada.

`Service`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`getUrl()`	`String`	Muestra la URL de la app web, si se implementó, de lo contrario, muestra `null`.
`isEnabled()`	`Boolean`	Muestra `true` si se puede acceder a la secuencia de comandos como una aplicación web.

`SpreadsheetTriggerBuilder`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`create()`	`Trigger`	Crea el activador y lo muestra.
`onChange()`	`SpreadsheetTriggerBuilder`	Especifica un activador que se activará cuando se cambie el contenido o la estructura de la hoja de cálculo.
`onEdit()`	`SpreadsheetTriggerBuilder`	Especifica un activador que se activará cuando se edite la hoja de cálculo.
`onFormSubmit()`	`SpreadsheetTriggerBuilder`	Especifica un activador que se activará cuando la hoja de cálculo tenga un formulario enviado.
`onOpen()`	`SpreadsheetTriggerBuilder`	Especifica un activador que se activará cuando se abra la hoja de cálculo.

`StateTokenBuilder`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`createToken()`	`String`	Construye una representación de cadena encriptada del token de estado.
`withArgument(name, value)`	`StateTokenBuilder`	Agrega un argumento al token.
`withMethod(method)`	`StateTokenBuilder`	Establece una función de devolución de llamada.
`withTimeout(seconds)`	`StateTokenBuilder`	Establece la duración (en segundos) de la validez del token.

`Trigger`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`getEventType()`	`EventType`	Muestra el tipo de evento en el que se activa el activador.
`getHandlerFunction()`	`String`	Muestra la función a la que se llamará cuando se active el activador.
`getTriggerSource()`	`TriggerSource`	Muestra la fuente de los eventos que harán que el activador se active.
`getTriggerSourceId()`	`String`	Muestra el ID específico de la fuente.
`getUniqueId()`	`String`	Muestra un identificador único que se puede usar para distinguir los activadores entre sí.

`TriggerBuilder`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`forDocument(document)`	`DocumentTriggerBuilder`	Crea y muestra un `DocumentTriggerBuilder` vinculado al documento dado.
`forDocument(key)`	`DocumentTriggerBuilder`	Crea y muestra un `DocumentTriggerBuilder` vinculado al documento con el ID determinado.
`forForm(form)`	`FormTriggerBuilder`	Crea y muestra un `FormTriggerBuilder` vinculado al formulario dado.
`forForm(key)`	`FormTriggerBuilder`	Crea y muestra un `FormTriggerBuilder` vinculado al formulario con el ID determinado.
`forSpreadsheet(sheet)`	`SpreadsheetTriggerBuilder`	Crea y muestra un `SpreadsheetTriggerBuilder` vinculado a la hoja de cálculo determinada.
`forSpreadsheet(key)`	`SpreadsheetTriggerBuilder`	Crea y muestra un `SpreadsheetTriggerBuilder` vinculado a la hoja de cálculo con el ID determinado.
`forUserCalendar(emailId)`	`CalendarTriggerBuilder`	Muestra un compilador para compilar activadores de calendario.
`timeBased()`	`ClockTriggerBuilder`	Crea y muestra un `ClockTriggerBuilder` para compilar activadores basados en el tiempo.

`TriggerSource`

Propiedades

Propiedad	Tipo	Descripción
`SPREADSHEETS`	`Enum`	Hojas de cálculo de Google activa el activador.
`CLOCK`	`Enum`	Un evento basado en el tiempo hace que el activador se active.
`FORMS`	`Enum`	Formularios de Google activa el activador.
`DOCUMENTS`	`Enum`	Documentos de Google hace que el activador se active.
`CALENDAR`	`Enum`	El Calendario de Google activa el activador.

Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.

Última actualización: 2023-12-01 (UTC)

Blog
Lea el blog de Google Workspace Developers
Stack Overflow
Cómo hacer una pregunta con la etiqueta google-apps-script
Muestras de código
Explora nuestras muestras de código o cópialas para crear tu propia muestra
Videos
Mire instructivos de Apps Script