Trang này được dịch bởi Cloud Translation API.

Thư viện

Thư viện là một dự án tập lệnh có các hàm có thể được sử dụng lại trong các tập lệnh khác.

Nhận quyền truy cập vào thư viện

Để đưa một thư viện vào dự án của mình, bạn phải có ít nhất quyền truy cập ở cấp độ xem. Nếu bạn không phải là tác giả của thư viện mà bạn muốn thêm vào, hãy liên hệ với tác giả và yêu cầu quyền truy cập.

Bạn cần có mã tập lệnh của thư viện mà bạn muốn đưa vào. Khi có quyền truy cập vào thư viện, bạn có thể tìm thấy mã tập lệnh trên trang Cài đặt dự án .

Thêm thư viện vào dự án tập lệnh của bạn

Ở bên trái trình chỉnh sửa Apps Script, bên cạnh phần "Libraries" (Thư viện), hãy nhấp vào biểu tượng Add a library (Thêm thư viện) .
Trong trường "ID tập lệnh", hãy dán mã nhận dạng tập lệnh của thư viện.
Nhấp vào Tra cứu.
Nếu gặp lỗi, hãy đảm bảo rằng bạn có ít nhất quyền truy cập ở cấp độ xem vào dự án mà bạn đang cố gắng đưa vào.
Nhấp vào trình đơn thả xuống Version (Phiên bản) rồi chọn phiên bản thư viện mà bạn muốn sử dụng.
Kiểm tra xem tên "Giá trị nhận dạng" mặc định có phải là tên bạn muốn sử dụng với thư viện này hay không. Đây là tên mà tập lệnh của bạn dùng để tham chiếu đến thư viện. Ví dụ: nếu đặt thuộc tính này thành Test thì bạn có thể gọi một phương thức của thư viện đó như sau: Test.libraryMethod().
Nếu bạn sử dụng tên nhận dạng khớp với tên của một dịch vụ hiện có, chẳng hạn như MailApp hoặc thư viện đã thêm trước đó, thì thư viện bạn thêm gần đây sẽ ghi đè dịch vụ hoặc thư viện hiện có.
Nhấp vào Thêm.

Sử dụng thư viện

Sử dụng thư viện đi kèm giống như khi bạn sử dụng dịch vụ mặc định. Ví dụ: nếu Test là giá trị nhận dạng cho thư viện của bạn, hãy nhập Test theo sau là một dấu chấm để xem danh sách các phương thức trong thư viện.

Bạn có thể mở tài liệu tham khảo cho thư viện đi kèm bằng cách làm theo các bước sau:

Ở bên trái trình chỉnh sửa tập lệnh, bên cạnh tên thư viện, hãy nhấp vào biểu tượng Tuỳ chọn khác > Mở trong thẻ mới.

Xoá thư viện

Ở bên trái trình chỉnh sửa tập lệnh, bên cạnh tên thư viện, hãy nhấp vào biểu tượng Tuỳ chọn khác > Xoá > Xoá thư viện.

Cập nhật thư viện

Bạn có thể thay đổi phiên bản của thư viện hoặc cập nhật giá trị nhận dạng của thư viện.

Ở bên trái trình chỉnh sửa, trong phần "Thư viện", hãy nhấp vào tên của thư viện.
Chỉnh sửa rồi nhấp vào Lưu.

Tạo và chia sẻ thư viện

Để sử dụng và chia sẻ dự án tập lệnh của bạn dưới dạng thư viện, hãy làm theo các bước dưới đây.

Tạo quá trình triển khai theo phiên bản của tập lệnh.
Ít nhất phải có quyền truy cập ở cấp độ xem với tất cả người dùng tiềm năng của thư viện.
Cung cấp cho những người dùng đó mã nhận dạng tập lệnh. Bạn có thể tìm thấy mã này trên trang Cài đặt dự án .

Các phương pháp hay nhất

Dưới đây là một số nguyên tắc cần tuân thủ khi viết thư viện:

Chọn một tên có ý nghĩa cho dự án của bạn vì tên này được dùng làm giá trị nhận dạng mặc định khi người khác thêm thư viện của bạn vào.
Nếu muốn một hoặc nhiều phương thức của tập lệnh không hiển thị (hoặc không sử dụng được) với người dùng thư viện, bạn có thể kết thúc tên phương thức bằng dấu gạch dưới. Ví dụ: myPrivateMethod_().
Người dùng thư viện chỉ nhìn thấy các thuộc tính chung có thể liệt kê. Dữ liệu này bao gồm phần khai báo hàm, các biến được tạo bên ngoài hàm bằng var và các thuộc tính được đặt rõ ràng trên đối tượng toàn cục. Ví dụ: Object.defineProperty() có enumerable được đặt thành false sẽ tạo một biểu tượng mà bạn có thể dùng trong thư viện, nhưng người dùng không thể truy cập vào biểu tượng này.

Nếu muốn người dùng thư viện sử dụng tính năng tự động hoàn thành của trình chỉnh sửa tập lệnh và tài liệu được tạo tự động, bạn phải có tài liệu kiểu JSDoc cho tất cả các hàm. Ví dụ:

/**
 * Raises a number to the given power, and returns the result.
 *
 * @param {number} base the number we're raising to a power
 * @param {number} exp the exponent we're raising the base to
 * @return {number} the result of the exponential calculation
 */
function power(base, exp) { ... }

Phạm vi tài nguyên

Có 2 loại tài nguyên khi bạn làm việc với thư viện: dùng chung và không được chia sẻ. Tài nguyên dùng chung có nghĩa là cả thư viện và tập lệnh bao gồm (include) đều có quyền truy cập tích hợp vào cùng một thực thể của tài nguyên. Sơ đồ sau đây minh hoạ một tài nguyên dùng chung bằng ví dụ về Thuộc tính người dùng:

Tài nguyên được chia sẻ

Tài nguyên không được chia sẻ có nghĩa là cả thư viện và tập lệnh bao gồm đều chỉ có quyền truy cập tích hợp vào bản sao tài nguyên của chúng. Tuy nhiên, thư viện có thể cung cấp quyền truy cập vào các tài nguyên không được chia sẻ bằng cách có các hàm rõ ràng hoạt động trên các tài nguyên đó. Dưới đây là ví dụ về một hàm mà bạn sẽ đưa vào thư viện của mình để hiển thị các Thuộc tính của tập lệnh:

  function getLibraryProperty(key) {
    return ScriptProperties.getProperty(key);
  }

Sơ đồ dưới đây minh hoạ một tài nguyên không được chia sẻ bằng cách sử dụng ví dụ về Thuộc tính tập lệnh:

Tài nguyên không được chia sẻ

Bảng này liệt kê các tài nguyên được chia sẻ và không được chia sẻ để bạn tham khảo:

Tài nguyên	Đã chia sẻ*	Không được chia sẻ**	Ghi chú
Khoá			Cùng một phiên bản hiển thị cho tất cả các tập lệnh khi được tạo trong thư viện.
Thuộc tính của tập lệnh			Cùng một phiên bản hiển thị cho tất cả các tập lệnh khi được tạo trong thư viện.
Bộ nhớ đệm			Cùng một phiên bản hiển thị cho tất cả các tập lệnh khi được tạo trong thư viện.
Điều kiện kích hoạt			Các điều kiện kích hoạt đơn giản được tạo trong thư viện không được tập lệnh đưa vào kích hoạt.
ScriptApp
UiApp
Thuộc tính người dùng
Trình ghi nhật ký và bản chép lời thực thi
Sites, Trang tính và vùng chứa khác			Lệnh gọi đến `getActive()` trả về vùng chứa của tập lệnh bao gồm.
MailApp và GmailApp
* Điều này có nghĩa là thư viện không có bản sao tính năng/tài nguyên riêng mà thay vào đó, thư viện sẽ sử dụng bản sao do tập lệnh/tài nguyên tạo ra. ** Điều này có nghĩa là thư viện có một thực thể riêng của tài nguyên/tính năng và tất cả tập lệnh sử dụng thư viện đó đều dùng chung và có quyền truy cập vào cùng một thực thể đó.

Kiểm thử thư viện

Để kiểm thử thư viện, hãy sử dụng tính năng triển khai đầu. Bất cứ ai có quyền truy cập cấp người chỉnh sửa đối với tập lệnh đều có thể sử dụng tính năng triển khai head.

Gỡ lỗi thư viện

Khi sử dụng trình gỡ lỗi trong một dự án có thư viện, bạn có thể sử dụng một hàm của thư viện đi kèm. Mã này sẽ xuất hiện trong trình gỡ lỗi ở chế độ chỉ có thể xem và ở đúng phiên bản.