Script Service

Script

Dịch vụ này cung cấp quyền truy cập vào các 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 uỷ quyền mà Apps Script có thể thực thi thông qua một hàm được kích hoạt.
AuthorizationInfoMột đối tượng được dùng để xác định xem người dùng có cần cho phép tập lệnh này sử dụng một hoặc nhiều dịch vụ hay không, cũng như để cung cấp URL cho hộp thoại uỷ quyền.
AuthorizationStatusNội dung liệt kê cho biết trạng thái uỷ quyền của một tập lệnh.
CalendarTriggerBuilderTrình tạo các điều kiện kích hoạt lịch.
ClockTriggerBuilderTrình tạo kích hoạt đồng hồ.
DocumentTriggerBuilderTrình tạo kích hoạt tài liệu.
EventTypeMột bảng liệt kê cho biết loại sự kiện được kích hoạt.
FormTriggerBuilderTrình tạo 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 việc xuất bản tập lệnh và các trình kích hoạt.
ServiceTruy cập và thao túng xuất bản tập lệnh.
SpreadsheetTriggerBuilderTrình tạo 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ể sử dụng trong API gọi lại (như luồng OAuth).
TriggerTrình kích hoạt tập lệnh.
TriggerBuilderTrình tạo chung cho các kích hoạt tập lệnh.
TriggerSourceBảng liệt kê cho biết nguồn của sự kiện khiến trình kích hoạt kích hoạt.

AuthMode

Thuộc tính

Tài sảnLoạiNội dung mô tả
NONEEnumChế độ không cho phép truy cập vào bất kỳ dịch vụ nào yêu cầu bạn cho phép.
CUSTOM_FUNCTIONEnumChế độ cho phép truy cập vào một nhóm nhỏ các dịch vụ để sử dụng trong các hàm bảng tính tuỳ chỉnh.
LIMITEDEnumChế độ cho phép truy cập vào một số ít dịch vụ.
FULLEnumChế độ cho phép truy cập vào tất cả dịch vụ yêu cầu bạn cho phép.

AuthorizationInfo

Phương thức

Phương thứcKiểu 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 cho phép 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 uỷ quyền có thể dùng để cấp quyền truy cập vào tập lệnh.

AuthorizationStatus

Thuộc tính

Tài sảnLoạiNội dung mô tả
REQUIREDEnumNgười dùng cần cho phép 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 cho tập lệnh này toàn bộ quyền mà tập lệnh đó yêu cầu.

CalendarTriggerBuilder

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
create()TriggerTạo và trả về điều kiện kích hoạt.
onEventUpdated()CalendarTriggerBuilderChỉ định điều kiện kích hoạt sẽ kích hoạt khi tạo, cập nhật hoặc xoá một mục trong lịch.

ClockTriggerBuilder

Phương thức

Phương thứcKiểu 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 điều kiện kích hoạt sẽ kích hoạt vào một ngày nhất định, theo mặc định là gần nửa đêm (+/- 15 phút).
atHour(hour)ClockTriggerBuilderChỉ định giờ mà trình kích hoạt này chạy.
create()TriggerTạo điều kiện kích hoạt.
everyDays(n)ClockTriggerBuilderChỉ định chạy điều kiện kích hoạt n ngày một lần.
everyHours(n)ClockTriggerBuilderChỉ định chạy điều kiện kích hoạt n giờ một lần.
everyMinutes(n)ClockTriggerBuilderChỉ định chạy điều kiện kích hoạt n phút một lần.
everyWeeks(n)ClockTriggerBuilderChỉ định chạy điều kiện kích hoạt 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 số 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 thức

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

EventType

Thuộc tính

Tài sảnLoạiNội dung mô tả
CLOCKEnumTrình kích hoạt kích hoạt sau khi sự kiện dựa trên 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 ô, giá trị này đượ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 này sẽ kích hoạt sau khi người dùng phản hồi một biểu mẫu trên Google Biểu mẫu.
ON_CHANGEEnumTrình kích hoạt này 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 chứ không phải là một chỉnh sửa).
ON_EVENT_UPDATEDEnumĐiều kiện kích hoạt này sẽ kích hoạt sau khi một sự kiện được tạo, cập nhật hoặc bị xoá trên Lịch Google đã chỉ định.

FormTriggerBuilder

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
create()TriggerTạo và trả về điều kiện kích hoạt mới.
onFormSubmit()FormTriggerBuilderChỉ định trình kích hoạt sẽ kích hoạt khi phản hồi được gửi tới biểu mẫu.
onOpen()FormTriggerBuilderChỉ định 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ở ra.

InstallationSource

Thuộc tính

Tài sảnLoạiNội dung mô 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 hiện không chạy dưới dạng tiện ích bổ sung.
WEB_STORE_ADD_ONEnumNgười dùng đã cài đặt tiện ích bổ sung từ Cửa hàng Chrome trực tuyến.

ScriptApp

Thuộc tính

Tài sảnLoạiNội dung mô tả
AuthModeAuthModeMột bảng liệt kê xác định những danh mục dịch vụ được uỷ quyền mà Apps Script có thể thực thi thông qua một hàm được kích hoạt.
AuthorizationStatusAuthorizationStatusNội dung liệt kê cho biết trạng thái uỷ quyền của một tập lệnh.
EventTypeEventTypeMột bảng liệt kê cho biết loại sự kiện được kích hoạt.
InstallationSourceInstallationSourceBảng liệt kê cho biết cách tập lệnh được cài đặt cho người dùng dưới dạng tiện ích bổ sung.
TriggerSourceTriggerSourceBảng liệt kê cho biết 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ê các ngày trong tuần.

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
deleteTrigger(trigger)voidXoá điều kiện kích hoạt nhất định để nó 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 cho phép 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ề một 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ó tự cài đặt tập lệnh đó thông qua Cửa hàng Chrome trực tuyến hay không hoặc liệu quản trị viên miền có cài đặt tập lệnh đó cho tất cả người dùng hay khô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 điều kiện kích hoạt có thể cài đặt được liên kết với dự án 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 một ứng dụng web.
getUserTriggers(document)Trigger[]Lấy tất cả các điều kiện 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 này hoặc tiện ích bổ sung này.
getUserTriggers(form)Trigger[]Lấy tất cả các điều kiện kích hoạt có thể cài đặt do người dùng này sở hữu ở dạng nhất định, chỉ dành cho tập lệnh này hoặc tiện ích bổ sung.
getUserTriggers(spreadsheet)Trigger[]Lấy tất cả các điều kiện kích hoạt có thể cài đặt do người dùng này sở hữu trong bảng tính nhất định, chỉ dành cho tập lệnh này hoặc tiện ích bổ sung này.
invalidateAuth()voidVô hiệu hoá lệnh uỷ quyền mà người dùng có hiệu lực 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ể dùng trong API gọi lại (như luồng OAuth).
newTrigger(functionName)TriggerBuilderBắt đầu quá 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 thức

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

SpreadsheetTriggerBuilder

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
create()TriggerTạo và trả về điều kiện kích hoạt.
onChange()SpreadsheetTriggerBuilderChỉ định 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 thay đổi.
onEdit()SpreadsheetTriggerBuilderChỉ định một trình kích hoạt sẽ kích hoạt khi bảng tính được chỉnh sửa.
onFormSubmit()SpreadsheetTriggerBuilderChỉ định trình kích hoạt sẽ kích hoạt khi bảng tính đã gửi một biểu mẫu tới bảng tính.
onOpen()SpreadsheetTriggerBuilderChỉ định trình kích hoạt sẽ kích hoạt khi bảng tính được mở.

StateTokenBuilder

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
createToken()StringTạo một chuỗi đại diện đã mã hoá 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 một hàm callback.
withTimeout(seconds)StateTokenBuilderĐặt thời lượng (tính bằng giây) mà mã thông báo có hiệu lực.

Trigger

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
getEventType()EventTypeTrả về loại sự kiện mà trình kích hoạt 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 sự kiện sẽ khiến trình kích hoạt kích hoạt.
getTriggerSourceId()StringTrả về mã nhận dạng riêng của nguồn.
getUniqueId()StringTrả về một giá trị nhận dạng duy nhất có thể dùng để phân biệt trình kích hoạt với nhau.

TriggerBuilder

Phương thức

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

TriggerSource

Thuộc tính

Tài sảnLoạiNội dung mô tả
SPREADSHEETSEnumGoogle Trang tính khiến trình kích hoạt kích hoạt.
CLOCKEnumMột sự kiện diễn ra 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 kích hoạt.
DOCUMENTSEnumGoogle Tài liệu khiến trình kích hoạt kích hoạt.
CALENDAREnumLịch Google làm cho trình kích hoạt kích hoạt.