Script Service

Script

Dịch vụ này cung cấp quyền truy cập vào các trình kích hoạt tập lệnh và xuất bản tập lệnh.

Lớp

TênMô tả ngắn
AuthModeMột bảng liệt kê xác định những danh mục dịch vụ được ủy quyền mà Apps Script có thể thực thi thông qua một hàm đã kích hoạt.
AuthorizationInfoMột đối tượng dùng để xác định xem người dùng có cần uỷ quyền cho tập lệnh này sử dụng một hoặc nhiều dịch vụ hay không, đồng thời cung cấp URL cho hộp thoại uỷ quyền.
AuthorizationStatusMột bảng liệt kê biểu thị trạng thái uỷ quyền của một tập lệnh.
CalendarTriggerBuilderTrình tạo cho trình kích hoạt lịch.
ClockTriggerBuilderTrình tạo cho các trình kích hoạt đồng hồ.
DocumentTriggerBuilderTrình tạo cho trình kích hoạt tài liệu.
EventTypeMột bảng liệt kê biểu thị loại sự kiện đã kích hoạt.
FormTriggerBuilderTrình tạo cho trình kích hoạt biểu mẫu.
InstallationSourceMột bảng liệt kê cho biết cách cài đặt tập lệnh dưới dạng tiện ích bổ sung cho người dùng hiện tại.
ScriptAppTruy cập và thao tác với tính năng xuất bản và kích hoạt tập lệnh.
ServiceTruy cập và thao tác với tính năng xuất bản tập lệnh.
SpreadsheetTriggerBuilderTrình tạo cho trình kích hoạt bảng tính.
StateTokenBuilderCho phép tập lệnh tạo mã thông báo trạng thái có thể được sử dụng trong API gọi lại (như quy trình OAuth).
TriggerSự kiện kích hoạt tập lệnh.
TriggerBuilderTrình tạo chung cho các trình kích hoạt tập lệnh.
TriggerSourceMột bảng liệt kê biểu thị nguồn của sự kiện khiến trình kích hoạt kích hoạt.

AuthMode

Thuộc tính

Thuộc tínhLoạiMô tả
NONEEnumMột chế độ không cho phép truy cập vào bất kỳ dịch vụ nào cần được cho phép.
CUSTOM_FUNCTIONEnumMột chế độ cho phép truy cập vào một nhóm nhỏ dịch vụ để sử dụng trong các hàm bảng tính tuỳ chỉnh.
LIMITEDEnumMột chế độ cho phép truy cập vào một nhóm nhỏ dịch vụ bị giới hạn.
FULLEnumMột chế độ cho phép truy cập vào tất cả các dịch vụ yêu cầu ủy quyền.

AuthorizationInfo

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
getAuthorizationStatus()AuthorizationStatusNhận giá trị cho biết liệu người dùng có cần ủy quyền cho tập lệnh này sử dụng một hoặc nhiều dịch vụ hay không (ví dụ: ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()StringLấy URL ủy quyền có thể dùng để cấp quyền truy cập vào tập lệnh.

AuthorizationStatus

Thuộc tính

Thuộc tínhLoạiMô tả
REQUIREDEnumNgười dùng cần uỷ quyền cho tập lệnh này sử dụng một hoặc nhiều dịch vụ.
NOT_REQUIREDEnumNgười dùng đã cấp tập lệnh này tất cả quyền được tập lệnh hiện yêu cầu.

CalendarTriggerBuilder

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
create()TriggerTạo trình kích hoạt và trả về trình kích hoạt.
onEventUpdated()CalendarTriggerBuilderChỉ định trình kích hoạt sẽ kích hoạt khi một mục trên lịch được tạo, cập nhật hoặc xóa.

ClockTriggerBuilder

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
after(durationMilliseconds)ClockTriggerBuilderChỉ định thời lượng tối thiểu (tính bằng mili giây) sau thời gian hiện tại mà trình kích hoạt chạy.
at(date)ClockTriggerBuilderChỉ định thời điểm trình kích hoạt chạy.
atDate(year, month, day)ClockTriggerBuilderChỉ định rằng trình kích hoạt sẽ kích hoạt vào một ngày nhất định theo mặc định, gần nửa đêm (+/- 15 phút).
atHour(hour)ClockTriggerBuilderChỉ định giờ mà trình kích hoạt chạy.
create()TriggerTạo trình kích hoạt.
everyDays(n)ClockTriggerBuilderChỉ định chạy trình kích hoạt n ngày một lần.
everyHours(n)ClockTriggerBuilderChỉ định chạy trình kích hoạt này n giờ một lần.
everyMinutes(n)ClockTriggerBuilderChỉ định chạy trình kích hoạt này n phút một lần.
everyWeeks(n)ClockTriggerBuilderChỉ định chạy trình kích hoạt này n tuần một lần.
inTimezone(timezone)ClockTriggerBuilderChỉ định múi giờ cho ngày/giờ được chỉ định khi trình kích hoạt chạy.
nearMinute(minute)ClockTriggerBuilderChỉ định phút mà trình kích hoạt chạy (cộng hoặc trừ 15 phút).
onMonthDay(day)ClockTriggerBuilderChỉ định ngày trong tháng mà trình kích hoạt chạy.
onWeekDay(day)ClockTriggerBuilderChỉ định ngày trong tuần mà trình kích hoạt chạy.

DocumentTriggerBuilder

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
create()TriggerTạo và trả về trình kích hoạt mới.
onOpen()DocumentTriggerBuilderChỉ định một trình kích hoạt sẽ kích hoạt khi mở tài liệu.

EventType

Thuộc tính

Thuộc tínhLoạiMô tả
CLOCKEnumTrình kích hoạt sẽ kích hoạt khi sự kiện theo thời gian đạt đến một thời điểm cụ thể.
ON_OPENEnumTrình kích hoạt sẽ kích hoạt sau khi người dùng mở tệp Google Tài liệu, Trang tính hoặc Biểu mẫu.
ON_EDITEnumTrình kích hoạt sẽ kích hoạt sau khi người dùng chỉnh sửa tệp Google Trang tính (ví dụ: bằng cách nhập giá trị mới vào một ô, được tính là một lượt chỉnh sửa thay vì một thay đổi).
ON_FORM_SUBMITEnumTrình kích hoạt sẽ kích hoạt sau khi người dùng trả lời Google Biểu mẫu.
ON_CHANGEEnumTrình kích hoạt sẽ kích hoạt sau khi người dùng thay đổi tệp Google Trang tính (ví dụ: bằng cách thêm một hàng được tính là một thay đổi thay vì chỉnh sửa).
ON_EVENT_UPDATEDEnumTrình kích hoạt sẽ kích hoạt sau khi một sự kiện được tạo, cập nhật hoặc xoá trên Lịch Google đã chỉ định.

FormTriggerBuilder

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
create()TriggerTạo và trả về trình kích hoạt mới.
onFormSubmit()FormTriggerBuilderChỉ định một trình kích hoạt sẽ kích hoạt khi một phản hồi được gửi đến biểu mẫu.
onOpen()FormTriggerBuilderChỉ định một trình kích hoạt sẽ kích hoạt khi chế độ xem chỉnh sửa của biểu mẫu được mở.

InstallationSource

Thuộc tính

Thuộc tínhLoạiMô tả
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumQuản trị viên đã cài đặt tiện ích bổ sung cho miền của người dùng.
NONEEnumTập lệnh không chạy dưới dạng tiện ích bổ sung.
WEB_STORE_ADD_ONEnumTiện ích bổ sung do người dùng cài đặt từ Cửa hàng Chrome trực tuyến.

ScriptApp

Thuộc tính

Thuộc tínhLoạiMô tả
AuthModeAuthModeMột bảng liệt kê xác định những danh mục dịch vụ được ủy quyền mà Apps Script có thể thực thi thông qua một hàm đã kích hoạt.
AuthorizationStatusAuthorizationStatusMột bảng liệt kê biểu thị trạng thái uỷ quyền của một tập lệnh.
EventTypeEventTypeMột bảng liệt kê biểu thị loại sự kiện đã kích hoạt.
InstallationSourceInstallationSourceMột bảng liệt kê biểu thị cách cài đặt tập lệnh cho người dùng dưới dạng tiện ích bổ sung.
TriggerSourceTriggerSourceMột bảng liệt kê biểu thị nguồn của sự kiện khiến trình kích hoạt kích hoạt.
WeekDayWeekdayMột bảng liệt kê biểu thị các ngày trong tuần.

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
deleteTrigger(trigger)voidXoá trình kích hoạt đã cho để không còn chạy nữa.
getAuthorizationInfo(authMode)AuthorizationInfoLấy đối tượng dùng để xác định xem người dùng có cần uỷ quyền cho tập lệnh này sử dụng một hoặc nhiều dịch vụ hay không, đồng thời cung cấp URL cho hộp thoại uỷ quyền.
getIdentityToken()StringLấy mã thông báo nhận dạng OpenID Connect cho người dùng hiệu quả, nếu phạm vi openid đã được cấp.
getInstallationSource()InstallationSourceTrả về giá trị enum cho biết cách cài đặt tập lệnh dưới dạng tiện ích bổ sung cho người dùng hiện tại (ví dụ: liệu người dùng đã cài đặt riêng tập lệnh đó thông qua Cửa hàng Chrome trực tuyến hay quản trị viên miền đã cài đặt tập lệnh cho tất cả người dùng).
getOAuthToken()StringLấy mã truy cập OAuth 2.0 cho người dùng hiệu quả.
getProjectTriggers()Trigger[]Lấy tất cả các trình kích hoạt có thể cài đặt được liên kết với dự án hiện tại và người dùng hiện tại.
getScriptId()StringLấy mã nhận dạng duy nhất của dự án tập lệnh.
getService()ServiceLấy đối tượng dùng để kiểm soát việc xuất bản tập lệnh dưới dạng ứng dụng web.
getUserTriggers(document)Trigger[]Lấy tất cả trình kích hoạt có thể cài đặt do người dùng này sở hữu trong tài liệu nhất định, chỉ dành cho tập lệnh hoặc tiện ích bổ sung này.
getUserTriggers(form)Trigger[]Lấy tất cả các trình kích hoạt có thể cài đặt do người dùng này sở hữu trong biểu mẫu nhất định, chỉ dành cho tập lệnh hoặc tiện ích bổ sung này.
getUserTriggers(spreadsheet)Trigger[]Lấy tất cả các trình kích hoạt có thể cài đặt thuộc sở hữu của người dùng này trong bảng tính nhất định, dành cho tập lệnh hoặc tiện ích bổ sung này.
invalidateAuth()voidVô hiệu hóa uỷ quyền mà người dùng hiệu quả phải thực thi tập lệnh hiện tại.
newStateToken()StateTokenBuilderTạo trình tạo cho mã thông báo trạng thái có thể được sử dụng trong API gọi lại (như luồng OAuth).
newTrigger(functionName)TriggerBuilderBắt đầu quy trình tạo một trình kích hoạt có thể cài đặt, khi được kích hoạt, sẽ gọi một hàm nhất định.

Service

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
getUrl()StringTrả về URL của ứng dụng web, nếu ứng dụng đó đã được triển khai; nếu không, hàm này sẽ trả về null.
isEnabled()BooleanTrả về true nếu có thể truy cập tập lệnh dưới dạng ứng dụng web.

SpreadsheetTriggerBuilder

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
create()TriggerTạo trình kích hoạt và trả về trình kích hoạt.
onChange()SpreadsheetTriggerBuilderChỉ định một trình kích hoạt sẽ kích hoạt khi nội dung hoặc cấu trúc của bảng tính được thay đổi.
onEdit()SpreadsheetTriggerBuilderChỉ định một trình kích hoạt sẽ kích hoạt khi bạn chỉnh sửa bảng tính.
onFormSubmit()SpreadsheetTriggerBuilderChỉ định một trình kích hoạt sẽ kích hoạt khi bảng tính được gửi đến biểu mẫu.
onOpen()SpreadsheetTriggerBuilderChỉ định một trình kích hoạt sẽ kích hoạt khi mở bảng tính.

StateTokenBuilder

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
createToken()StringXây dựng bản trình bày chuỗi được mã hóa của mã thông báo trạng thái.
withArgument(name, value)StateTokenBuilderThêm một đối số vào mã thông báo.
withMethod(method)StateTokenBuilderĐặt hàm callback.
withTimeout(seconds)StateTokenBuilderĐặt thời lượng (tính bằng giây) mà mã thông báo hợp lệ.

Trigger

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
getEventType()EventTypeTrả về loại sự kiện mà trình kích hoạt sẽ kích hoạt.
getHandlerFunction()StringTrả về hàm sẽ được gọi khi trình kích hoạt kích hoạt.
getTriggerSource()TriggerSourceTrả về nguồn của các sự kiện sẽ kích hoạt trình kích hoạt.
getTriggerSourceId()StringTrả về mã nhận dạng dành riêng cho nguồn.
getUniqueId()StringTrả về giá trị nhận dạng duy nhất có thể dùng để phân biệt các trình kích hoạt với nhau.

TriggerBuilder

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
forDocument(document)DocumentTriggerBuilderTạo và trả về DocumentTriggerBuilder liên kết với tài liệu đã cho.
forDocument(key)DocumentTriggerBuilderTạo và trả về DocumentTriggerBuilder liên kết với tài liệu có mã nhận dạng nhất định.
forForm(form)FormTriggerBuilderTạo và trả về FormTriggerBuilder liên kết với biểu mẫu đã cho.
forForm(key)FormTriggerBuilderTạo và trả về FormTriggerBuilder liên kết với biểu mẫu có mã nhận dạng nhất định.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderTạo và trả về SpreadsheetTriggerBuilder liên kết với bảng tính đã cho.
forSpreadsheet(key)SpreadsheetTriggerBuilderTạo và trả về SpreadsheetTriggerBuilder liên kết với bảng tính có mã nhận dạng đã cho.
forUserCalendar(emailId)CalendarTriggerBuilderTrả về trình tạo để tạo trình kích hoạt lịch.
timeBased()ClockTriggerBuilderTạo và trả về ClockTriggerBuilder để tạo các trình kích hoạt dựa trên thời gian.

TriggerSource

Thuộc tính

Thuộc tínhLoạiMô tả
SPREADSHEETSEnumGoogle Trang tính khiến trình kích hoạt kích hoạt.
CLOCKEnumSự kiện theo thời gian khiến trình kích hoạt kích hoạt.
FORMSEnumGoogle Biểu mẫu khiến trình kích hoạt hoạt động.
DOCUMENTSEnumGoogle Tài liệu làm cho trình kích hoạt hoạt động.
CALENDAREnumLịch Google khiến trình kích hoạt hoạt động.