Script Service

Script

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

Clases

Nombre	Descripción breve
AuthMode	Es una enumeración que identifica qué categorías de servicios autorizados puede ejecutar Apps Script a través de una función activada.
AuthorizationInfo	Es un objeto que verifica si el usuario otorgó autorización para los alcances requeridos de la secuencia de comandos.
AuthorizationStatus	Es una enumeración que denota el estado de autorización de una secuencia de comandos.
CalendarTriggerBuilder	Es un compilador para activadores de calendario.
ClockTriggerBuilder	Es un compilador para activadores de reloj.
DocumentTriggerBuilder	Es un compilador de activadores de documentos.
EventType	Es una enumeración que denota el tipo de evento activado.
FormTriggerBuilder	Es un compilador para activadores de formularios.
InstallationSource	Es 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 manipularla
SpreadsheetTriggerBuilder	Compilador para activadores de hojas de cálculo.
StateTokenBuilder	Permite que las secuencias de comandos creen tokens de estado que se pueden usar en las APIs de devolución de llamada (como los flujos de OAuth).
Trigger	Es un activador de secuencia de comandos.
TriggerBuilder	Es un compilador genérico para activadores de secuencias de comandos.
TriggerSource	Es una enumeración que denota la fuente del evento que hace que se active el disparador.

AuthMode

Propiedades

Propiedad	Tipo	Descripción
NONE	Enum	Es 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 su uso en funciones personalizadas de hojas de cálculo.
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 devuelve	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|null	Obtiene la URL de autorización que se puede usar para otorgar acceso a la secuencia de comandos.
getAuthorizedScopes()	String[]|null	Obtiene una lista de los permisos autorizados para 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 toda la autorización que requiere actualmente.

CalendarTriggerBuilder

Métodos

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

ClockTriggerBuilder

Métodos

Método	Tipo de datos que se devuelve	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 determinada, 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 el activador se ejecute cada n días.
everyHours(n)	ClockTriggerBuilder	Especifica que el activador se ejecute cada n horas.
everyMinutes(n)	ClockTriggerBuilder	Especifica que el activador se ejecute cada n minutos.
everyWeeks(n)	ClockTriggerBuilder	Especifica que el activador se ejecute cada n semanas.
inTimezone(timezone)	ClockTriggerBuilder	Especifica la zona horaria para las fechas y horas 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 del mes en la 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 devuelve	Descripción breve
create()	Trigger	Crea y devuelve el activador nuevo.
onOpen()	DocumentTriggerBuilder	Especifica un activador que se activa cuando se abre el documento.

EventType

Propiedades

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

FormTriggerBuilder

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
create()	Trigger	Crea y devuelve el activador nuevo.
onFormSubmit()	FormTriggerBuilder	Especifica un activador que se activa cuando se envía una respuesta al formulario.
onOpen()	FormTriggerBuilder	Especifica un activador que se activa cuando se abre 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 ejecuta como complemento.
WEB_STORE_ADD_ON	Enum	El usuario instaló el complemento desde Chrome Web Store.

ScriptApp

Propiedades

Propiedad	Tipo	Descripción
AuthMode	AuthMode	Es 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	Es una enumeración que denota el estado de autorización de una secuencia de comandos.
EventType	EventType	Es una enumeración que denota el tipo de evento activado.
InstallationSource	InstallationSource	Es una enumeración que indica cómo se instaló la secuencia de comandos para el usuario como complemento.
TriggerSource	TriggerSource	Es una enumeración que denota la fuente del evento que hace que se active el disparador.
WeekDay	Weekday	Es una enumeración que representa los días de la semana.

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
deleteTrigger(trigger)	void	Quita el activador determinado para que ya no se ejecute.
getAuthorizationInfo(authMode)	AuthorizationInfo	Obtiene un objeto que verifica si el usuario otorgó autorización para todos los requisitos de la secuencia de comandos.
getAuthorizationInfo(authMode, oAuthScopes)	AuthorizationInfo	Obtiene un objeto que verifica si el usuario otorgó autorización para los alcances solicitados.
getIdentityToken()	String|null	Obtiene un token de identidad de OpenID Connect para el usuario efectivo, si se otorgó el alcance de openid.
getInstallationSource()	InstallationSource	Devuelve 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 la 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 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 posee este usuario en el documento determinado, solo para esta secuencia de comandos o complemento.
getUserTriggers(form)	Trigger[]	Obtiene todos los activadores instalables que posee este usuario en el formulario determinado, solo para esta secuencia de comandos o complemento.
getUserTriggers(spreadsheet)	Trigger[]	Obtiene todos los activadores instalables que posee este usuario en la hoja de cálculo determinada, solo para esta secuencia de comandos o 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	Comienza el proceso de creación de un activador instalable que, cuando se activa, llama a una función determinada.
requireAllScopes(authMode)	void	Valida si el usuario otorgó su consentimiento para todos los permisos solicitados por la secuencia de comandos.
requireScopes(authMode, oAuthScopes)	void	Valida si el usuario otorgó su consentimiento para los alcances solicitados.

Service

Métodos

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

SpreadsheetTriggerBuilder

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
create()	Trigger	Crea el activador y lo devuelve.
onChange()	SpreadsheetTriggerBuilder	Especifica un activador que se activa cuando se cambia el contenido o la estructura de la hoja de cálculo.
onEdit()	SpreadsheetTriggerBuilder	Especifica un activador que se activa cuando se edita la hoja de cálculo.
onFormSubmit()	SpreadsheetTriggerBuilder	Especifica un activador que se activa cuando se envía un formulario a la hoja de cálculo.
onOpen()	SpreadsheetTriggerBuilder	Especifica un activador que se activa cuando se abre la hoja de cálculo.

StateTokenBuilder

Métodos

Método	Tipo de datos que se devuelve	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) durante la cual el token es válido.

Trigger

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
getEventType()	EventType	Devuelve el tipo de evento en el que se activa el disparador.
getHandlerFunction()	String	Devuelve la función que se llama cuando se activa el disparador.
getTriggerSource()	TriggerSource	Devuelve la fuente de los eventos que hacen que se active el disparador.
getTriggerSourceId()	String	Devuelve el ID específico de la fuente.
getUniqueId()	String	Devuelve un identificador único que se puede usar para distinguir los activadores entre sí.

TriggerBuilder

Métodos

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

TriggerSource

Propiedades

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