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à tính năng xuất bản tập lệnh.

Lớp

TênMô tả ngắn
AuthModeMột kiểu 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 kiểm tra xem người dùng đã cấp quyền cho các phạm vi bắt buộc của tập lệnh hay chưa.
AuthorizationStatusMột giá trị 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 các điều kiện kích hoạt lịch.
ClockTriggerBuilderTrình tạo cho trình kích hoạt đồng hồ.
DocumentTriggerBuilderTrình tạo cho các điều kiện kích hoạt tài liệu.
EventTypeMột giá trị liệt kê biểu thị loại sự kiện được kích hoạt.
FormTriggerBuilderTrình tạo cho các điều kiện kích hoạt biểu mẫu.
InstallationSourceMột kiểu liệt kê cho biết cách tập lệnh được cài đặt dưới dạng một tiện ích bổ sung cho người dùng hiện tại.
ScriptAppTruy cập và thao tác với hoạt động xuất bản tập lệnh và các trình kích hoạt.
ServiceTruy cập và thao tác với hoạt động xuất bản tập lệnh.
SpreadsheetTriggerBuilderTrình tạo cho các điều kiện 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 (chẳng hạn như quy trình OAuth).
TriggerMột điều 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 quá trình liệt kê biểu thị nguồn của sự kiện khiến điều kiện kích hoạt hoạt động.

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 yêu cầu uỷ quyền.
CUSTOM_FUNCTIONEnumMột chế độ cho phép truy cập vào một số ít 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 số ít dịch vụ.
FULLEnumMột chế độ 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ứcKiểu 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 cấp quyền cho tập lệnh này để sử dụng một hoặc nhiều dịch vụ (ví dụ: ScriptApp.AuthorizationStatus.REQUIRED) hay không.
getAuthorizationUrl()String|nullLấy URL uỷ quyền có thể dùng để cấp quyền truy cập vào tập lệnh.
getAuthorizedScopes()String[]|nullLấy danh sách các phạm vi được uỷ quyền cho 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 uỷ quyền mà tập lệnh hiện 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 điều kiện kích hoạt và trả về điều kiện đó.
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ứ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à điều kiện kích hoạt sẽ 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ẽ hoạt động 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 sẽ 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 sau mỗi n ngày.
everyHours(n)ClockTriggerBuilderChỉ định chạy điều kiện kích hoạt 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 mỗi n tuầ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 (cộng 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ứcKiểu 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 đ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 dựa trên thời gian đạt đến một thời gian cụ thể.
ON_OPENEnumĐiều kiện kích hoạt sẽ diễn ra 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ẽ hoạt động 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 ô, hành động này được tính là một lượt chỉnh sửa thay vì một lượt thay đổi).
ON_FORM_SUBMITEnumĐiều kiện kích hoạt sẽ kích hoạt khi người dùng phản hồi một Google Biểu mẫu.
ON_CHANGEEnumĐiều kiện kích hoạt sẽ hoạt động 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, đây được tính là một thay đổi thay vì một nội dung chỉnh sửa).
ON_EVENT_UPDATEDEnumTrình kích hoạt sẽ hoạt động khi một sự kiện được tạo, cập nhật hoặc xoá trên Lịch Google được 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ề trình 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 một câu trả lời được gửi đến biểu mẫu.
onOpen()FormTriggerBuilderChỉ định một điều kiện kích hoạt sẽ kích hoạt khi chế độ 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_ONEnumNgười dùng đã cài đặt tiện ích bổ sung này từ Cửa hàng Chrome trực tuyến.

ScriptApp

Thuộc tính

Thuộc tínhLoạiMô tả
AuthModeAuthModeMột kiểu 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.
AuthorizationStatusAuthorizationStatusMột giá trị liệt kê biểu thị trạng thái uỷ quyền của một tập lệnh.
EventTypeEventTypeMột giá trị liệt kê biểu thị loại sự kiện được kích hoạt.
InstallationSourceInstallationSourceMột quá trình liệt kê cho biết cách cài đặt tập lệnh cho người dùng dưới dạng một tiện ích bổ sung.
TriggerSourceTriggerSourceMột quá trình liệt kê biểu thị nguồn của sự kiện khiến điều kiện kích hoạt hoạt động.
WeekDayWeekdayMột kiểu liệt kê đại diện cho 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á trình kích hoạt đã cho để trình kích hoạt đó không còn chạy nữa.
getAuthorizationInfo(authMode)AuthorizationInfoLấy một đối tượng kiểm tra xem người dùng đã cấp quyền uỷ quyền cho tất cả các yêu cầu về tập lệnh hay chưa.
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoLấy một đối tượng kiểm tra xem người dùng đã cấp quyền uỷ quyền cho các phạm vi được yêu cầu hay chưa.
getIdentityToken()String|nullNhậ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 tự cài đặt thông qua Cửa hàng Chrome trực tuyến hay quản trị viên miền cài đặt cho tất cả người dùng).
getOAuthToken()StringLấy mã truy cập OAuth 2.0 cho người dùng có hiệu lực.
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 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 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 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 thuộc sở hữu của người dùng này trong biểu mẫu đã 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()voidHuỷ bỏ quyền uỷ quyền mà người dùng có hiệu lực 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ể dùng trong một Callback API (chẳng hạn như một quy trình 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.
requireAllScopes(authMode)voidXác thực xem người dùng đã đồng ý cho tất cả các phạm vi mà tập lệnh yêu cầu hay chưa.
requireScopes(authMode, oAuthScopes)voidXác thực xem người dùng đã đồng ý cho các phạm vi được yêu cầu hay chưa.

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 ứng dụng này đã được triển khai); nếu không, hàm này sẽ trả về null.
isEnabled()BooleanTrả về true nếu tập lệnh có thể truy cập được dưới dạng một ứ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 điều kiện kích hoạt và trả về điều kiện đó.
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 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 nhận được 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ứcKiểu dữ liệu trả vềMô tả ngắn
createToken()StringTạo một chuỗi được mã hoá biểu thị 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à điều kiện kích hoạt kích hoạt.
getHandlerFunction()StringTrả về hàm được gọi khi điều kiện kích hoạt hoạt động.
getTriggerSource()TriggerSourceTrả về nguồn của các sự kiện khiến điều kiện kích hoạt hoạt động.
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 riêng biệt có thể dùng để phân biệt các điều kiện 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 được liên kết với tài liệu đã cho.
forDocument(key)DocumentTriggerBuilderTạo và trả về một DocumentTriggerBuilder được 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 được liên kết với biểu mẫu đã cho.
forForm(key)FormTriggerBuilderTạo và trả về một FormTriggerBuilder được 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 được liên kết với bảng tính đã cho.
forSpreadsheet(key)SpreadsheetTriggerBuilderTạo và trả về một SpreadsheetTriggerBuilder được 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 các đ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

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