Esta página foi traduzida pela API Cloud Translation.

Switch to English

Script Service

Este serviço fornece acesso a gatilhos e publicação de scripts.

Aulas

Nome	Breve descrição
`AuthMode`	Uma enumeração que identifica quais categorias de serviços autorizados o Apps Script podem executar com uma função acionada.
`AuthorizationInfo`	Um objeto usado para determinar se o usuário precisa autorizar esse script a usar um ou mais serviços e fornecer o URL de uma caixa de diálogo de autorização.
`AuthorizationStatus`	Uma enumeração que indica o status de autorização de um script.
`CalendarTriggerBuilder`	Builder para acionadores da agenda.
`ClockTriggerBuilder`	Um builder para gatilhos de relógio.
`DocumentTriggerBuilder`	Um builder para acionadores 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 acionadores de scripts.
`Service`	Acessar e manipular a publicação de scripts.
`SpreadsheetTriggerBuilder`	Builder para acionadores de planilhas.
`StateTokenBuilder`	Permite que os scripts criem tokens de estado que podem ser usados em APIs de callback (como fluxos do 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 faz com que o acionador seja disparado.

`AuthMode`

Propriedades

Propriedade	Tipo	Descrição
`NONE`	`Enum`	Um modo que não permite acesso a nenhum serviço que exige autorização.
`CUSTOM_FUNCTION`	`Enum`	Um modo que permite acesso a um subconjunto limitado de serviços para uso em funções de planilhas personalizadas.
`LIMITED`	`Enum`	Um modo que permite acesso a um subconjunto limitado de serviços.
`FULL`	`Enum`	Um modo que dá 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 a usar um ou mais serviços (por exemplo, `ScriptApp.AuthorizationStatus.REQUIRED`).
`getAuthorizationUrl()`	`String`	Extrai o URL de autorização que pode ser usado para conceder acesso ao 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 toda a autorização necessária no momento.

`CalendarTriggerBuilder`

Métodos

Método	Tipo de retorno	Breve descrição
`create()`	`Trigger`	Cria o gatilho e o retorna.
`onEventUpdated()`	`CalendarTriggerBuilder`	Especifica um acionador que é disparado quando uma entrada da agenda é 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 gatilho é executado.
`atDate(year, month, day)`	`ClockTriggerBuilder`	Especifica que o acionador será disparado na data especificada, por padrão, perto da meia-noite (+/- 15 minutos).
`atHour(hour)`	`ClockTriggerBuilder`	Especifica a hora em que o gatilho é executado.
`create()`	`Trigger`	Cria o gatilho.
`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 gatilho 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 das 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 no 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 gatilho.
`onOpen()`	`DocumentTriggerBuilder`	Especifica um acionador que será disparado quando o documento for aberto.

`EventType`

Propriedades

Propriedade	Tipo	Descrição
`CLOCK`	`Enum`	O acionador é disparado quando o evento baseado em tempo atinge um horário específico.
`ON_OPEN`	`Enum`	O acionador é disparado quando o usuário abre o arquivo do Documentos, Planilhas ou Formulários Google.
`ON_EDIT`	`Enum`	O acionador é disparado quando o usuário edita o arquivo das Planilhas Google (por exemplo, ao inserir um novo valor em uma célula, que é contabilizado como uma edição, e não uma alteração).
`ON_FORM_SUBMIT`	`Enum`	O acionador é disparado quando o usuário responde a um arquivo dos Formulários Google.
`ON_CHANGE`	`Enum`	O acionador é disparado quando o usuário altera o arquivo do Planilhas Google (por exemplo, adicionando uma linha, o que conta como uma alteração, e não uma edição).
`ON_EVENT_UPDATED`	`Enum`	O acionador é disparado 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 gatilho.
`onFormSubmit()`	`FormTriggerBuilder`	Especifica um acionador que será disparado quando uma resposta for enviada ao formulário.
`onOpen()`	`FormTriggerBuilder`	Especifica um acionador que será disparado 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 pela 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 podem executar com 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 faz com que o acionador seja disparado.
`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 gatilho especificado para que ele não seja mais executado.
`getAuthorizationInfo(authMode)`	`AuthorizationInfo`	Recebe um objeto usado para determinar se o usuário precisa autorizar esse script a usar um ou mais serviços e fornecer o URL para uma caixa de diálogo de autorização.
`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 enumeração que indica como o script foi instalado como um complemento para o usuário atual. Por exemplo, se o usuário o instalou pessoalmente pela Chrome Web Store ou se um administrador do domínio o instalou para todos os usuários.
`getOAuthToken()`	`String`	Recebe o token de acesso OAuth 2.0 do usuário efetivo.
`getProjectTriggers()`	`Trigger[]`	Recebe todos os gatilhos instaláveis associados ao projeto atual e ao usuário atual.
`getScriptId()`	`String`	Recebe o ID exclusivo do projeto de 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 deste usuário no documento especificado, apenas para este script ou complemento.
`getUserTriggers(form)`	`Trigger[]`	Recebe todos os acionadores instaláveis deste usuário no formato fornecido, somente para este script ou complemento.
`getUserTriggers(spreadsheet)`	`Trigger[]`	Recebe todos os acionadores instaláveis que pertencem a esse usuário na planilha especificada, somente para este script ou complemento.
`invalidateAuth()`	`void`	Invalida a autorização que o usuário em vigor 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 gatilho instalável que, quando disparado, chama uma determinada função.

`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 o gatilho e o retorna.
`onChange()`	`SpreadsheetTriggerBuilder`	Especifica um acionador que será disparado quando o conteúdo ou a estrutura da planilha for alterado.
`onEdit()`	`SpreadsheetTriggerBuilder`	Especifica um acionador que será disparado quando a planilha for editada.
`onFormSubmit()`	`SpreadsheetTriggerBuilder`	Especifica um acionador que será disparado quando a planilha receber um formulário.
`onOpen()`	`SpreadsheetTriggerBuilder`	Especifica um acionador que será disparado quando a planilha for aberta.

`StateTokenBuilder`

Métodos

Método	Tipo de retorno	Breve descrição
`createToken()`	`String`	Constrói 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) pela qual 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 é disparado.
`getHandlerFunction()`	`String`	Retorna a função que será chamada quando o acionador for disparado.
`getTriggerSource()`	`TriggerSource`	Retorna a origem dos eventos que farão com que o acionador seja disparado.
`getTriggerSourceId()`	`String`	Retorna o ID específico da fonte.
`getUniqueId()`	`String`	Retorna um identificador exclusivo que pode ser usado para distinguir acionadores entre si.

`TriggerBuilder`

Métodos

Método	Tipo de retorno	Breve descrição
`forDocument(document)`	`DocumentTriggerBuilder`	Cria e retorna um `DocumentTriggerBuilder` vinculado ao documento especificado.
`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 especificado.
`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 da agenda.
`timeBased()`	`ClockTriggerBuilder`	Cria e retorna um `ClockTriggerBuilder` para criar gatilhos baseados em tempo.

`TriggerSource`

Propriedades

Propriedade	Tipo	Descrição
`SPREADSHEETS`	`Enum`	O app Planilhas Google dispara o acionador.
`CLOCK`	`Enum`	Um evento orientado por tempo faz com que o acionador seja disparado.
`FORMS`	`Enum`	O app Formulários Google faz com que o acionador seja disparado.
`DOCUMENTS`	`Enum`	O Documentos Google faz com que o acionador seja disparado.
`CALENDAR`	`Enum`	O Google Agenda faz com que o acionador seja disparado.

Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.

Última atualização 2023-12-01 UTC.

Blog
Leia o blog para desenvolvedores do Google Workspace
Stack Overflow
Faça uma pergunta usando a tag google-apps-script
Exemplos de código
Explore nossos exemplos de código ou os copie para criar o seu
Vídeos
Assista aos tutoriais do Apps Script