Class ScriptApp

Remove o gatilho especificado para que ele não seja mais executado.

// Deletes all triggers in the current project.
var triggers = ScriptApp.getProjectTriggers();
for (var i = 0; i < triggers.length; i++) {
  ScriptApp.deleteTrigger(triggers[i]);
}

Parâmetros

Nome	Tipo	Descrição
trigger	Trigger	O acionador a ser excluído.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/script.scriptapp

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. Se o script for publicado como um complemento que usa gatilhos instaláveis, essas informações poderão ser usadas para controlar o acesso a seções de código para as quais o usuário não tem a autorização necessária. Como alternativa, o complemento pode solicitar que o usuário abra o URL da caixa de diálogo de autorização para resolver o problema.

var authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
status = authInfo.getAuthorizationStatus();
url = authInfo.getAuthorizationUrl();

Parâmetros

Nome	Tipo	Descrição
authMode	AuthMode	modo de autorização para o qual as informações de autorização são solicitadas. Em quase todos os casos, o valor de authMode deve ser ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL), já que nenhum outro modo de autorização exige que os usuários concedam autorização

Retorno

AuthorizationInfo: um objeto que pode fornecer informações sobre o status de autorização do usuário.

Recebe um token de identidade do OpenID Connect para o usuário efetivo, se o escopo openid tiver sido concedido. Esse escopo não está incluído por padrão, e é necessário adicioná-lo como um escopo explícito no arquivo de manifesto para solicitá-lo. Inclua os escopos https://www.googleapis.com/auth/userinfo.email ou https://www.googleapis.com/auth/userinfo.profile para retornar mais informações do usuário no token.

O token de ID retornado é um JSON Web Token (JWT) codificado e precisa ser decodificado para extrair informações dele. Os exemplos a seguir mostram como decodificar o token e extrair o ID do perfil do Google do usuário efetivo.

var idToken = ScriptApp.getIdentityToken();
var body = idToken.split('.')[1];
var decoded = Utilities.newBlob(Utilities.base64Decode(body)).getDataAsString();
var payload = JSON.parse(decoded);
var profileId = payload.sub;
Logger.log('Profile ID: ' + profileId);

Consulte a documentação do OpenID Connect para conferir a lista completa dos campos (declarações) retornados.

Retorno

String: o token de identidade, se disponível. Caso contrário, null.

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.

Retorno

InstallationSource: a origem da instalação.

Recebe o token de acesso OAuth 2.0 do usuário efetivo. Se os escopos do OAuth do script forem suficientes para autorizar outra API do Google que normalmente exige o próprio fluxo do OAuth (como o Google Picker), os scripts podem ignorar o segundo prompt de autorização transmitindo esse token. O token expira após um tempo (alguns minutos, no mínimo). Os scripts precisam lidar com falhas de autorização e chamar esse método para receber um novo token quando necessário.

O token retornado por esse método inclui apenas os escopos de que o script precisa no momento. Os escopos que foram autorizados anteriormente, mas não são mais usados pelo script, não são incluídos no token retornado. Se outros escopos de OAuth forem necessários além do que o próprio script exige, eles podem ser especificados no arquivo de manifesto do script.

Retorno

String: uma representação de string do token OAuth 2.0.

Recebe todos os gatilhos instaláveis associados ao projeto atual e ao usuário atual.

Logger.log('Current project has ' + ScriptApp.getProjectTriggers().length + ' triggers.');

Retorno

Trigger[]: uma matriz dos gatilhos do usuário atual associados ao projeto.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/script.scriptapp

Recebe o ID exclusivo do projeto de script. Esse é o método preferencial para receber o identificador exclusivo do projeto de script, em vez de getProjectKey(). Esse ID pode ser usado em todos os lugares em que a chave do projeto foi fornecida anteriormente.

Retorno

String — ID do projeto de script.

Recebe um objeto usado para controlar a publicação do script como um app da Web.

// Get the URL of the published web app.
var url = ScriptApp.getService().getUrl();

Retorno

Service: um objeto usado para observar e controlar a publicação do script como um app da Web.

Recebe todos os acionadores instaláveis deste usuário no documento especificado, apenas para este script ou complemento. Esse método não pode ser usado para ver os acionadores anexados a outros scripts.

var doc = DocumentApp.getActiveDocument();
var triggers = ScriptApp.getUserTriggers(doc);
// Log the handler function for the first trigger in the array.
Logger.log(triggers[0].getHandlerFunction());

Parâmetros

Nome	Tipo	Descrição
document	Document	Um arquivo do Documentos Google que pode conter acionadores instaláveis.

Retorno

Trigger[]: uma matriz de acionadores de propriedade desse usuário no documento especificado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/script.scriptapp

Recebe todos os acionadores instaláveis deste usuário no formato fornecido, somente para este script ou complemento. Esse método não pode ser usado para ver os acionadores anexados a outros scripts.

var form = FormApp.getActiveForm();
var triggers = ScriptApp.getUserTriggers(form);
// Log the trigger source for the first trigger in the array.
Logger.log(triggers[0].getTriggerSource());

Parâmetros

Nome	Tipo	Descrição
form	Form	Um arquivo do Formulários Google que pode conter acionadores instaláveis.

Retorno

Trigger[]: uma matriz de acionadores de propriedade do usuário no formulário especificado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/script.scriptapp

Recebe todos os acionadores instaláveis que pertencem a esse usuário na planilha especificada, somente para este script ou complemento. Esse método não pode ser usado para ver os acionadores anexados a outros scripts.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var triggers = ScriptApp.getUserTriggers(ss);
// Log the event type for the first trigger in the array.
Logger.log(triggers[0].getEventType());

Parâmetros

Nome	Tipo	Descrição
spreadsheet	Spreadsheet	Um arquivo das Planilhas Google que pode conter acionadores instaláveis.

Retorno

Trigger[]: uma matriz de acionadores de propriedade desse usuário na planilha especificada.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/script.scriptapp

Invalida a autorização que o usuário em vigor tem para executar o script atual. Usado para invalidar qualquer permissão para o script atual. Isso é especialmente útil para funções marcadas como autorização one-shot. Como as funções de autorização one-shot só podem ser chamadas na primeira execução após o script receber a autorização, se você quiser executar uma ação depois, será necessário revogar qualquer autorização que o script tenha. Dessa forma, o usuário poderá ver a caixa de diálogo de autorização novamente.

ScriptApp.invalidateAuth();

Gera

Error: quando a invalidação falha.

Cria um builder para um token de estado que pode ser usado em uma API de callback (como um fluxo OAuth).

// Generate a callback URL, given the name of a callback function. The script does not need to
// be published as a web app; the /usercallback URL suffix replaces /edit in any script's URL.
function getCallbackURL(callbackFunction) {
  // IMPORTANT: Replace string below with the URL from your script, minus the /edit at the end.
  var scriptUrl = 'https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz';
  var urlSuffix = '/usercallback?state=';
  var stateToken = ScriptApp.newStateToken()
      .withMethod(callbackFunction)
      .withTimeout(120)
      .createToken();
  return scriptUrl + urlSuffix + stateToken;
}

Na maioria dos fluxos de OAuth2, o token state é transmitido diretamente para o endpoint de autorização (não como parte do URL de callback), e o endpoint de autorização o transmite como parte do URL de callback.

Exemplo:

• O script redireciona o usuário para o URL de autorização do OAuth2: https://accounts.google.com/o/oauth2/auth?state=token_generated_with_this_method&callback_uri=https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz/usercallback&other_oauth2_parameters
• O usuário clica em "Autorizar", e a página de autorização do OAuth2 o redireciona de volta para https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz/usercallback?state=token_generated_with_this_method&other_params_that_include_tokens_or_grants .
• O redirecionamento acima (de volta para http://script.google.com/...) faz com que a solicitação do navegador para /usercallback, que invoca o método especificado por StateTokenBuilder.withMethod(method).

Retorno

StateTokenBuilder: um objeto usado para continuar o processo de construção do token de estado.

Inicia o processo de criação de um gatilho instalável que, quando disparado, chama uma determinada função.

// Creates an edit trigger for a spreadsheet identified by ID.
ScriptApp.newTrigger('myFunction')
    .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3')
    .onEdit()
    .create();

Parâmetros

Nome	Tipo	Descrição
functionName	String	A função a ser chamada quando o acionador for disparado. Você pode usar funções de bibliotecas incluídas, como Library.libFunction1.

Retorno

TriggerBuilder: um objeto usado para continuar o processo de criação do acionador.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/script.scriptapp