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 tiện ích bổ sung của Google Workspace phải có tất 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 tiện ích bổ sung của Google Workspace cho các tiện ích Gmail. Hãy xem bài viết Mở rộng Gmail bằng các 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ệnh 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ư 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.

Hãy xem phần 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 các điều kiện kích hoạt sẽ kích hoạt khi một thư được mở trong Gmail. Khi kích hoạt, điều kiện 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)

Thông số kỹ thuật của 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 hành động 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 có sẵn cho hàm trình kích hoạt Compose. Sau đây là các tuỳ chọn hợp 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 Compose 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 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 Compose tạo giao diện người dùng Compose; tuy nhiên, danh sách này chỉ giới hạn ở 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ởi 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ư 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 Tập lệnh ứng dụng thực thi khi điều kiện kích hoạt được kích hoạt.

Hãy xem phần Hàm điều kiện 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 trình kích hoạt theo ngữ cảnh sẽ kích hoạt cho tất cả thư Gmail khi thư được mở. Đây hiện là tuỳ chọn duy nhất, vì vậy, đối tượng này phải luôn là đối tượng trống.

SelectAction

Cấu hình hành động soạn thư xác định hàm nào sẽ chạy khi người dùng chọn hành động 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 thực thi khi hành động soạn thư này được chọn. Hàm trình kích hoạt Compose này sẽ tạo giao diện người dùng Compose bổ sung.

Hãy xem phần Hàm điều kiện kích hoạt trong 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 Compose này.