Class ScriptApp

Удаляет данный триггер, чтобы он больше не работал.

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

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

Получает объект, который проверяет, предоставил ли пользователь авторизацию для всех требований сценария. Объект также предоставляет пользователям URL-адрес авторизации для предоставления этих разрешений в случае, если какое-либо из требований сценария не авторизовано.

Выполнение некоторых сценариев может начаться без согласия пользователя для всех необходимых областей, используемых сценарием. Информация в этом объекте позволяет вам контролировать доступ к разделам кода, требующим определенных областей, и запрашивать авторизацию этих областей для последующих выполнения.

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

Параметры

Возвращаться

Authorization Info — объект, который может предоставить информацию о статусе авторизации пользователя.

Получает объект, который проверяет, предоставил ли пользователь авторизацию для запрошенных областей. Объект также предоставляет пользователям URL-адрес авторизации для предоставления этих разрешений в случае, если какая-либо из запрошенных областей не авторизована.

Выполнение некоторых сценариев может запускаться без согласия пользователя для всех необходимых областей, используемых сценарием. Информация в этом объекте позволяет вам контролировать доступ к разделам кода, требующим определенных областей, и запрашивать авторизацию этих областей для последующих выполнения. Недопустимые или не требуемые сценарием области приводят к ошибке.

const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [
  'https://www.googleapis.com/auth/documents',
  'https://www.googleapis.com/auth/presentations',
]);
const status = authInfo.getAuthorizationStatus();
const url = authInfo.getAuthorizationUrl();

Параметры

Возвращаться

Authorization Info — объект, который предоставляет информацию о статусе авторизации пользователя и URL-адрес авторизации в случае отсутствия некоторых согласий.

Получает токен удостоверения Open ID Connect для эффективного пользователя, если предоставлена ​​область openid . Эта область не включена по умолчанию, и для ее запроса необходимо добавить ее как явную область в файл манифеста. Включите области https://www.googleapis.com/auth/userinfo.email или https://www.googleapis.com/auth/userinfo.profile чтобы вернуть дополнительную информацию о пользователе в токене.

Возвращенный токен идентификатора представляет собой закодированный веб-токен JSON (JWT) , и его необходимо декодировать, чтобы извлечь из него информацию. В следующих примерах показано, как декодировать токен и извлечь эффективный идентификатор профиля Google пользователя.

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

Возвращаться

String — токен идентификации, если он доступен; в противном случае null .

Возвращает значение перечисления, указывающее, как скрипт был установлен в качестве дополнения для текущего пользователя (например, установил ли пользователь его лично через Интернет-магазин Chrome или администратор домена установил его для всех пользователей).

Возвращаться

Installation Source — источник установки.

Получает токен доступа OAuth 2.0 для эффективного пользователя. Если области OAuth сценария достаточны для авторизации другого API Google, которому обычно требуется собственный поток OAuth (например, Google Picker ), сценарии могут обойти второй запрос авторизации, передав вместо этого этот токен. Срок действия токена истекает через некоторое время (минимум несколько минут); сценарии должны обрабатывать ошибки авторизации и вызывать этот метод для получения нового токена при необходимости.

Токен, возвращаемый этим методом, включает только те области, которые в данный момент необходимы сценарию. Области, которые ранее были авторизованы, но больше не используются сценарием, не включаются в возвращаемый токен. Если необходимы дополнительные области OAuth помимо тех, которые требуются самому сценарию, их можно указать в файле манифеста сценария.

Возвращаться

String — строковое представление токена OAuth 2.0.

Получает все устанавливаемые триггеры, связанные с текущим проектом и текущим пользователем.

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

Возвращаться

Trigger[] — Массив триггеров текущего пользователя, связанных с этим проектом.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

Получает уникальный идентификатор проекта сценария. Это предпочтительный метод получения уникального идентификатора проекта сценария, а не get Project Key() . Этот идентификатор можно использовать везде, где ранее был указан ключ проекта.

Возвращаться

String — Идентификатор проекта скрипта.

Получает объект, используемый для управления публикацией сценария в виде веб-приложения.

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

Возвращаться

Service — объект, используемый для наблюдения и управления публикацией сценария в виде веб-приложения.

Получает все устанавливаемые триггеры, принадлежащие этому пользователю в данном документе, только для этого скрипта или надстройки. Этот метод нельзя использовать для просмотра триггеров, прикрепленных к другим сценариям.

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

Параметры

Возвращаться

Trigger[] — Массив триггеров, принадлежащих этому пользователю в данном документе.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

Получает все устанавливаемые триггеры, принадлежащие этому пользователю, в заданной форме, только для этого скрипта или надстройки. Этот метод нельзя использовать для просмотра триггеров, прикрепленных к другим сценариям.

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

Параметры

Возвращаться

Trigger[] — Массив триггеров, принадлежащих этому пользователю в заданной форме.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

Получает все устанавливаемые триггеры, принадлежащие этому пользователю в данной электронной таблице, только для этого скрипта или надстройки. Этот метод нельзя использовать для просмотра триггеров, прикрепленных к другим сценариям.

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

Параметры

Возвращаться

Trigger[] — Массив триггеров, принадлежащих этому пользователю в данной электронной таблице.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

Делает недействительными полномочия эффективного пользователя для выполнения текущего сценария. Используется для аннулирования любых разрешений для текущего сценария. Это особенно полезно для функций, помеченных как однократная авторизация. Поскольку функции однократной авторизации можно вызывать только при первом запуске после того, как сценарий получил авторизацию, если вы хотите выполнить какое-либо действие впоследствии, вы должны отозвать все авторизации, которые были у сценария, чтобы пользователь мог снова увидеть диалоговое окно авторизации.

ScriptApp.invalidateAuth();

Броски

Error — когда недействительность не удалась

Создает построитель для токена состояния, который можно использовать в API обратного вызова (например, в потоке 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;
}

В большинстве потоков OAuth2 токен state передается конечной точке авторизации напрямую (а не как часть URL-адреса обратного вызова), а конечная точка авторизации затем передает его как часть URL-адреса обратного вызова.

Например:

• Скрипт перенаправляет пользователя на URL-адрес авторизации 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
• Пользователь нажимает «Авторизовать», и страница авторизации OAuth2 перенаправляет пользователя обратно на https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz/usercallback?state=token_generated_with_this_method&other_params_that_include_tokens_or_grants
• Приведенное выше перенаправление (обратно на http://script.google.com/... ) вызывает запрос браузера к /usercallback , который вызывает метод, указанный State Token Builder.withMethod(method) .

Возвращаться

State Token Builder — объект, используемый для продолжения процесса создания State Token Builder.

Начинает процесс создания устанавливаемого триггера, который при срабатывании вызывает заданную функцию.

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

Параметры

Возвращаться

Trigger Builder — объект, используемый для продолжения процесса создания триггера.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

Проверяет, предоставил ли пользователь согласие на все области, запрошенные сценарием. Используйте этот метод, если поток выполнения зависит от всех областей, запрашиваемых сценарием. Если какие-либо согласия отсутствуют, этот метод завершает текущее выполнение и отображает запрос авторизации для запроса отсутствующих согласий.

Этот метод работает только в том случае, если пользователи запускают сценарий из среды, поддерживающей детальное согласие, например из среды разработки сценариев приложений. Если сценарий запускается с отсутствующими согласиями из неподдерживаемой поверхности, например из надстройки Google Workspace, в начале выполнения сценарий отображает запрос на авторизацию для запроса всех областей.

ScriptApp.requireAllScopes(ScriptApp.AuthMode.FULL);

Параметры

Проверяет, предоставил ли пользователь согласие на запрошенные области. Используйте этот метод, если поток выполнения зависит от одной или нескольких служб. Если какое-либо из указанных согласий отсутствует, этот метод завершает текущее выполнение и отображает запрос авторизации для запроса отсутствующих согласий. Недопустимые или не требуемые сценарием области приводят к ошибке.

Этот метод работает только в том случае, если пользователи запускают сценарий из среды, поддерживающей детальное согласие, например из среды разработки сценариев приложений. Если сценарий запускается с отсутствующими согласиями из неподдерживаемой поверхности, например из надстройки Google Workspace, в начале выполнения сценарий отображает запрос на авторизацию для запроса всех областей.

ScriptApp.requireScopes(ScriptApp.AuthMode.FULL, [
  'https://www.googleapis.com/auth/documents',
  'https://www.googleapis.com/auth/presentations',
]);

Параметры