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

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

Gmail

Cấu hình tệp kê khai tiện ích bổ sung Google Workspace cho các tiện ích Gmail. Hãy xem bài viết Mở rộng Gmail bằng tiện ích bổ sung của Google Workspace để 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)
  }
}
Trường
authorizationCheckFunction

string

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

Hàm này không còn đượ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ư minh hoạ 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 mà người dùng có thể sử dụng trong khi soạn email.

Hãy xem phần Mở rộng giao diện người dùng Compose bằng các thao tác Compose để biết thông tin chi tiết.

contextualTriggers[]

object (ContextualTrigger)

Bắt buộc. Danh sách các điều kiện kích hoạt sẽ kích hoạt khi một thư được mở trong Gmail. Khi điều kiện kích hoạt được thực hiện, điều kiện này 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ủ của tiện ích bổ sung trong máy chủ Gmail. Thao tác này sẽ ghi đè addOns.common.homepageTrigger.

ComposeTrigger

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

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

string

Xác định cấp độ truy cập dữ liệu có sẵn cho một hàm kích hoạt Compose. Các lựa 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 truyền đến hàm kích hoạt thành phần hầu như trống.
  • METADATA, điền đối tượng sự kiện được truyền vào hàm kích hoạt soạn tin nhắn bằng danh sách người nhận tin nhắn. Chế độ cài đặt này yêu cầu tiện ích bổ sung phải có phạm vi gmail.addons.current.message.metadata.
selectActions[]

object (SelectAction)

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

ContextualTrigger

Cấu hình cho một điều kiện kích hoạt sẽ kích hoạt khi người dùng mở một thư trong 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 thông báo để biết thêm thông tin.

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

string

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

Hãy xem Hàm kích hoạt theo bối 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 điều kiện kích hoạt theo bối cảnh. Được dùng để chỉ định rằng điều kiện kích hoạt theo bối cảnh sẽ kích hoạt cho tất cả thư trong Gmail khi thư được mở. Đây hiện là lựa chọn duy nhất, vì vậy, đây phải luôn là một đối tượng trống.

SelectAction

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

Biểu diễn dưới dạng JSON 
{
  "runFunction": string,
  "text": string
}
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 thư này. Hàm kích hoạt Compose này tạo giao diện người dùng Compose của tiện ích bổ sung.

Hãy xem Hàm điều kiện kích hoạt Compose để biết thông tin chi tiết.

text

string

Bắt buộc đối với các thao tác soạn thư. Nội dung mô tả ngắn bằng văn bản về thao tác kết hợp này.