Tài nguyên tệp kê khai của Tiện ích bổ sung

Cấu hình tài nguyên dùng để xác định nội dung và hành vi của Tiện ích bổ sung Google Workspace. Các tệp kê khai Tiện ích bổ sung Google Workspace phải có tất cả các thành phần được đánh dấu là Bắt buộc.

AddOns

Cấp cao nhất của cấu hình tệp kê khai của tiện ích bổ sung trên Google Workspace.

Biểu diễn dưới dạng JSON 
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  }
}
Các trường
common

object (Common)

Bắt buộc. Xác định các giá trị phổ biến cho Tiện ích bổ sung của Google Workspace mà mọi ứng dụng lưu trữ đều sử dụng. Một số giá trị xác định tại đây được dùng làm giá trị mặc định khi các giá trị cụ thể của một máy chủ cụ thể bị bỏ qua.

calendar

object (Calendar)

Bắt buộc nếu tiện ích bổ sung của Google Workspace mở rộng Lịch. Cấu hình của giao diện và hoạt động của tiện ích bổ sung trên Google Workspace trong ứng dụng lưu trữ Lịch Google. Nếu bạn bỏ qua trường này, thì tiện ích bổ sung sẽ bị tắt trong Lịch Google.

drive

object (Drive)

Bắt buộc nếu Tiện ích bổ sung của Google Workspace mở rộng Google Drive. Cấu hình của giao diện và hành vi của tiện ích bổ sung trên Google Workspace trong ứng dụng lưu trữ Google Drive. Nếu bạn bỏ qua trường này, thì tiện ích bổ sung sẽ bị tắt trong Google Drive.

gmail

object (Gmail)

Bắt buộc nếu Tiện ích bổ sung của Google Workspace mở rộng Gmail. Cấu hình của giao diện và hành vi của tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Gmail. Nếu trường này bị bỏ qua, thì tiện ích bổ sung sẽ bị tắt trong Gmail.

docs

object (Docs)

Bắt buộc nếu Tiện ích bổ sung của Google Workspace mở rộng Tài liệu. Cấu hình giao diện và hành vi của Tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Tài liệu. Nếu bạn bỏ qua trường này, thì tiện ích bổ sung sẽ bị tắt trong Tài liệu.

sheets

object (Sheets)

Bắt buộc nếu Tiện ích bổ sung của Google Workspace mở rộng Trang tính. Cấu hình giao diện và hành vi của Tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Trang tính. Nếu trường này bị bỏ qua, thì tiện ích bổ sung sẽ bị tắt trong Trang tính.

slides

object (Slides)

Bắt buộc nếu tiện ích bổ sung của Google Workspace mở rộng Trang trình bày. Cấu hình giao diện và hành vi của Tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Trang trình bày. Nếu trường này bị bỏ qua, thì tiện ích bổ sung sẽ bị tắt trong Trang trình bày.

Phổ biến

Cấu hình tệp kê khai cho các tham số phổ biến cho mọi ứng dụng lưu trữ. Một số giá trị đã xác định tại đây được dùng làm giá trị mặc định khi bạn bỏ qua các giá trị cụ thể của một máy chủ cụ thể.

Biểu diễn dưới dạng JSON 
{
  "homepageTrigger": {
    object (HomepageTrigger)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "logoUrl": string,
  "name": string,
  "openLinkUrlPrefixes": [
    string
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "useLocaleFromApp": boolean
}
Các trường
homepageTrigger

object (HomepageTrigger)

Thông số kỹ thuật mặc định của hàm kích hoạt để tạo trang chủ của tiện ích bổ sung. Quy cách này được sử dụng nếu không xác định được điều kiện kích hoạt trang chủ dành riêng cho từng máy chủ. Nếu bạn cũng bỏ qua thuộc tính này, thì một thẻ trang chủ chung sẽ được tạo và sử dụng khi cần.
layoutProperties

object (LayoutProperties)

Cấu hình cho các màu dùng trên thanh công cụ và các nút của tiện ích bổ sung.
logoUrl

string

Bắt buộc. URL của hình ảnh hiển thị trong thanh công cụ. URL phải ở chế độ công khai.
name

string

Bắt buộc. Tên của tiện ích bổ sung xuất hiện trên thanh công cụ.
openLinkUrlPrefixes[]

string

Bắt buộc nếu tiện ích bổ sung hiển thị đường liên kết ra ngoài bất kỳ, dù là trong các tiện ích dùng OpenLink hay tiện ích văn bản sử dụng thẻ ký tự liên kết HTML. Danh sách các tiền tố URL loại HTTPS. Để bảo vệ dữ liệu người dùng, mọi đường liên kết do tiện ích bổ sung hiển thị phải khớp với một trong các tiền tố trong danh sách này.

Hãy xem bài viết URL trong danh sách cho phép để biết thêm thông tin chi tiết.

universalActions[]

object (UniversalAction)

Danh sách các thao tác chung luôn có sẵn trong giao diện người dùng tiện ích bổ sung.
useLocaleFromApp

boolean

Nếu là true, tiện ích bổ sung đối tượng sự kiện được chuyển đến hàm gọi lại hành động hoặc hàm kích hoạt sẽ bao gồm thông tin về ngôn ngữ và múi giờ của người dùng. Giá trị mặc định là false.

Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

LayoutProperties

Cấu hình kiểm soát thanh công cụ của tiện ích bổ sung Google Workspace, màu và hình thức của nút.

Biểu diễn dưới dạng JSON 
{
  "primaryColor": string,
  "secondaryColor": string
}
Các trường
primaryColor

string

Màu của thanh công cụ. Mặc định là màu xám (#424242).
secondaryColor

string

Màu mặc định của nút. Màu mặc định là màu chính (nếu được đặt); nếu không, màu mặc định sẽ là màu xanh dương (#2196F3).

UniversalAction

Cấu hình cho một hành động chung. Khi được chọn, thao tác chung sẽ mở đường liên kết URL đã chỉ định hoặc chạy hàm Apps Script đã chỉ định.

Biểu diễn dưới dạng JSON 
{
  "label": string,

  // Union field rule can be only one of the following:
  "openLink": string,
  "runFunction": string,
  // End of list of possible types for union field rule.

}
Các trường
label

string

Bắt buộc đối với mỗi hành động chung. Văn bản xuất hiện trong trình đơn giao diện người dùng cho hành động này.
runFunction

string

Bắt buộc đối với mỗi hành động chung nếu không có openLink. Nếu được cung cấp, tên của hàm Apps Script sẽ thực thi khi người dùng chọn hành động này.

Xem hướng dẫn Hành động chung để biết thêm thông tin chi tiết.