Class TriggerBuilder

تریگر بیلدر

یک سازنده عمومی برای تریگرهای اسکریپت.

روش‌ها

روش نوع بازگشتی شرح مختصر
for Document(document) Document Trigger Builder یک Document Trigger Builder مرتبط با سند داده شده ایجاد و برمی‌گرداند.
for Document(key) Document Trigger Builder یک Document Trigger Builder مرتبط با سند با شناسه‌ی داده شده ایجاد و برمی‌گرداند.
for Form(form) Form Trigger Builder یک Form Trigger Builder مرتبط با فرم داده شده ایجاد و برمی‌گرداند.
for Form(key) Form Trigger Builder یک Form Trigger Builder مرتبط با فرم با شناسه داده شده ایجاد و برمی‌گرداند.
for Spreadsheet(sheet) Spreadsheet Trigger Builder یک Spreadsheet Trigger Builder مرتبط با صفحه گسترده‌ی داده شده ایجاد و برمی‌گرداند.
for Spreadsheet(key) Spreadsheet Trigger Builder یک Spreadsheet Trigger Builder مرتبط با صفحه گسترده با شناسه‌ی داده شده ایجاد و برمی‌گرداند.
for User Calendar(emailId) Calendar Trigger Builder یک سازنده برای ساخت محرک‌های تقویم برمی‌گرداند.
time Based() Clock Trigger Builder یک Clock Trigger Builder برای ساخت ماشه‌های مبتنی بر زمان ایجاد و برمی‌گرداند.

مستندات دقیق

forDocument(document)

یک DocumentTriggerBuilder مرتبط با سند داده شده ایجاد کرده و برمی‌گرداند.

ScriptApp.newTrigger('myFunction')
    .forDocument(DocumentApp.getActiveDocument())
    .onOpen()
    .create();

پارامترها

نام نوع توضیحات
document Document سند.

بازگشت

DocumentTriggerBuilder — سازنده‌ی جدید DocumentTriggerBuilder.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

forDocument(key)

یک DocumentTriggerBuilder مرتبط با سند با شناسه داده شده ایجاد و برمی‌گرداند.

ScriptApp.newTrigger('myFunction')
    .forDocument('1234567890abcdefghijklmnopqrstuvwxyz')
    .onOpen()
    .create();

پارامترها

نام نوع توضیحات
key String شناسه سند.

بازگشت

DocumentTriggerBuilder — سازنده‌ی جدید DocumentTriggerBuilder.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

forForm(form)

یک FormTriggerBuilder مرتبط با فرم داده شده ایجاد و برمی‌گرداند.

ScriptApp.newTrigger('myFunction')
    .forForm(FormApp.getActiveForm())
    .onFormSubmit()
    .create();

پارامترها

نام نوع توضیحات
form Form فرم.

بازگشت

FormTriggerBuilder - FormTriggerBuilder جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

forForm(key)

یک FormTriggerBuilder مرتبط با فرم با شناسه داده شده ایجاد و برمی‌گرداند.

ScriptApp.newTrigger('myFunction')
    .forForm('1234567890abcdefghijklmnopqrstuvwxyz')
    .onFormSubmit()
    .create();

پارامترها

نام نوع توضیحات
key String شناسه فرم.

بازگشت

FormTriggerBuilder - FormTriggerBuilder جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

forSpreadsheet(sheet)

یک SpreadsheetTriggerBuilder مرتبط با صفحه گسترده داده شده ایجاد و برمی‌گرداند.

ScriptApp.newTrigger('myFunction')
    .forSpreadsheet(SpreadsheetApp.getActive())
    .onEdit()
    .create();

پارامترها

نام نوع توضیحات
sheet Spreadsheet صفحه گسترده.

بازگشت

SpreadsheetTriggerBuilder — سازنده جدید SpreadsheetTrigger.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forSpreadsheet(key)

یک SpreadsheetTriggerBuilder متصل به صفحه گسترده با شناسه داده شده ایجاد و برمی‌گرداند.

ScriptApp.newTrigger('myFunction')
    .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz')
    .onEdit()
    .create();

پارامترها

نام نوع توضیحات
key String شناسه‌ی صفحه‌گسترده.

بازگشت

SpreadsheetTriggerBuilder — سازنده جدید SpreadsheetTrigger.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forUserCalendar(emailId)

یک سازنده برای ساخت محرک‌های تقویم برمی‌گرداند.

پارامترها

نام نوع توضیحات
email Id String شناسه ایمیل تقویم کاربری که تریگر آن را رصد می‌کند.

بازگشت

CalendarTriggerBuilder — CalendarTriggerBuilder جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.readonly
  • https://www.google.com/calendar/feeds

timeBased()

یک ClockTriggerBuilder برای ساخت تریگرهای مبتنی بر زمان ایجاد و برمی‌گرداند.

ScriptApp.newTrigger('myFunction').timeBased().atDate(2013, 10, 31).create();

بازگشت

ClockTriggerBuilder — ClockTriggerBuilder جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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