Cấu trúc tệp kê khai

Trang này mô tả cấp cao nhất của cấu trúc dữ liệu JSON trong tệp kê khai Google Apps Script. Tệp kê khai xác định chức năng hoặc mục đích của dự án Apps Script.

Biểu diễn dưới dạng JSON 
{
  "addOns": {
    object (AddOns)
  },
  "chat": {},
  "dependencies": {
    object (Dependencies)
  },
  "exceptionLogging": string,
  "executionApi": {
    object (ExecutionApi)
  },
  "oauthScopes": [
    string
  ],
  "runtimeVersion": string,
  "sheets": {
    object (Sheets)
  },
  "timeZone": string,
  "urlFetchWhitelist": [
    string
  ],
  "webapp": {
    object (Webapp)
  }
}
Trường
addOns

object (AddOns)

Cấu hình tài nguyên dự án nếu được triển khai dưới dạng tiện ích bổ sung của Google Workspace.

chat

object

Cấu hình dự án nếu được triển khai dưới dạng ứng dụng Google Chat.

Đối với các ứng dụng Chat mới, hãy sử dụng trường addOns.chat. Nếu bạn duy trì một ứng dụng nhắn tin hiện có sử dụng trường chat, thì đó phải là một đối tượng trống.

Để định cấu hình chi tiết ứng dụng nhắn tin, bạn phải bật API Google Chat. Để biết thông tin chi tiết, hãy xem phần Định cấu hình API Google Chat.

Apps Script xử lý việc uỷ quyền ở cấp tập lệnh. Một ứng dụng nhắn tin cần được uỷ quyền không thể thực hiện các thao tác cho đến khi người dùng uỷ quyền cho ứng dụng đó. Để đăng thông báo trước khi uỷ quyền, hãy thêm một đối tượng addToSpaceFallbackMessage vào tệp kê khai. Nếu ứng dụng nhắn tin của bạn yêu cầu logic khởi chạy, thì bạn có thể cần sao chép logic này trong thao tác onMessage.

Ví dụ sau đây cho thấy một ứng dụng nhắn tin phản hồi bằng một thông điệp chào mừng mặc định khi người dùng thêm ứng dụng đó vào một phòng Chat:

        "chat": {
          "addToSpaceFallbackMessage": "Thank you for adding me!"
        }
dependencies

object (Dependencies)

Cấu hình của các dịch vụ nâng cao và thư viện được bật để dự án tập lệnh sử dụng.

exceptionLogging

string

Vị trí ghi lại các ngoại lệ. Các chế độ cài đặt hợp lệ bao gồm:

  • NONE: Các trường hợp ngoại lệ không được ghi lại.
  • STACKDRIVER: Các ngoại lệ được ghi vào nhật ký trong Stackdriver.
executionApi

object (ExecutionApi)

Cấu hình có thể thực thi API của dự án tập lệnh. Chỉ sử dụng tham số này nếu dự án được triển khai để thực thi API.

oauthScopes[]

string

Định nghĩa về phạm vi uỷ quyền mà dự án tập lệnh sử dụng.

runtimeVersion

string

Phiên bản thời gian chạy mà tập lệnh đang sử dụng. Nếu bạn bỏ qua, tập lệnh sẽ sử dụng thời gian chạy mặc định (STABLE). Các lựa chọn hợp lệ bao gồm:

  • STABLE: Thời gian chạy mặc định (hiện tại là Rhino).
  • V8: Thời gian chạy dựa trên V8.
  • DEPRECATED_ES5: Thời gian chạy Rhino. Giá trị này ngăn quá trình di chuyển tự động sang V8.
sheets

object (Sheets)

Cấu hình tài nguyên xác định macro Trang tính.

timeZone

string

Múi giờ của tập lệnh trong giá trị ZoneId, chẳng hạn như "America/Denver".
urlFetchWhitelist[]

string

Danh sách tiền tố URL HTTPS. Nếu có, mọi điểm cuối URL được tìm nạp đều phải khớp với một tiền tố trong danh sách này. Điều này giúp bảo vệ dữ liệu người dùng. Trường này không bắt buộc đối với các hoạt động triển khai thử nghiệm nhưng bắt buộc đối với các hoạt động triển khai. Tìm hiểu thêm về cách đưa URL vào danh sách cho phép.

webapp

object (Webapp)

Cấu hình ứng dụng web của dự án tập lệnh, được dùng nếu dự án được triển khai dưới dạng ứng dụng web.