Script Service

Script

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

Lớp

TênMô tả ngắn
AuthModeMột enum 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 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, cũng như cung cấp URL cho hộp thoại uỷ quyền.
AuthorizationStatusMột tập hợp 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 cho trình kích hoạt lịch.
ClockTriggerBuilderTrình tạo cho 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 enum biểu thị loại sự kiện được kích hoạt.
FormTriggerBuilderTrình tạo cho trình kích hoạt biểu mẫu.
InstallationSourceMột 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.
ScriptAppTruy cập và thao tác với tính năng phát hành tập lệnh và trình kích hoạt.
ServiceTruy cập và thao tác với hoạt động phát hành 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ể dùng trong các API gọi lại (như luồng OAuth).
TriggerMột điều kiện kích hoạt tập lệnh.
TriggerBuilderTrình tạo chung cho trình kích hoạt tập lệnh.
TriggerSourceMột enum biểu thị nguồn của sự kiện kích hoạt điều kiện kích hoạt.

AuthMode

Thuộc tính

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

AuthorizationInfo

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
getAuthorizationStatus()AuthorizationStatusLấy một giá trị cho biết 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 (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

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 cho tập lệnh này tất cả các quyền mà tập lệnh hiện yêu cầu.

CalendarTriggerBuilder

Phương thức

Phương thứcLoại 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 một điều kiện kích hoạt sẽ kích hoạt khi một mục trong lịch được tạo, cập nhật hoặc xoá.

ClockTriggerBuilder

Phương thức

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 điểm hiện tại mà điều kiện 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 ngày đã cho, theo mặc định là gần nửa đêm (+/- 15 phút).
atHour(hour)ClockTriggerBuilderChỉ định giờ mà điều kiện kích hoạt 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 sau mỗi n giờ.
everyMinutes(n)ClockTriggerBuilderChỉ định chạy điều kiện kích hoạt mỗi n phút.
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 điều kiện kích hoạt chạy.
nearMinute(minute)ClockTriggerBuilderChỉ định phút mà điều kiện kích hoạt chạy (thêm hoặc trừ 15 phút).
onMonthDay(day)ClockTriggerBuilderChỉ định ngày trong tháng mà điều kiện kích hoạt chạy.
onWeekDay(day)ClockTriggerBuilderChỉ định ngày trong tuần mà điều kiện kích hoạt chạy.

DocumentTriggerBuilder

Phương thức

Phương thứcLoại 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 một điều kiện kích hoạt sẽ kích hoạt khi tài liệu được mở.

EventType

Thuộc tính

Thuộc tínhLoạiMô tả
CLOCKEnumĐiều kiện kích hoạt sẽ kích hoạt khi sự kiện do thời gian điều khiển đạt đến một thời điểm cụ thể.
ON_OPENEnumĐiều kiện 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_EDITEnumĐiều kiện 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 một giá trị mới vào một ô, giá trị này được tính là một nội dung chỉnh sửa thay vì một nội dung thay đổi).
ON_FORM_SUBMITEnumĐiều kiện kích hoạt sẽ kích hoạt sau khi người dùng trả lời một Biểu mẫu Google.
ON_CHANGEEnumĐiều kiện 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, điều này được tính là thay đổi thay vì chỉnh sửa).
ON_EVENT_UPDATEDEnumĐiều kiện 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 thức

Phương thứcLoại 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 một điều kiện kích hoạt sẽ kích hoạt khi người dùng gửi phản hồi vào biểu mẫu.
onOpen()FormTriggerBuilderChỉ định một điều kiện kích hoạt sẽ kích hoạt khi mở chế độ xem chỉnh sửa của biểu mẫu.

InstallationSource

Thuộc tính

Thuộc tínhLoạiMô tả
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumTiện ích bổ sung là do quản trị viên cài đặt 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 enum 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.
AuthorizationStatusAuthorizationStatusMột tập hợp liệt kê cho biết trạng thái uỷ quyền của một tập lệnh.
EventTypeEventTypeMột enum biểu thị loại sự kiện được kích hoạt.
InstallationSourceInstallationSourceMột liệt kê cho biết 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 enum biểu thị nguồn của sự kiện kích hoạt điều kiện kích hoạt.
WeekDayWeekdayMột enum đại diện cho các ngày trong tuần.

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
deleteTrigger(trigger)voidXoá điều kiện kích hoạt đã cho để điều kiện kích hoạt đó không còn chạy nữa.
getAuthorizationInfo(authMode)AuthorizationInfoLấy mộ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, cũng như cung cấp URL cho hộp thoại uỷ quyền.
getIdentityToken()StringNhận mã thông báo danh tính 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 tập lệnh được cài đặt 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 hợp lệ.
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 một đối tượng dùng để kiểm soát việc phát hành 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 mà người dùng này sở hữu trong tài liệu đã cho, 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 mà người dùng này sở hữu ở dạng đã cho, 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 mà người dùng này sở hữu trong bảng tính đã cho, chỉ dành cho tập lệnh hoặc tiện ích bổ sung này.
invalidateAuth()voidLàm mất hiệu lực quyền uỷ quyền mà người dùng hợp lệ có để thực thi tập lệnh hiện tại.
newStateToken()StateTokenBuilderTạo một 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 (chẳng hạn 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, trình kích hoạt này sẽ gọi một hàm nhất định.

Service

Phương thức

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, trả về null.
isEnabled()BooleanTrả về true nếu có thể truy cập vào tập lệnh dưới dạng ứng dụng web.

SpreadsheetTriggerBuilder

Phương thức

Phương thứcLoại 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 một điều kiện 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 điều kiện kích hoạt sẽ kích hoạt khi bảng tính được chỉnh sửa.
onFormSubmit()SpreadsheetTriggerBuilderChỉ định một điều kiện kích hoạt sẽ kích hoạt khi bảng tính có một biểu mẫu được gửi đến.
onOpen()SpreadsheetTriggerBuilderChỉ định một điều kiện kích hoạt sẽ kích hoạt khi bảng tính được mở.

StateTokenBuilder

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
createToken()StringTạo một chuỗi đã mã hoá đại diện cho 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 gọi lại.
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ứcLoại dữ liệu trả vềMô tả ngắn
getEventType()EventTypeTrả về loại sự kiện mà điều kiện kích hoạt sẽ kích hoạt.
getHandlerFunction()StringTrả về hàm sẽ được gọi khi điều kiện kích hoạt được kích hoạt.
getTriggerSource()TriggerSourceTrả về nguồn sự kiện sẽ kích hoạt điều kiện kích hoạt.
getTriggerSourceId()StringTrả về mã nhận dạng dành riêng cho nguồn.
getUniqueId()StringTrả về một 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 thức

Phương thứcLoại 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 liên kết với biểu mẫu đã cho.
forForm(key)FormTriggerBuilderTạo và trả về một FormTriggerBuilder liên kết 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 có mã nhận dạng đã cho.
forUserCalendar(emailId)CalendarTriggerBuilderTrả về một trình tạo để tạo trình kích hoạt lịch.
timeBased()ClockTriggerBuilderTạo và trả về ClockTriggerBuilder để tạo điều kiện 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 sẽ kích hoạt điều kiện kích hoạt.
CLOCKEnumSự kiện dựa trên thời gian sẽ kích hoạt điều kiện kích hoạt.
FORMSEnumGoogle Forms kích hoạt điều kiện kích hoạt.
DOCUMENTSEnumGoogle Tài liệu sẽ kích hoạt điều kiện kích hoạt.
CALENDAREnumLịch Google kích hoạt điều kiện kích hoạt.