Script Service

Script

Esse serviço fornece acesso aos acionadores e à publicação de scripts.

Classes

Nome	Breve descrição
AuthMode	Uma enumeração que identifica quais categorias de serviços autorizados o Apps Script pode executar por meio de uma função acionada.
AuthorizationInfo	Um objeto que verifica se o usuário concedeu autorização para os escopos necessários do script.
AuthorizationStatus	Uma enumeração que indica o status de autorização de um script.
CalendarTriggerBuilder	Builder para acionadores de agenda.
ClockTriggerBuilder	Um builder para acionadores de relógio.
DocumentTriggerBuilder	Um builder para gatilhos de documentos.
EventType	Uma enumeração que indica o tipo de evento acionado.
FormTriggerBuilder	Um builder para acionadores de formulário.
InstallationSource	Uma enumeração que indica como o script foi instalado como um complemento para o usuário atual.
ScriptApp	Acessar e manipular a publicação e os gatilhos de scripts.
Service	Acessar e manipular a publicação de scripts.
SpreadsheetTriggerBuilder	Criador de acionadores de planilhas.
StateTokenBuilder	Permite que os scripts criem tokens de estado que podem ser usados em APIs de callback, como fluxos OAuth.
Trigger	Um acionador de script.
TriggerBuilder	Um builder genérico para acionadores de script.
TriggerSource	Uma enumeração que indica a origem do evento que aciona o acionador.

AuthMode

Propriedades

Propriedade	Tipo	Descrição
NONE	Enum	Um modo que não permite o acesso a serviços que exigem autorização.
CUSTOM_FUNCTION	Enum	Um modo que permite o acesso a um subconjunto limitado de serviços para uso em funções de planilha personalizadas.
LIMITED	Enum	Um modo que permite o acesso a um subconjunto limitado de serviços.
FULL	Enum	Um modo que permite o acesso a todos os serviços que exigem autorização.

AuthorizationInfo

Métodos

Método	Tipo de retorno	Breve descrição
getAuthorizationStatus()	AuthorizationStatus	Recebe um valor que indica se o usuário precisa autorizar esse script para usar um ou mais serviços (por exemplo, ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()	String	Recebe o URL de autorização que pode ser usado para conceder acesso ao script.
getAuthorizedScopes()	String[]	Recebe uma lista de escopos autorizados para o script.

AuthorizationStatus

Propriedades

Propriedade	Tipo	Descrição
REQUIRED	Enum	O usuário precisa autorizar esse script para usar um ou mais serviços.
NOT_REQUIRED	Enum	O usuário concedeu a esse script todas as autorizações necessárias no momento.

CalendarTriggerBuilder

Métodos

Método	Tipo de retorno	Breve descrição
create()	Trigger	Cria e retorna o acionador.
onEventUpdated()	CalendarTriggerBuilder	Especifica um acionador que é acionado quando uma entrada de calendário é criada, atualizada ou excluída.

ClockTriggerBuilder

Métodos

Método	Tipo de retorno	Breve descrição
after(durationMilliseconds)	ClockTriggerBuilder	Especifica a duração mínima (em milissegundos) após o tempo atual em que o acionador é executado.
at(date)	ClockTriggerBuilder	Especifica quando o acionador é executado.
atDate(year, month, day)	ClockTriggerBuilder	Especifica que o acionador é acionado na data especificada, por padrão, perto da meia-noite (+/- 15 minutos).
atHour(hour)	ClockTriggerBuilder	Especifica a hora em que o acionador é executado.
create()	Trigger	Cria o acionador.
everyDays(n)	ClockTriggerBuilder	Especifica a execução do acionador a cada n dias.
everyHours(n)	ClockTriggerBuilder	Especifica a execução do acionador a cada n horas.
everyMinutes(n)	ClockTriggerBuilder	Especifica a execução do acionador a cada n minutos.
everyWeeks(n)	ClockTriggerBuilder	Especifica a execução do acionador a cada n semanas.
inTimezone(timezone)	ClockTriggerBuilder	Especifica o fuso horário para as datas/horas especificadas quando o acionador é executado.
nearMinute(minute)	ClockTriggerBuilder	Especifica o minuto em que o acionador é executado (mais ou menos 15 minutos).
onMonthDay(day)	ClockTriggerBuilder	Especifica a data do mês em que o acionador é executado.
onWeekDay(day)	ClockTriggerBuilder	Especifica o dia da semana em que o acionador é executado.

DocumentTriggerBuilder

Métodos

Método	Tipo de retorno	Breve descrição
create()	Trigger	Cria e retorna o novo acionador.
onOpen()	DocumentTriggerBuilder	Especifica um acionador que será acionado quando o documento for aberto.

EventType

Propriedades

Propriedade	Tipo	Descrição
CLOCK	Enum	O acionador é acionado quando o evento baseado em tempo atinge um horário específico.
ON_OPEN	Enum	O acionador é acionado quando o usuário abre o arquivo do Documentos, Planilhas ou Formulários Google.
ON_EDIT	Enum	O acionador é acionado quando o usuário edita o arquivo do Planilhas Google, por exemplo, inserindo um novo valor em uma célula, o que conta como uma edição em vez de uma mudança.
ON_FORM_SUBMIT	Enum	O acionador é acionado quando o usuário responde a um formulário do Google.
ON_CHANGE	Enum	O acionador é acionado quando o usuário altera o arquivo do Planilhas Google (por exemplo, adicionando uma linha, o que conta como uma mudança em vez de uma edição).
ON_EVENT_UPDATED	Enum	O acionador é acionado quando um evento é criado, atualizado ou excluído no Google Agenda especificado.

FormTriggerBuilder

Métodos

Método	Tipo de retorno	Breve descrição
create()	Trigger	Cria e retorna o novo acionador.
onFormSubmit()	FormTriggerBuilder	Especifica um acionador que será acionado quando uma resposta for enviada ao formulário.
onOpen()	FormTriggerBuilder	Especifica um acionador que será acionado quando a visualização de edição do formulário for aberta.

InstallationSource

Propriedades

Propriedade	Tipo	Descrição
APPS_MARKETPLACE_DOMAIN_ADD_ON	Enum	O complemento foi instalado pelo administrador para o domínio do usuário.
NONE	Enum	O script não está sendo executado como um complemento.
WEB_STORE_ADD_ON	Enum	O complemento foi instalado pelo usuário na Chrome Web Store.

ScriptApp

Propriedades

Propriedade	Tipo	Descrição
AuthMode	AuthMode	Uma enumeração que identifica quais categorias de serviços autorizados o Apps Script pode executar usando uma função acionada.
AuthorizationStatus	AuthorizationStatus	Uma enumeração que indica o status de autorização de um script.
EventType	EventType	Uma enumeração que indica o tipo de evento acionado.
InstallationSource	InstallationSource	Uma enumeração que indica como o script foi instalado para o usuário como um complemento.
TriggerSource	TriggerSource	Uma enumeração que indica a origem do evento que aciona o acionador.
WeekDay	Weekday	Uma enumeração que representa os dias da semana.

Métodos

Método	Tipo de retorno	Breve descrição
deleteTrigger(trigger)	void	Remove o acionador especificado para que ele não seja mais executado.
getAuthorizationInfo(authMode)	AuthorizationInfo	Recebe um objeto que verifica se o usuário concedeu autorização para todos os requisitos do script.
getAuthorizationInfo(authMode, oAuthScopes)	AuthorizationInfo	Recebe um objeto que verifica se o usuário concedeu autorização para os escopos solicitados.
getIdentityToken()	String	Recebe um token de identidade do OpenID Connect para o usuário efetivo, se o escopo openid tiver sido concedido.
getInstallationSource()	InstallationSource	Retorna um valor de tipo enumerado que indica como o script foi instalado como um complemento para o usuário atual, por exemplo, se o usuário o instalou pessoalmente na Chrome Web Store ou se um administrador de domínio o instalou para todos os usuários.
getOAuthToken()	String	Recebe o token de acesso do OAuth 2.0 para o usuário efetivo.
getProjectTriggers()	Trigger[]	Recebe todos os acionadores instaláveis associados ao projeto e ao usuário atuais.
getScriptId()	String	Recebe o ID exclusivo do projeto do script.
getService()	Service	Recebe um objeto usado para controlar a publicação do script como um app da Web.
getUserTriggers(document)	Trigger[]	Recebe todos os acionadores instaláveis pertencentes a esse usuário no documento fornecido, apenas para esse script ou complemento.
getUserTriggers(form)	Trigger[]	Recebe todos os acionadores instaláveis pertencentes a esse usuário no formulário fornecido, apenas para esse script ou complemento.
getUserTriggers(spreadsheet)	Trigger[]	Recebe todos os acionadores instaláveis pertencentes a esse usuário na planilha especificada, apenas para este script ou complemento.
invalidateAuth()	void	Invalida a autorização que o usuário efetivo tem para executar o script atual.
newStateToken()	StateTokenBuilder	Cria um builder para um token de estado que pode ser usado em uma API de callback (como um fluxo OAuth).
newTrigger(functionName)	TriggerBuilder	Inicia o processo de criação de um acionador instalável que, quando acionado, chama uma determinada função.
requireAllScopes(authMode)	void	Valida se o usuário concedeu consentimento para todos os escopos solicitados pelo script.
requireScopes(authMode, oAuthScopes)	void	Valida se o usuário concedeu consentimento para os escopos solicitados.

Service

Métodos

Método	Tipo de retorno	Breve descrição
getUrl()	String	Retorna o URL do app da Web, se ele tiver sido implantado. Caso contrário, retorna null.
isEnabled()	Boolean	Retorna true se o script for acessível como um app da Web.

SpreadsheetTriggerBuilder

Métodos

Método	Tipo de retorno	Breve descrição
create()	Trigger	Cria e retorna o acionador.
onChange()	SpreadsheetTriggerBuilder	Especifica um acionador que será acionado quando o conteúdo ou a estrutura da planilha for alterado.
onEdit()	SpreadsheetTriggerBuilder	Especifica um acionador que será acionado quando a planilha for editada.
onFormSubmit()	SpreadsheetTriggerBuilder	Especifica um acionador que será acionado quando a planilha tiver um formulário enviado.
onOpen()	SpreadsheetTriggerBuilder	Especifica um acionador que será acionado quando a planilha for aberta.

StateTokenBuilder

Métodos

Método	Tipo de retorno	Breve descrição
createToken()	String	Cria uma representação de string criptografada do token de estado.
withArgument(name, value)	StateTokenBuilder	Adiciona um argumento ao token.
withMethod(method)	StateTokenBuilder	Define uma função de callback.
withTimeout(seconds)	StateTokenBuilder	Define a duração (em segundos) em que o token é válido.

Trigger

Métodos

Método	Tipo de retorno	Breve descrição
getEventType()	EventType	Retorna o tipo de evento em que o acionador é acionado.
getHandlerFunction()	String	Retorna a função que será chamada quando o acionador for acionado.
getTriggerSource()	TriggerSource	Retorna a origem dos eventos que vão acionar o acionador.
getTriggerSourceId()	String	Retorna o ID específico da fonte.
getUniqueId()	String	Retorna um identificador exclusivo que pode ser usado para distinguir gatilhos.

TriggerBuilder

Métodos

Método	Tipo de retorno	Breve descrição
forDocument(document)	DocumentTriggerBuilder	Cria e retorna um DocumentTriggerBuilder vinculado ao documento fornecido.
forDocument(key)	DocumentTriggerBuilder	Cria e retorna um DocumentTriggerBuilder vinculado ao documento com o ID fornecido.
forForm(form)	FormTriggerBuilder	Cria e retorna um FormTriggerBuilder vinculado ao formulário fornecido.
forForm(key)	FormTriggerBuilder	Cria e retorna um FormTriggerBuilder vinculado ao formulário com o ID fornecido.
forSpreadsheet(sheet)	SpreadsheetTriggerBuilder	Cria e retorna um SpreadsheetTriggerBuilder vinculado à planilha especificada.
forSpreadsheet(key)	SpreadsheetTriggerBuilder	Cria e retorna um SpreadsheetTriggerBuilder vinculado à planilha com o ID fornecido.
forUserCalendar(emailId)	CalendarTriggerBuilder	Retorna um builder para criar acionadores de calendário.
timeBased()	ClockTriggerBuilder	Cria e retorna um ClockTriggerBuilder para criar gatilhos baseados em tempo.

TriggerSource

Propriedades

Propriedade	Tipo	Descrição
SPREADSHEETS	Enum	O Google Planilhas dispara o acionador.
CLOCK	Enum	Um evento baseado em tempo faz com que o acionador seja acionado.
FORMS	Enum	O Google Formulários faz com que o acionador seja acionado.
DOCUMENTS	Enum	O Google Docs dispara o acionador.
CALENDAR	Enum	O Google Agenda faz com que o acionador seja acionado.