Class ScriptApp

Quita el activador determinado para que ya no se ejecute.

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

Parámetros

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

Obtiene un objeto que se usa para determinar si el usuario debe autorizar esta secuencia de comandos para usar uno o más servicios y proporcionar la URL de un diálogo de autorización. Si la secuencia de comandos se publica como un complemento que usa activadores instalables, esta información se puede usar para controlar el acceso a secciones de código para las que el usuario no tiene la autorización necesaria. Como alternativa, el complemento puede pedirle al usuario que abra la URL del diálogo de autorización para resolver el problema.

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

Parámetros

Volver

AuthorizationInfo: Es un objeto que puede proporcionar información sobre el estado de autorización del usuario.

Obtiene un token de identidad de OpenID Connect para el usuario efectivo, si se otorgó el permiso openid. Este alcance no se incluye de forma predeterminada y debes agregarlo como un alcance explícito en el archivo de manifiesto para solicitarlo. Incluye los permisos https://www.googleapis.com/auth/userinfo.email o https://www.googleapis.com/auth/userinfo.profile para mostrar información adicional del usuario en el token.

El token de ID que se muestra es un token web JSON (JWT) codificado y se debe decodificar para extraer información. En los siguientes ejemplos, se muestra cómo decodificar el token y extraer el ID de perfil de Google del usuario efectivo.

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}`);

Volver

String: Es el token de identidad si está disponible; de lo contrario, es null.

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 de dominio la instaló para todos los usuarios).

Volver

InstallationSource: Es la fuente de la instalación.

Obtiene el token de acceso de OAuth 2.0 para el usuario efectivo. Si los permisos de OAuth de la secuencia de comandos son suficientes para autorizar a otra API de Google que normalmente requiere su propio flujo de OAuth (como el Selector de Google), las secuencias de comandos pueden omitir la segunda solicitud de autorización pasando este token en su lugar. El token vence después de un tiempo (algunos minutos como mínimo). Las secuencias de comandos deben controlar las fallas de autorización y llamar a este método para obtener un token nuevo cuando sea necesario.

El token que muestra este método solo incluye los permisos que la secuencia de comandos necesita actualmente. Los permisos que se autorizaron anteriormente, pero que la secuencia de comandos ya no usa, no se incluyen en el token que se muestra. Si se necesitan permisos de OAuth adicionales más allá de los que requiere la secuencia de comandos, se pueden especificar en el archivo de manifiesto de la secuencia de comandos.

Volver

String: Es una representación de cadena del token de OAuth 2.0.

Obtiene todos los activadores instalables asociados con el proyecto y el usuario actuales.

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

Volver

Trigger[]: Es un array de los activadores del usuario actual asociados con este proyecto.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

Obtiene el ID único del proyecto de secuencia de comandos. Este es el método preferido para obtener el identificador único del proyecto de secuencia de comandos en lugar de getProjectKey(). Este ID se puede usar en todos los lugares en los que se proporcionó la clave del proyecto anteriormente.

Volver

String: Es el ID del proyecto de secuencia de comandos.

Obtiene un objeto que se usa para controlar la publicación de la secuencia de comandos como una app web.

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

Volver

Service: Es un objeto que se usa para observar y controlar la publicación de la secuencia de comandos como una app web.

Obtiene todos los activadores instalables que pertenecen a este usuario en el documento determinado, solo para esta secuencia de comandos o complemento. No se puede usar este método para ver los activadores adjuntos a otras secuencias de comandos.

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());

Parámetros

Volver

Trigger[]: Es un array de activadores que pertenecen a este usuario en el documento determinado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

Obtiene todos los activadores instalables que son propiedad de este usuario en el formulario determinado, solo para esta secuencia de comandos o este complemento. No se puede usar este método para ver los activadores adjuntos a otras secuencias de comandos.

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());

Parámetros

Volver

Trigger[]: Es un array de activadores que pertenecen a este usuario en el formulario determinado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

Obtiene todos los activadores instalables que pertenecen a este usuario en la hoja de cálculo determinada, solo para esta secuencia de comandos o este complemento. No se puede usar este método para ver los activadores adjuntos a otras secuencias de comandos.

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());

Parámetros

Volver

Trigger[]: Es un array de activadores que pertenecen a este usuario en la hoja de cálculo determinada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

Invalida la autorización que tiene el usuario efectivo para ejecutar la secuencia de comandos actual. Se usa para invalidar cualquier permiso de la secuencia de comandos actual. Esto es especialmente útil para las funciones que están etiquetadas como autorizaciones únicas. Dado que solo se puede llamar a las funciones de autorización única en la primera ejecución después de que la secuencia de comandos haya adquirido la autorización, si deseas realizar una acción más adelante, debes revocar cualquier autorización que haya tenido la secuencia de comandos para que el usuario pueda volver a ver el diálogo de autorización.

ScriptApp.invalidateAuth();

Arroja

Error: Cuando falla la invalidación

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).

// 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;
}

En la mayoría de los flujos de OAuth2, el token state se pasa directamente al extremo de autorización (no como parte de la URL de devolución de llamada) y, luego, el extremo de autorización lo pasa como parte de la URL de devolución de llamada.

Por ejemplo:

• La secuencia de comandos redirecciona al usuario a la URL de autorización de 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
• El usuario hace clic en Autorizar y la página de autorización de OAuth2 lo redirecciona a https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz/usercallback?state=token_generated_with_this_method&other_params_that_include_tokens_or_grants .
• El redireccionamiento anterior (de vuelta a http://script.google.com/...) hace que el navegador realice una solicitud a /usercallback, que invoca el método especificado por StateTokenBuilder.withMethod(method).

Volver

StateTokenBuilder: Es un objeto que se usa para continuar el proceso de compilación de tokens de estado.

Inicia el proceso de creación de un activador instalable que, cuando se activa, llama a una función determinada.

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

Parámetros

Volver

TriggerBuilder: Es un objeto que se usa para continuar el proceso de compilación del activador.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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