google.script.run là một API JavaScript phía máy khách không đồng bộ, cho phép các trang dịch vụ HTML gọi các hàm Apps Script phía máy chủ. Ví dụ sau đây cho thấy chức năng cơ bản nhất của google.script.run – gọi một hàm trên máy chủ từ JavaScript phía máy khách.
Code.gs
function doGet() {
return HtmlService.createHtmlOutputFromFile('Index');
}
function doSomething() {
Logger.log('I was called!');
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
<script>
google.script.run.doSomething();
</script>
</head>
</html>
Nếu triển khai tập lệnh này dưới dạng ứng dụng web và truy cập vào URL của ứng dụng, bạn sẽ không thấy bất cứ thứ gì, nhưng nếu xem nhật ký, bạn sẽ thấy chức năng máy chủ doSomething() đã được gọi.
Các lệnh gọi phía máy khách đến các hàm phía máy chủ không đồng bộ: sau khi trình duyệt yêu cầu máy chủ chạy hàm doSomething(), trình duyệt sẽ tiếp tục ngay lập tức sang dòng mã tiếp theo mà không cần chờ phản hồi. Điều này có nghĩa là các lệnh gọi hàm máy chủ có thể không thực thi theo thứ tự bạn mong đợi. Nếu bạn thực hiện hai lệnh gọi hàm cùng một lúc, thì sẽ không có cách nào để biết hàm nào sẽ chạy trước; kết quả có thể khác nhau mỗi khi bạn tải trang. Trong trường hợp này, trình xử lý thành công và trình xử lý lỗi sẽ giúp kiểm soát luồng mã của bạn.
API google.script.run cho phép 10 lệnh gọi đồng thời đến các hàm máy chủ. Nếu bạn thực hiện lệnh gọi thứ 11 trong khi 10 vị trí vẫn đang chạy, thì chức năng máy chủ sẽ bị trì hoãn cho đến khi một trong 10 vị trí được giải phóng. Trên thực tế, bạn hiếm khi phải suy nghĩ về hạn chế này, đặc biệt là vì hầu hết các trình duyệt đã giới hạn số lượng yêu cầu đồng thời đến cùng một máy chủ ở mức dưới 10.
Ví dụ: Trong Firefox, giới hạn là 6. Tương tự, hầu hết các trình duyệt sẽ trì hoãn các yêu cầu vượt quá của máy chủ cho đến khi một trong các yêu cầu hiện có được hoàn tất.
Tham số và giá trị trả về
Bạn có thể gọi một hàm máy chủ bằng các tham số từ ứng dụng. Tương tự, hàm máy chủ có thể trả về một giá trị cho máy khách dưới dạng tham số được truyền đến trình xử lý thành công.
Thông số pháp lý và giá trị trả về là các dữ liệu nguyên gốc JavaScript như Number, Boolean, String hoặc null, cũng như các đối tượng và mảng JavaScript bao gồm các dữ liệu nguyên gốc, đối tượng và mảng. Phần tử form trong trang cũng hợp pháp dưới dạng tham số, nhưng phải là tham số duy nhất của hàm và không hợp pháp làm giá trị trả về. Yêu cầu sẽ không thành công nếu bạn cố gắng chuyển phần tử DOM, Date, Function ngoài form hoặc một loại bị cấm khác, bao gồm cả các loại bị cấm bên trong các đối tượng hoặc mảng. Các đối tượng tạo tham chiếu vòng tròn cũng sẽ không thành công và các trường không xác định trong mảng sẽ trở thành null.
Lưu ý rằng một đối tượng được truyền đến máy chủ sẽ trở thành bản sao của đối tượng gốc. Nếu hàm của máy chủ nhận được một đối tượng và thay đổi các thuộc tính của đối tượng đó, thì các thuộc tính trên ứng dụng sẽ không bị ảnh hưởng.
Trình xử lý thành công
Vì mã phía máy khách sẽ tiếp tục chạy trên dòng tiếp theo mà không cần đợi lệnh gọi máy chủ hoàn tất, nên withSuccessHandler(function) cho phép bạn chỉ định một hàm callback phía máy khách để chạy khi máy chủ phản hồi. Nếu hàm máy chủ trả về một giá trị, API sẽ chuyển giá trị đó vào hàm mới dưới dạng tham số.
Ví dụ sau đây cho thấy một cảnh báo của trình duyệt khi máy chủ phản hồi. Xin lưu ý rằng mã mẫu này yêu cầu uỷ quyền vì hàm phía máy chủ đang truy cập vào tài khoản Gmail của bạn. Cách đơn giản nhất để uỷ quyền tập lệnh là chạy hàm getUnreadEmails() theo cách thủ công trong trình chỉnh sửa tập lệnh một lần trước khi bạn tải trang. Ngoài ra, khi triển khai ứng dụng web, bạn có thể chọn thực thi ứng dụng với tư cách là "người dùng truy cập vào ứng dụng web". Trong trường hợp đó, bạn sẽ được nhắc uỷ quyền khi tải ứng dụng.
Code.gs
function doGet() {
return HtmlService.createHtmlOutputFromFile('Index');
}
function getUnreadEmails() {
return GmailApp.getInboxUnreadCount();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
<script>
function onSuccess(numUnread) {
var div = document.getElementById('output');
div.innerHTML = 'You have ' + numUnread
+ ' unread messages in your Gmail inbox.';
}
google.script.run.withSuccessHandler(onSuccess)
.getUnreadEmails();
</script>
</head>
<body>
<div id="output"></div>
</body>
</html>
Trình xử lý lỗi
Trong trường hợp máy chủ không phản hồi hoặc gửi lỗi, withFailureHandler(function) sẽ cho phép bạn chỉ định một trình xử lý lỗi thay vì một trình xử lý thành công, với đối tượng Error (nếu có) được truyền dưới dạng một đối số.
Theo mặc định, nếu bạn không chỉ định trình xử lý lỗi, các lỗi sẽ được ghi vào bảng điều khiển JavaScript. Để ghi đè giá trị này, hãy gọi withFailureHandler(null) hoặc cung cấp một trình xử lý lỗi không làm gì cả.
Như ví dụ này cho thấy, cú pháp cho trình xử lý lỗi gần giống với trình xử lý thành công.
Code.gs
function doGet() {
return HtmlService.createHtmlOutputFromFile('Index');
}
function getUnreadEmails() {
// 'got' instead of 'get' will throw an error.
return GmailApp.gotInboxUnreadCount();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
<script>
function onFailure(error) {
var div = document.getElementById('output');
div.innerHTML = "ERROR: " + error.message;
}
google.script.run.withFailureHandler(onFailure)
.getUnreadEmails();
</script>
</head>
<body>
<div id="output"></div>
</body>
</html>
Đối tượng người dùng
Bạn có thể sử dụng lại cùng một trình xử lý thành công hoặc thất bại cho nhiều lệnh gọi đến máy chủ bằng cách gọi withUserObject(object) để chỉ định một đối tượng sẽ được truyền đến trình xử lý dưới dạng tham số thứ hai.
"Đối tượng người dùng" này – đừng nhầm lẫn với lớp User – cho phép bạn phản hồi ngữ cảnh mà ứng dụng đã liên hệ với máy chủ. Vì các đối tượng người dùng không được gửi đến máy chủ nên hầu như mọi thứ, bao gồm cả hàm, phần tử DOM, v.v. mà không bị hạn chế về tham số và giá trị trả về đối với lệnh gọi máy chủ. Tuy nhiên, đối tượng người dùng không được là đối tượng được tạo bằng toán tử new.
Trong ví dụ này, việc nhấp vào một trong hai nút sẽ cập nhật nút đó bằng một giá trị từ máy chủ trong khi vẫn giữ nguyên nút còn lại, mặc dù các nút này có chung một trình xử lý thành công. Bên trong trình xử lý onclick, từ khoá this
tham chiếu đến chính button.
Code.gs
function doGet() {
return HtmlService.createHtmlOutputFromFile('Index');
}
function getEmail() {
return Session.getActiveUser().getEmail();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
<script>
function updateButton(email, button) {
button.value = 'Clicked by ' + email;
}
</script>
</head>
<body>
<input type="button" value="Not Clicked"
onclick="google.script.run
.withSuccessHandler(updateButton)
.withUserObject(this)
.getEmail()" />
<input type="button" value="Not Clicked"
onclick="google.script.run
.withSuccessHandler(updateButton)
.withUserObject(this)
.getEmail()" />
</body>
</html>
Biểu mẫu
Nếu bạn gọi một hàm máy chủ có phần tử form làm tham số, thì biểu mẫu sẽ trở thành một đối tượng duy nhất có tên trường là khoá và giá trị trường dưới dạng giá trị. Tất cả các giá trị đều được chuyển đổi thành chuỗi, ngoại trừ nội dung của các trường nhập dữ liệu tệp trở thành đối tượng Blob.
Ví dụ này xử lý một biểu mẫu (bao gồm cả trường nhập thông tin tệp) mà không cần tải lại trang; biểu mẫu này sẽ tải tệp lên Google Drive rồi in URL của tệp đó trong trang phía máy khách. Bên trong trình xử lý onsubmit, từ khoá this
tham chiếu đến chính biểu mẫu đó. Lưu ý rằng khi tải tất cả biểu mẫu trong trang, hãy tắt thao tác gửi mặc định bằng preventFormSubmit. Điều này ngăn trang chuyển hướng đến một URL không chính xác trong trường hợp ngoại lệ.
Code.gs
function doGet() {
return HtmlService.createHtmlOutputFromFile('Index');
}
function processForm(formObject) {
var formBlob = formObject.myFile;
var driveFile = DriveApp.createFile(formBlob);
return driveFile.getUrl();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
<script>
// Prevent forms from submitting.
function preventFormSubmit() {
var forms = document.querySelectorAll('form');
for (var i = 0; i < forms.length; i++) {
forms[i].addEventListener('submit', function(event) {
event.preventDefault();
});
}
}
window.addEventListener('load', preventFormSubmit);
function handleFormSubmit(formObject) {
google.script.run.withSuccessHandler(updateUrl).processForm(formObject);
}
function updateUrl(url) {
var div = document.getElementById('output');
div.innerHTML = '<a href="' + url + '">Got it!</a>';
}
</script>
</head>
<body>
<form id="myForm" onsubmit="handleFormSubmit(this)">
<input name="myFile" type="file" />
<input type="submit" value="Submit" />
</form>
<div id="output"></div>
</body>
</html>
Trình chạy tập lệnh
Bạn có thể coi google.script.run là trình tạo cho một "trình chạy tập lệnh". Nếu thêm một trình chạy tập lệnh thành công, trình xử lý lỗi hoặc đối tượng người dùng vào một trình chạy tập lệnh, thì bạn sẽ không thay đổi trình chạy hiện tại; thay vào đó, bạn sẽ lấy lại một trình chạy tập lệnh mới với hành vi mới.
Bạn có thể sử dụng tổ hợp và thứ tự bất kỳ của withSuccessHandler(), withFailureHandler() và withUserObject(). Bạn cũng có thể gọi bất kỳ hàm sửa đổi nào trên trình chạy tập lệnh đã có bộ giá trị. Giá trị mới chỉ ghi đè giá trị trước đó.
Ví dụ sau sẽ thiết lập một trình xử lý lỗi chung cho cả 3 lệnh gọi máy chủ, nhưng gồm 2 trình xử lý thành công riêng biệt:
var myRunner = google.script.run.withFailureHandler(onFailure);
var myRunner1 = myRunner.withSuccessHandler(onSuccess);
var myRunner2 = myRunner.withSuccessHandler(onDifferentSuccess);
myRunner1.doSomething();
myRunner1.doSomethingElse();
myRunner2.doSomething();
Hàm riêng tư
Các hàm máy chủ có tên kết thúc bằng dấu gạch dưới được coi là riêng tư.
google.script không thể gọi các hàm này và tên của các hàm này sẽ không bao giờ được gửi đến ứng dụng. Do đó, bạn có thể sử dụng chúng để ẩn chi tiết triển khai cần được giữ bí mật trên máy chủ. google.script cũng không thể thấy các hàm trong thư viện và các hàm không được khai báo ở cấp cao nhất của tập lệnh.
Trong ví dụ này, hàm getBankBalance() có trong mã ứng dụng; người dùng kiểm tra mã nguồn của bạn có thể phát hiện tên của hàm ngay cả khi bạn không gọi mã đó. Tuy nhiên, các hàm deepSecret_() và obj.objectMethod() hoàn toàn không hiển thị với ứng dụng.
Code.gs
function doGet() {
return HtmlService.createHtmlOutputFromFile('Index');
}
function getBankBalance() {
var email = Session.getActiveUser().getEmail()
return deepSecret_(email);
}
function deepSecret_(email) {
// Do some secret calculations
return email + ' has $1,000,000 in the bank.';
}
var obj = {
objectMethod: function() {
// More secret calculations
}
};
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
<script>
function onSuccess(balance) {
var div = document.getElementById('output');
div.innerHTML = balance;
}
google.script.run.withSuccessHandler(onSuccess)
.getBankBalance();
</script>
</head>
<body>
<div id="output">No result yet...</div>
</body>
</html>
Đổi kích thước hộp thoại trong Google Workspace ứng dụng
Bạn có thể đổi kích thước hộp thoại tuỳ chỉnh trong Google Tài liệu, Trang tính hoặc
Biểu mẫu bằng cách gọi phương thức
google.script.host
setWidth(width) hoặc
setHeight(height) trong
mã phía máy khách. (Để đặt kích thước ban đầu của hộp thoại, hãy dùng các phương thức HtmlOutput
setWidth(width)
và
setHeight(height).)
Lưu ý rằng hộp thoại không căn giữa lại vào cửa sổ chính khi đổi kích thước và
không thể đổi kích thước thanh bên.
Đóng hộp thoại và thanh bên trong Google Workspace
Nếu sử dụng dịch vụ HTML để hiển thị hộp thoại hoặc thanh bên trong Google Tài liệu, Trang tính hoặc Biểu mẫu, thì bạn không thể đóng giao diện bằng cách gọi window.close(). Thay vào đó, bạn phải gọi google.script.host.close().
Để biết ví dụ, hãy xem phần phân phát HTML dưới dạng Google Workspace giao diện người dùng.
Đang di chuyển tiêu điểm của trình duyệt trong Google Workspace
Để chuyển tiêu điểm trong trình duyệt của người dùng từ hộp thoại hoặc thanh bên quay lại
Google Tài liệu, Trang tính hoặc Trình chỉnh sửa Biểu mẫu, bạn chỉ cần gọi phương thức
google.script.host.editor.focus().
Phương thức này đặc biệt hữu ích khi kết hợp với các phương thức Dịch vụ tài liệu Document.setCursor(position) và Document.setSelection(range).