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

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 của 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 mở rộng Gmail.

Gmail

Cấu hình tệp kê khai tiện ích bổ sung của Google Workspace cho các tiện ích dành cho 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 theo yêu cầu về việc 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 của 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ư 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 có sẵn cho người dùng trong khi soạn email.

Xem nội dung Mở rộng giao diện người dùng Compose bằng các thao tác trong Compose để biết thông tin chi tiết.

contextualTriggers[]

object (ContextualTrigger)

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

object (HomepageTrigger)

Thông số kỹ thuật của hàm kích hoạt để tạo trang chủ tiện ích bổ sung trong máy chủ lưu trữ Gmail. Thao tác này sẽ ghi đè addOns.common.homepageTrigger.

ComposeTrigger

Cấu hình cho một thao tác soạn thư. 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 dành cho một hàm kích hoạt trong Compose. Có các lựa chọn hợp lệ như sau:

  • 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 Compose gần như là trống.
  • METADATA, điền danh sách người nhận tin nhắn đến đối tượng sự kiện được truyền đến hàm kích hoạt Compose. 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 trong Compose tạo ra giao diện người dùng Compose. Tuy nhiên, danh sách này giới hạn ở một thao tác duy nhất cho mỗi tiện ích bổ sung. Thao tác soạn thư có biểu tượng tương ứng hiển thị trong cửa sổ soạn thư của Gmail. Biểu tượng này do gmail.logoUrl chỉ định.

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 của 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 thực thi khi trình kích hoạt kích hoạt.

Hãy xem bài viết 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 điều kiện kích hoạt theo bối cảnh. Dùng để chỉ định rằng điều kiện kích hoạt theo ngữ cảnh sẽ kích hoạt đối với mọi thư Gmail khi chúng được mở. Hiện tại, đây là tuỳ 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 trong Compose xác định hàm sẽ chạy khi người dùng chọn thao tác trong Compose.

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 này trong Compose. Hàm kích hoạt Compose này tạo ra giao diện người dùng tiện ích bổ sung trong Compose.

Hãy xem bài viết Hàm 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 soạn thư này.