Class ScriptApp

Rimuove l'attivatore specificato in modo che non venga più eseguito.

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

Parametri

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Recupera un oggetto utilizzato per determinare se l'utente deve autorizzare questo script a utilizzare uno o più servizi e per fornire l'URL di una finestra di dialogo di autorizzazione. Se lo script viene pubblicato come componente aggiuntivo che utilizza attivatori installabili, queste informazioni possono essere utilizzate per controllare l'accesso a sezioni di codice per le quali l'utente non dispone dell'autorizzazione necessaria. In alternativa, il componente aggiuntivo può chiedere all'utente di aprire l'URL della finestra di dialogo di autorizzazione per risolvere il problema.

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

Parametri

Invio

AuthorizationInfo: un oggetto che può fornire informazioni sullo stato dell'autorizzazione dell'utente

Recupera un token di identità OpenID Connect per l'utente effettivo, se è stato concesso l'ambito openid. Questo ambito non è incluso per impostazione predefinita e devi aggiungerlo come ambito esplicito nel file manifest per richiederlo. Includi gli ambiti https://www.googleapis.com/auth/userinfo.email o https://www.googleapis.com/auth/userinfo.profile per restituire nel token informazioni aggiuntive sull'utente.

Il token ID restituito è un token web JSON (JWT) codificato e deve essere decodificato per estrarne le informazioni. Gli esempi riportati di seguito mostrano come decodificare il token ed estrarre l'ID profilo Google dell'utente effettivo.

const idToken = ScriptApp.getIdentityToken();
const body = idToken.split('.')[1];
const decoded = Utilities
                    .newBlob(
                        Utilities.base64Decode(body),
                        )
                    .getDataAsString();
const payload = JSON.parse(decoded);

Logger.log(`Profile ID: ${payload.sub}`);

Invio

String: il token di identità, se disponibile; in caso contrario, null.

Restituisce un valore enum che indica in che modo lo script è stato installato come componente aggiuntivo per l'utente corrente (ad esempio, se l'utente lo ha installato personalmente tramite il Chrome Web Store o se un amministratore di dominio lo ha installato per tutti gli utenti).

Invio

InstallationSource: l'origine dell'installazione.

Recupera il token di accesso OAuth 2.0 per l'utente effettivo. Se gli ambiti OAuth dello script sono sufficienti per autorizzare un'altra API di Google che normalmente richiede il proprio flusso OAuth (ad esempio Google Picker), gli script possono bypassare la seconda richiesta di autorizzazione passando questo token. Il token scade dopo un determinato periodo di tempo (almeno alcuni minuti); gli script devono gestire gli errori di autorizzazione e chiamare questo metodo per ottenere un nuovo token in caso di necessità.

Il token restituito da questo metodo include solo gli ambiti di cui lo script ha attualmente bisogno. Gli ambiti che sono stati precedentemente autorizzati, ma non sono più utilizzati dallo script, non sono inclusi nel token restituito. Se sono necessari ambiti OAuth aggiuntivi rispetto a quelli richiesti dallo script stesso, possono essere specificati nel file manifest dello script.

Invio

String: una rappresentazione stringa del token OAuth 2.0.

Recupera tutti gli attivatori installabili associati al progetto e all'utente corrente.

Logger.log(
    `Current project has ${ScriptApp.getProjectTriggers().length} triggers.`,
);

Invio

Trigger[]: un array degli attivatori dell'utente corrente associati a questo progetto.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Recupera l'ID univoco del progetto di script. Questo è il metodo preferito per ottenere l'identificatore univoco per il progetto di script rispetto a getProjectKey(). Questo ID può essere utilizzato in tutti i luoghi dove è stata precedentemente fornita la chiave del progetto.

Invio

String: l'ID del progetto di script.

Restituisce un oggetto utilizzato per controllare la pubblicazione dello script come app web.

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

Invio

Service: un oggetto utilizzato per osservare e controllare la pubblicazione dello script come app web.

Recupera tutti gli attivatori installabili di proprietà di questo utente nel documento specificato, solo per questo script o componente aggiuntivo. Questo metodo non può essere utilizzato per visualizzare gli attivatori associati ad altri script.

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

Parametri

Invio

Trigger[]: un array di attivatori di proprietà di questo utente nel documento specificato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Recupera tutti gli attivatori installabili di proprietà di questo utente nel modulo specificato, solo per questo script o componente aggiuntivo. Questo metodo non può essere utilizzato per visualizzare gli attivatori associati ad altri script.

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

Parametri

Invio

Trigger[]: un array di attivatori di proprietà di questo utente nel modulo specificato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Recupera tutti gli attivatori installabili di proprietà di questo utente nel foglio di lavoro specificato, solo per questo script o plug-in. Questo metodo non può essere utilizzato per visualizzare gli attivatori associati ad altri script.

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

Parametri

Invio

Trigger[]: un array di attivatori di proprietà di questo utente nel foglio di lavoro specificato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Annullamento dell'autorizzazione di cui l'utente effettivo dispone per eseguire lo script corrente. Viene utilizzato per invalidare eventuali autorizzazioni per lo script corrente. Questo è particolarmente utile per le funzioni помеченные come autorizzazione una tantum. Poiché le funzioni di autorizzazione una tantum possono essere chiamate solo la prima volta che lo script acquisisce l'autorizzazione, se vuoi eseguire un'azione in un secondo momento, devi revocare qualsiasi autorizzazione dello script in modo che l'utente possa visualizzare di nuovo la finestra di dialogo di autorizzazione.

ScriptApp.invalidateAuth();

Lanci

Error: quando l'annullamento non va a buon fine

Crea un generatore per un token di stato che può essere utilizzato in un'API di callback (ad esempio un flusso 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.
  const scriptUrl =
      'https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz';
  const urlSuffix = '/usercallback?state=';
  const stateToken = ScriptApp.newStateToken()
                         .withMethod(callbackFunction)
                         .withTimeout(120)
                         .createToken();
  return scriptUrl + urlSuffix + stateToken;
}

Nella maggior parte dei flussi OAuth2, il token state viene passato direttamente all'endpoint di autorizzazione (non nell'URL di callback) e poi quest'ultimo lo passa nell'URL di callback.

Ad esempio:

• Lo script reindirizza l'utente all'URL di autorizzazione 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
• L'utente fa clic su Autorizza e la pagina di autorizzazione OAuth2 lo reindirizza nuovamente a https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz/usercallback?state=token_generated_with_this_method&other_params_that_include_tokens_or_grants
• Il reindirizzamento sopra riportato (indietro a http://script.google.com/...) fa sì che il browser effettui una richiesta a /usercallback, che invoca il metodo specificato da StateTokenBuilder.withMethod(method).

Invio

StateTokenBuilder: un oggetto utilizzato per continuare la procedura di creazione del token dello stato.

Avvia il processo di creazione di un trigger installabile che, quando viene attivato, chiama una determinata funzione.

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

Parametri

Invio

TriggerBuilder: un oggetto utilizzato per continuare la procedura di creazione dell'attivatore.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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