Đối tượng sự kiện

Trình kích hoạt đơn giản và trình kích hoạt có thể cài đặt cho phép Apps Script tự động chạy một hàm nếu một sự kiện nhất định xảy ra. Khi một điều kiện kích hoạt hoạt động, Apps Script sẽ truyền cho hàm một đối tượng sự kiện dưới dạng đối số, thường được gọi là e. Đối tượng sự kiện chứa thông tin về bối cảnh khiến sự kiện kích hoạt được kích hoạt. Ví dụ: mã mẫu bên dưới cho thấy một trình kích hoạt onEdit(e) đơn giản cho một tập lệnh Google Trang tính sử dụng đối tượng sự kiện để xác định ô nào đã được chỉnh sửa.

function onEdit(e){
  // Set a comment on the edited cell to indicate when it was changed.
  var range = e.range;
  range.setNote('Last modified: ' + new Date());
}

Trang này trình bày chi tiết các trường trong đối tượng sự kiện cho nhiều loại trình kích hoạt.

Các sự kiện do trình kích hoạt có thể cài đặt tạo ra chứa một triggerUid xác định trình kích hoạt đã tạo ra sự kiện đó. Điều này hữu ích cho những tập lệnh có nhiều trình kích hoạt có thể cài đặt.

Sự kiện trên Google Trang tính

Các trình kích hoạt dành riêng cho Google Trang tính cho phép tập lệnh phản hồi các thao tác của người dùng trong bảng tính.

Mở (đơn giản và có thể cài đặt)
authMode	Giá trị của enum ScriptApp.AuthMode. LIMITED
source	Một đối tượng Spreadsheet, đại diện cho tệp Google Trang tính mà tập lệnh được liên kết. Spreadsheet
triggerUid	Mã của trình kích hoạt đã tạo ra sự kiện này (chỉ trình kích hoạt có thể cài đặt). 4034124084959907503
user	Một đối tượng User, đại diện cho người dùng đang hoạt động (nếu có) (tuỳ thuộc vào một bộ hạn chế bảo mật phức tạp). [e-mail]

Chuyển (có thể cài đặt)
authMode	Giá trị của enum ScriptApp.AuthMode. FULL
changeType	Loại thay đổi (EDIT, INSERT_ROW, INSERT_COLUMN, REMOVE_ROW, REMOVE_COLUMN, INSERT_GRID, REMOVE_GRID, FORMAT hoặc OTHER). INSERT_ROW
source	Một đối tượng Spreadsheet, đại diện cho tệp Google Trang tính mà tập lệnh được liên kết. Spreadsheet
triggerUid	Mã của điều kiện kích hoạt đã tạo ra sự kiện này. 4034124084959907503
user	Một đối tượng User, đại diện cho người dùng đang hoạt động (nếu có) (tuỳ thuộc vào một bộ hạn chế bảo mật phức tạp). [e-mail]

Chỉnh sửa (đơn giản và có thể cài đặt)
authMode	Giá trị của enum ScriptApp.AuthMode. LIMITED
oldValue	Giá trị của ô trước khi chỉnh sửa (nếu có). Chỉ có sẵn nếu dải ô được chỉnh sửa là một ô duy nhất. Sẽ không xác định nếu ô không có nội dung trước đó. 1234
range	Một đối tượng Range, đại diện cho ô hoặc dải ô đã được chỉnh sửa. Range
source	Một đối tượng Spreadsheet, đại diện cho tệp Google Trang tính mà tập lệnh được liên kết. Spreadsheet
triggerUid	Mã của trình kích hoạt đã tạo ra sự kiện này (chỉ trình kích hoạt có thể cài đặt). 4034124084959907503
user	Một đối tượng User, đại diện cho người dùng đang hoạt động (nếu có) (tuỳ thuộc vào một bộ hạn chế bảo mật phức tạp). [e-mail]
value	Giá trị mới trong ô sau khi chỉnh sửa. Chỉ có sẵn nếu dải ô được chỉnh sửa là một ô duy nhất. 10

Gửi biểu mẫu (có thể cài đặt)
Thận trọng: Đảm bảo bạn sử dụng trình kích hoạt gửi biểu mẫu này với SpreadsheetTriggerBuilder.
authMode	Giá trị của enum ScriptApp.AuthMode. FULL
namedValues	Một đối tượng chứa tên và giá trị câu hỏi từ biểu mẫu đã gửi. { 'First Name': ['Jane'], 'Timestamp': ['6/7/2015 20:54:13'], 'Last Name': ['Doe'] }
range	Một đối tượng Range, đại diện cho ô hoặc dải ô đã được chỉnh sửa. Range
triggerUid	Mã của điều kiện kích hoạt đã tạo ra sự kiện này. 4034124084959907503
values	Mảng có các giá trị theo cùng thứ tự xuất hiện trong bảng tính. ['2015/05/04 15:00', '[e-mail]', 'Bob', '27', 'Bill', '28', 'Susan', '25']

Sự kiện trên Google Tài liệu

Trình kích hoạt cho phép Google Tài liệu phản hồi khi người dùng mở một tài liệu.

Mở (đơn giản và có thể cài đặt)
authMode	Giá trị của enum ScriptApp.AuthMode. LIMITED
source	Một đối tượng Document, đại diện cho tệp Google Tài liệu mà tập lệnh được liên kết. Document
triggerUid	Mã của trình kích hoạt đã tạo ra sự kiện này (chỉ trình kích hoạt có thể cài đặt). 4034124084959907503
user	Một đối tượng User, đại diện cho người dùng đang hoạt động (nếu có) (tuỳ thuộc vào một bộ hạn chế bảo mật phức tạp). [e-mail]

Sự kiện trên Google Trang trình bày

Trình kích hoạt cho phép Google Trang trình bày phản hồi khi người dùng mở một bản trình bày.

Mở (đơn giản)
authMode	Giá trị của enum ScriptApp.AuthMode. LIMITED
source	Một đối tượng Presentation, đại diện cho tệp Google Trang trình bày mà tập lệnh được liên kết. Presentation
user	Một đối tượng User, đại diện cho người dùng đang hoạt động (nếu có) (tuỳ thuộc vào một bộ hạn chế bảo mật phức tạp). [e-mail]

Sự kiện trên Google Biểu mẫu

Các trình kích hoạt dành riêng cho Google Biểu mẫu cho phép tập lệnh phản hồi khi người dùng chỉnh sửa biểu mẫu hoặc gửi câu trả lời.

Mở * (đơn giản và dễ dàng cài đặt)
authMode	Giá trị của enum ScriptApp.AuthMode. LIMITED
source	Một đối tượng Form, đại diện cho tệp Google Biểu mẫu mà tập lệnh được liên kết. Form
triggerUid	Mã của trình kích hoạt đã tạo ra sự kiện này (chỉ trình kích hoạt có thể cài đặt). 4034124084959907503
user	Một đối tượng User, đại diện cho người dùng đang hoạt động (nếu có) (tuỳ thuộc vào một bộ hạn chế bảo mật phức tạp). [e-mail]

* Sự kiện này không xảy ra khi người dùng mở biểu mẫu để trả lời mà là khi người chỉnh sửa mở biểu mẫu để sửa đổi.

Gửi biểu mẫu (có thể cài đặt)
Thận trọng: Đảm bảo bạn sử dụng trình kích hoạt gửi biểu mẫu này với FormTriggerBuilder.
authMode	Giá trị của enum ScriptApp.AuthMode. FULL
response	Một đối tượng FormResponse, đại diện cho phản hồi của người dùng đối với biểu mẫu nói chung. FormResponse
source	Một đối tượng Form, đại diện cho tệp Google Biểu mẫu mà tập lệnh được liên kết. Form
triggerUid	Mã của điều kiện kích hoạt đã tạo ra sự kiện này. 4034124084959907503

Sự kiện trên Lịch Google

Trình kích hoạt lịch sẽ kích hoạt khi sự kiện trên lịch của người dùng được cập nhật (tạo, chỉnh sửa hoặc xoá).

Những điều kiện kích hoạt này không cho bạn biết sự kiện nào đã thay đổi hoặc cách sự kiện đó thay đổi. Thay vào đó, các mã này cho biết mã của bạn cần thực hiện một thao tác đồng bộ hoá gia tăng để nhận các thay đổi gần đây đối với lịch. Để biết nội dung mô tả đầy đủ về quy trình này, hãy xem Hướng dẫn đồng bộ hoá tài nguyên cho Calendar API.

Để đồng bộ hoá với Lịch trong Apps Script, hãy thực hiện các bước sau:

1. Bật Dịch vụ nâng cao của Lịch cho dự án tập lệnh. Dịch vụ Lịch tích hợp sẵn là chưa đủ cho quy trình này.
2. Xác định những lịch cần được đồng bộ hoá. Đối với mỗi lịch như vậy, hãy thực hiện thao tác đồng bộ hoá ban đầu bằng phương thức Events.list() của dịch vụ nâng cao Lịch.
3. Kết quả của quá trình đồng bộ hoá ban đầu sẽ trả về một nextSyncToken cho lịch đó. Lưu trữ mã thông báo này để sử dụng sau.
4. Khi trình kích hoạt EventUpdated của Apps Script kích hoạt cho biết có thay đổi về sự kiện trên lịch, hãy thực hiện đồng bộ hoá gia tăng cho lịch bị ảnh hưởng bằng cách sử dụng nextSyncToken đã lưu trữ. Về cơ bản, đây là một yêu cầu Events.list() khác, nhưng việc cung cấp nextSyncToken sẽ giới hạn phản hồi chỉ cho những sự kiện đã thay đổi kể từ lần đồng bộ hoá gần nhất.
5. Kiểm tra phản hồi của quá trình đồng bộ hoá để biết những sự kiện nào đã được cập nhật và để mã của bạn phản hồi một cách thích hợp. Ví dụ: bạn có thể ghi nhật ký thay đổi, cập nhật bảng tính, gửi thông báo qua email hoặc thực hiện các hành động khác.
6. Cập nhật nextSyncToken mà bạn đã lưu trữ cho lịch đó bằng nextSyncToken do yêu cầu đồng bộ hoá gia tăng trả về. Thao tác này buộc thao tác đồng bộ hoá tiếp theo chỉ trả về những thay đổi mới nhất.

Thận trọng: Đôi khi, mã thông báo đồng bộ hoá sẽ bị máy chủ vô hiệu hoá, dẫn đến lỗi 410. Khi điều này xảy ra, mã của bạn sẽ thực hiện một quy trình đồng bộ hoá đầy đủ và thay thế tất cả dữ liệu cũng như mã thông báo đã đồng bộ hoá được lưu trữ mà bạn có cho lịch đó.

EventUpdated (có thể cài đặt)
authMode	Một giá trị của enum ScriptApp.AuthMode. FULL
calendarId	Mã chuỗi của lịch nơi diễn ra nội dung cập nhật sự kiện. [e-mail]
triggerUid	Mã của điều kiện kích hoạt đã tạo ra sự kiện này. 4034124084959907503

Sự kiện tiện ích bổ sung của Google Workspace

Trình kích hoạt onInstall() sẽ tự động chạy khi người dùng cài đặt một tiện ích bổ sung.

Cài đặt (đơn giản)
authMode	Giá trị của enum ScriptApp.AuthMode. FULL

Sự kiện trong ứng dụng Google Chat

Để tìm hiểu về các đối tượng sự kiện trong Google Chat, hãy xem bài viết Nhận và phản hồi các lượt tương tác với ứng dụng Google Chat.

Sự kiện dựa trên thời gian

Điều kiện kích hoạt dựa trên thời gian (còn gọi là điều kiện kích hoạt đồng hồ) cho phép tập lệnh thực thi vào một thời điểm cụ thể hoặc theo một khoảng thời gian định kỳ.

Dựa trên thời gian (có thể cài đặt)
authMode	Giá trị của enum ScriptApp.AuthMode. FULL
day-of-month	Từ 1 đến 31. Vì tên thuộc tính này có chứa dấu gạch ngang nên bạn phải truy cập thông qua e['day-of-month'] thay vì ký hiệu dấu chấm. 31
day-of-week	Từ 1 (Thứ Hai) đến 7 (Chủ Nhật). Vì tên thuộc tính này có chứa dấu gạch ngang nên bạn phải truy cập thông qua e['day-of-week'] thay vì ký hiệu dấu chấm. 7
hour	Từ 0 đến 23. 23
minute	Từ 0 đến 59. 59
month	Từ 1 đến 12. 12
second	Từ 0 đến 59. 59
timezone	Múi giờ. UTC
triggerUid	Mã của điều kiện kích hoạt đã tạo ra sự kiện này. 4034124084959907503
week-of-year	Từ 1 đến 52. Vì tên thuộc tính này có chứa dấu gạch ngang nên bạn phải truy cập thông qua e['week-of-year'] thay vì ký hiệu dấu chấm. 52
year	Năm. 2015