Tài nguyên tệp kê khai của Gmail

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

Gmail

Cấu hình Google Workspace tệp kê khai bổ sung cho tiện ích Gmail. Hãy xem phần Mở rộng Gmail bằng Google Workspace các tiện ích bổ sung để biết thêm thông tin.

Biểu diễn dưới dạng JSON 
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
Các trường
authorizationCheckFunction

string

Không dùng nữa. Tên của hàm Apps Script thực hiện các yêu cầu kiểm tra yêu cầu ủy quyền của bên thứ ba. Hàm này được gọi trước khi gọi từng tiện ích bổ sung Google Workspace .

Hàm này không được dùng nữa để tránh độ trễ thực thi không cần thiết. Thay vào đó, tiện ích bổ sung sẽ gửi một ngoại lệ từ lệnh gọi chính, như trong ví dụ này.

composeTrigger

object (ComposeTrigger)

Bắt buộc đối với các thao tác soạn thư. Xác định tập hợp giao diện người dùng có sẵn cho người dùng trong khi soạn email.

Xem phần Mở rộng giao diện người dùng soạn thư bằng các thao tác soạn thư để biết chi tiết.

contextualTriggers[]

object (ContextualTrigger)

Bắt buộc. Danh sách trình kích hoạt sẽ kích hoạt khi mở thư trong Gmail. Khi kích hoạt, trình kích hoạt sẽ thực thi một hàm Apps Script cụ thể, thường là để tạo thẻ mới và cập nhật giao diện người dùng.
homepageTrigger

object (HomepageTrigger)

Quy cách hàm kích hoạt để tạo trang chủ tiện ích bổ sung trong máy chủ của Gmail. Thao tác này sẽ ghi đè addOns.common.homepageTrigger.

Trình kích hoạt Compose

Cấu hình cho thao tác soạn. Hãy xem phần Mở rộng giao diện người dùng trong Compose để biết thêm thông tin.

Biểu diễn dưới dạng JSON 
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
Các trường
draftAccess

string

Xác định cấp độ quyền truy cập dữ liệu mà hàm kích hoạt Compose có thể sử dụng. Các tuỳ chọn hợp lệ là:

  • NONE, chế độ cài đặt mặc định. Điều này khiến đối tượng sự kiện được chuyển vào hàm kích hoạt Compose gần như trống.
  • METADATA sẽ điền đối tượng sự kiện được chuyển vào hàm kích hoạt soạn thư bằng danh sách người nhận thư. Chế độ cài đặt này yêu cầu tiện ích bổ sung phải bao gồm phạm vi gmail.addons.current.message.metadata.
selectActions[]

object (SelectAction)

Danh sách các thao tác soạn tin nên tạo giao diện người dùng. Tuy nhiên, danh sách này chỉ áp dụng cho một thao tác duy nhất cho mỗi tiện ích bổ sung. Thao tác soạn có một biểu tượng tương ứng được hiển thị trong cửa sổ soạn thư của Gmail. Biểu tượng do gmail.logoUrl chỉ định.

Trình kích hoạt theo ngữ cảnh

Cấu hình của trình kích hoạt sẽ kích hoạt khi người dùng mở thư trên Gmail và thư đó đáp ứng một số tiêu chí nhất định. Hãy xem phần Mở rộng giao diện người dùng cho thông báo để biết thêm thông tin.

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

string

Bắt buộc đối với mỗi trình kích hoạt theo ngữ cảnh. Tên của hàm Apps Script sẽ thực thi khi trình kích hoạt kích hoạt.

Xem Hàm kích hoạt theo ngữ cảnh để biết thông tin chi tiết về cách xác định hàm này.

unconditional

object

Bắt buộc đối với mỗi trình kích hoạt theo ngữ cảnh. Dùng để chỉ định rằng trình kích hoạt theo ngữ cảnh sẽ kích hoạt cho tất cả thư trên Gmail khi chúng được mở. Hiện tại, đây là tuỳ chọn duy nhất nên đối tượng này phải luôn là đối tượng trống.

Chọn hành động

Cấu hình thao tác soạn thư xác định hàm nào sẽ chạy khi người dùng chọn thao tác soạn.

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

string

Bắt buộc đối với các thao tác soạn thư. Tên của hàm Apps Script sẽ thực thi khi bạn chọn thao tác soạn này. Hàm kích hoạt soạn này tạo giao diện người dùng soạn tiện ích bổ sung.

Xem chức năng kích hoạt Compose để biết thêm chi tiết.

text

string

Bắt buộc đối với các thao tác soạn thư. Đoạn mô tả ngắn về văn bản trong thao tác soạn này.