google.script.run là một API JavaScript không đồng bộ phía máy khách, 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 minh hoạ 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 một ứng dụng web và truy cập vào URL của ứng dụng, bạn sẽ không thấy gì. Tuy nhiên, nếu xem nhật ký, bạn sẽ thấy hàm máy chủ doSomething() đã được gọi.
Các lệnh gọi phía ứng dụng đến các hàm phía máy chủ là 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 đến dòng mã tiếp theo mà không cần đợi 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 lúc, thì 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 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 cuộc gọi thứ 11 trong khi 10 cuộc gọi vẫn đang chạy, thì hàm 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 nghĩ đến hạn chế này, đặc biệt là vì hầu hết các trình duyệt đều đã 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 đều trì hoãn các yêu cầu dư thừa của máy chủ cho đến khi một trong các yêu cầu hiện 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ủ có các tham số từ ứng dụng. Tương tự, một hàm máy chủ có thể trả về một giá trị cho máy khách dưới dạng một tham số được truyền đến một trình xử lý thành công.
Các tham số và giá trị trả về hợp lệ là các nguyên hàm JavaScript như Number, Boolean, String hoặc null, cũng như các đối tượng và mảng JavaScript được tạo thành từ các nguyên hàm, đối tượng và mảng. Một phần tử form trong trang cũng hợp lệ dưới dạng một tham số, nhưng phải là tham số duy nhất của hàm và không hợp lệ dưới dạng giá trị trả về. Yêu cầu sẽ không thành công nếu bạn cố gắng truyền Date, Function, phần tử DOM ngoài form hoặc loại bị cấm khác, bao gồm cả các loại bị cấm bên trong đối tượng hoặc mảng. Các đối tượng tạo ra các 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.
Xin lưu ý rằng đố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 một hàm 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 máy khách sẽ không bị ảnh hưởng.
Trình xử lý thành công
Vì mã phía máy khách tiếp tục đến dòng tiếp theo mà không cần đợi lệnh gọi máy chủ hoàn tất, withSuccessHandler(function) cho phép bạn chỉ định một hàm gọi lại 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ị, thì API sẽ truyền giá trị đó đến hàm mới dưới dạng một 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ẫu mã này cần có quyền 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 cho tập lệnh là chạy hàm getUnreadEmails() theo cách thủ công từ 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 này dưới dạng "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ặp lỗi, withFailureHandler(function) cho phép bạn chỉ định trình xử lý lỗi thay vì 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 một trình xử lý lỗi, thì các lỗi sẽ được ghi vào bảng điều khiển JavaScript. Để ghi đè điều 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ả.
Cú pháp của trình xử lý lỗi gần giống với trình xử lý thành công, như ví dụ này cho thấy.
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ể dùng lại cùng một trình xử lý thành công hoặc không thành công 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 (khô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 chúng có thể là hầu hết mọi thứ, bao gồm cả các hàm, phần tử DOM, v.v., mà không có các hạn chế về tham số và giá trị trả về cho các lệnh gọi máy chủ. Tuy nhiên, các đối tượng người dùng không thể là các đối tượng được tạo bằng toán tử new.
Trong ví dụ này, khi nhấp vào một trong hai nút, nút đó sẽ được cập nhật bằng một giá trị từ máy chủ trong khi nút còn lại không thay đổi, mặc dù cả hai nút đều dùng chung một trình xử lý thành công. Bên trong trình xử lý onclick, từ khoá this đề cập đế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àm khoá và giá trị trường làm 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 đầu vào tệp, nội dung này sẽ trở thành các đối tượng Blob.
Ví dụ này xử lý một biểu mẫu, bao gồm cả trường nhập tệp, mà không cần tải lại trang; ví dụ này tải tệp lên Google Drive rồi in URL của tệp trong trang phía máy khách. Trong trình xử lý onsubmit, từ khoá this đề cập đến chính biểu mẫu. Xin lưu ý rằng khi tải, tất cả các biểu mẫu trong trang đều bị vô hiệu hoá hành động 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 xảy ra một 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à một trình tạo cho "trình chạy tập lệnh". Nếu thêm trình xử lý thành công, trình xử lý lỗi hoặc đối tượng người dùng vào trình chạy tập lệnh, bạn sẽ không thay đổi trình chạy hiện có; thay vào đó, bạn sẽ nhận được một trình chạy tập lệnh mới có hành vi mới.
Bạn có thể sử dụng mọi tổ hợp và mọi thứ tự 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 một trình chạy tập lệnh đã đặt giá trị. Giá trị mới sẽ ghi đè giá trị trước đó.
Ví dụ này đặt một trình xử lý lỗi chung cho cả 3 lệnh gọi máy chủ, nhưng có 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ư.
Các hàm này không thể được gọi bằng google.script và tên của chúng không bao giờ được gửi đến máy khách. Do đó, bạn có thể sử dụng các khoá này để ẩ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ể xem 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 này ngay cả khi bạn không gọi hàm. Tuy nhiên, các hàm deepSecret_() và obj.objectMethod() hoàn toàn không hiển thị đối với máy khách.
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>Thay đổi kích thước hộp thoại trong các ứng dụng Google Workspace
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 các 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 sẽ không căn giữa lại trong cửa sổ mẹ khi được đổi kích thước và bạn 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 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, 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().
Để xem ví dụ, hãy xem phần về phân phát HTML dưới dạng giao diện người dùng Google Workspace.
Di chuyển tiêu điểm 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 trở lại trình chỉnh sửa Google Tài liệu, Trang tính hoặc Biểu mẫu, 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 Document service (Dịch vụ tài liệu) Document.setCursor(position) và Document.setSelection(range).