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 của dự án 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 của 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 của dự án nếu được triển khai dưới dạng một ứng dụng Google Chat.

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

Để định cấu hình thông tin chi tiết của ứng dụng Chat, 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. Các ứng dụng trò chuyện yêu cầu uỷ quyền không thể thực hiện bất kỳ hành động nào cho đến khi người dùng uỷ quyền cho ứng dụng trò chuyện. Để đăng một thông báo trước khi uỷ quyền, bạn có thể thêm một đối tượng addToSpaceFallbackMessage vào tệp kê khai. Nếu ứng dụng Chat 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 Chat phản hồi bằng một tin nhắn chào mừng mặc định khi người dùng thêm ứng dụng đó vào một không gian 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ệ là:

  • NONE cho biết các trường hợp ngoại lệ không được ghi lại.
  • STACKDRIVER cho biết các ngoại lệ được ghi vào Stackdriver.
executionApi

object (ExecutionApi)

Cấu hình có thể thực thi API của dự án tập lệnh. Chỉ 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 trường này không có trong tệp kê khai, thì 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ệ cho trường này là:

  • STABLE cho biết thời gian chạy mặc định (hiện là Rhino).
  • V8 cho biết môi trường thời gian chạy do V8 hỗ trợ.
  • DEPRECATED_ES5 cho biết môi trường thời gian chạy Rhino. Việc đặt giá trị này cũng 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 của Trang tính.

timeZone

string

Múi giờ của tập lệnh trong một trong các giá trị ZoneId có sẵn, 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 phải khớp với một trong các tiền tố trong danh sách này. Điều này có thể giúp bảo vệ dữ liệu người dùng. Đây là trường 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ấu hình này chỉ được dùng nếu dự án được triển khai dưới dạng một ứng dụng web.