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 Google Workspace trong Gmail. Tệp kê khai của 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 nếu các thành phần đó mở rộng Gmail.

Gmail

Cấu hình tệp kê khai của tiện ích bổ sung Google Workspace cho các tiện ích của Gmail. Xem bài viết Mở rộng Gmail bằng tiện ích bổ sung cho 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)
  }
}
Các 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 hoạt động 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 mỗi lần gọi Tiện ích bổ sung Google Workspace.

Ngừng sử dụng hàm này để 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ệ khỏi lệnh gọi chính, như minh hoạ trong ví dụ này.

composeTrigger

object (ComposeTrigger)

Bắt buộc đối với 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.

Hãy xem phần Mở rộng giao diện người dùng Compose bằng các thao tác soạn thư để 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 người dùng mở thư trong Gmail. Khi được 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 về hàm của điều kiện kích hoạt để tạo trang chủ của tiện ích bổ sung trên máy chủ lưu trữ Gmail. Thao tác này sẽ ghi đè phương thức addOns.common.homepageTrigger.

ComposeTrigger

Cấu hình cho một thao tác soạn thư. Hãy xem bài viết 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)
    }
  ]
}
Các trường
draftAccess

string

Xác định cấp truy cập dữ liệu có sẵn cho hàm kích hoạt Compose. Có các lựa chọn hợp lệ sau đây:

  • 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ư trống.
  • METADATA để điền danh sách người nhận tin nhắn của đố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 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ó một 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 này do gmail.logoUrl chỉ định.

ContextualTrigger

Cấu hình cho 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. Xem phần Mở rộng giao diện người dùng của tin nhắn để 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 đ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 phần 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. 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ư trong Gmail khi người dùng mở các thư đó. 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 Compose xác định hàm sẽ 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
}
Các trường
runFunction

string

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

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 thao tác soạn thư. Một đoạn mô tả ngắn dạng văn bản về thao tác soạn thư này.