Nâng cấp các tiện ích bổ sung cũ dành cho Gmail và Lịch

Nếu đã tạo và phát hành một tiện ích bổ sung để mở rộng Gmail hoặc Lịch, bạn có thể nâng cấp tiện ích đó thành tiện ích bổ sung Google Workspace. Hướng dẫn trên trang này trình bày chi tiết cách thêm chức năng của Google Workspace vào các tiện ích bổ sung hiện có của Gmail hoặc Lịch, sau đó phát hành tiện ích bổ sung đã nâng cấp để người dùng có thể tìm thấy và cài đặt.

Bạn có thể chuyển chức năng mới vào tiện ích bổ sung ban đầu để giữ lại trang thông tin, lượt cài đặt và người dùng trên Google Workspace Marketplace. Việc nâng cấp cũng cho phép bạn tận dụng các tính năng bổ sung mới của Google Workspace, chẳng hạn như trang chủ.

Bước 1: Tạo bản sao của dự án Apps Script của tiện ích bổ sung

Tiện ích bổ sung đã nâng cấp của bạn sử dụng cùng một dự án Google Cloud với tiện ích bổ sung đã phát hành, nhưng điều quan trọng là bạn phải tạo và sử dụng một bản sao của dự án Apps Script cơ bản để người dùng hiện tại không bị ảnh hưởng trong khi bạn đang thử nghiệm phiên bản đã nâng cấp. Việc nâng cấp bản sao của dự án tập lệnh ban đầu cũng có nghĩa là bạn luôn có thể truy cập vào mã gốc và có thể triển khai lại mã đó sau này nếu cần.

  1. Mở dự án Apps Script của tiện ích bổ sung hiện có cho Gmail hoặc tiện ích bổ sung cho cuộc họp trên Lịch.
  2. Ở bên trái, hãy nhấp vào biểu tượng Tổng quan .
  3. Ở bên phải, hãy nhấp vào biểu tượng Tạo bản sao .
  4. Ở bên trái, hãy nhấp vào Project Settings (Cài đặt dự án) > Change project (Thay đổi dự án).
  5. Nhấp vào Số dự án GCP.
  6. Nhập cùng một số dự án liên kết với dự án tiện ích bổ sung Apps Script đã phát hành hiện có của bạn.
  7. Nhấp vào Đặt dự án.

Bước 2: Tích hợp tiện ích bổ sung của Google Workspace

Bạn phải thiết kế và triển khai mọi tính năng tiện ích bổ sung của Google Workspace mà bạn muốn thêm vào tiện ích bổ sung của mình.

  1. Lên kế hoạch về nội dung sẽ hiển thị trong thẻ trang chủ của tiện ích bổ sung và liệu nội dung đó có xuất hiện trong Gmail, Lịch, Drive hay bất kỳ tổ hợp nào của ba ứng dụng lưu trữ này hay không. Nếu bạn muốn có trang chủ trên nhiều máy chủ lưu trữ, hãy quyết định xem có thể sử dụng cùng một trang chủ hay bạn muốn có thẻ trang chủ tuỳ chỉnh cho từng máy chủ lưu trữ.
  2. Trong dự án Apps Script bổ sung đã sao chép, hãy tạo thẻ trang chủ bằng các hàm homepageTrigger. Hãy nhớ đưa vào mọi hàm hoặc logic hỗ trợ cần thiết để kiểm soát giao diện trang chủ mới.
  3. Hãy cân nhắc việc thêm thẻ theo bối cảnh được kích hoạt bằng hành động của người dùng, chẳng hạn như mở một luồng thư trong Gmail hoặc sự kiện trên Lịch.

  4. Cập nhật mọi hoạt động truy cập vào đối tượng sự kiện trong tiện ích bổ sung (trong các hàm gọi lại tiện ích hoặc trong các hàm trình kích hoạt theo ngữ cảnh) để sử dụng cấu trúc đối tượng sự kiện đã cập nhật. Cấu trúc mới vẫn chứa các trường đối tượng sự kiện giống như các trường đối tượng sự kiện mà các tiện ích bổ sung hội nghị trên Gmail và Lịch sử dụng, nhưng các trường ban đầu đó không còn được dùng nữa và cuối cùng sẽ bị xoá.

Bước 3: Cập nhật tệp kê khai của tiện ích bổ sung

Cách lưu trữ thông tin cấu hình trong cấu trúc tệp kê khai của các tiện ích bổ sung Google Workspace đã thay đổi đáng kể so với cấu trúc mà các tiện ích bổ sung Gmail và tiện ích bổ sung hội nghị trên Lịch sử dụng. Khi nâng cấp tiện ích bổ sung, bạn phải cập nhật các trường tệp kê khai của dự án Apps Script của tiện ích bổ sung theo bảng bên dưới. Bạn phải cập nhật tất cả tài sản phụ có liên quan thành tài sản addOns mới.

Ngoài ra, hãy nhớ cập nhật trường oauthScopes của tệp kê khai nếu cần để phản ánh các quyền mà tiện ích bổ sung đã cập nhật yêu cầu.

Để tìm hiểu thêm về tệp kê khai tiện ích bổ sung của Google Workspace, hãy xem phần Tệp kê khai.

Tiện ích bổ sung dành cho Gmail

Trường tệp kê khai gốc Việc cần làm
gmail.composeTrigger Chuyển đến addOns.gmail.composeTrigger.
gmail.contextualTriggers[] Di chuyển danh sách này vào addOns.gmail.contextualTriggers[].
gmail.logoUrl Chuyển đến addOns.common.logoUrl.
gmail.name Chuyển đến addOns.common.name.
gmail.openLinkUrlPrefixes[] Di chuyển danh sách này vào addOns.common.openLinkUrlPrefixes[].
gmail.primaryColor Chuyển đến addOns.common.layoutProperties.primaryColor.
gmail.secondaryColor Chuyển đến addOns.common.layoutProperties.secondaryColor.
gmail.universalActions[] Di chuyển danh sách này vào addOns.common.universalActions[].
gmail.universalActions[].text Di chuyển từng trường gmail.universalActions[].text sang một trường addOns.common.universalActions[].label tương ứng.
gmail.useLocalFromApp Chuyển đến addOns.common.useLocaleFromApp.

Tiện ích bổ sung cho tính năng hội nghị truyền hình trên Lịch

Trường tệp kê khai gốc Việc cần làm
calendar.createSettingsUrlFunction Chuyển đến addOns.calendar.createSettingsUrlFunction.
calendar.conferenceSolution[] Chuyển đến addOns.calendar.conferenceSolution[].
calendar.logoUrl Chuyển đến addOns.common.logoUrl.
calendar.name Chuyển đến addOns.common.name.

Bước 4: Kiểm thử tiện ích bổ sung đã nâng cấp

Để kiểm thử tiện ích bổ sung đã nâng cấp trước khi phát hành, hãy xem phần Kiểm thử tiện ích bổ sung của Google Workspace.

Bước 5: Yêu cầu xem xét tiện ích bổ sung đã nâng cấp

Tất cả tiện ích bổ sung của Google Workspace, dù là tiện ích bổ sung được nâng cấp hay được tạo từ đầu, đều phải được phê duyệt thì mới có thể xuất hiện trong Google Workspace Marketplace.

Hãy làm theo các bước sau để gửi tiện ích bổ sung để được xem xét:

  1. Đảm bảo tiện ích bổ sung của bạn đáp ứng tất cả các yêu cầu về việc phát hành tiện ích bổ sung.

  2. Tạo một bản triển khai có phiên bản của tiện ích bổ sung Google Workspace (trong dự án Apps Script mới) bằng cách sử dụng phiên bản mã mà bạn muốn phát hành. Đừng cố gắng phát hành bằng cách triển khai đầu.

  3. Nếu đã thêm các phạm vi mới trong khi nâng cấp tiện ích bổ sung, bạn phải yêu cầu xác minh OAuth. Ví dụ: nếu tiện ích bổ sung của Gmail sử dụng các phạm vi mới của Drive hoặc Lịch trong phiên bản tiện ích bổ sung của Google Workspace, thì bạn phải gửi các phạm vi mới đó để xác minh. Quy trình xác minh thường mất vài ngày để hoàn tất, vì vậy, hãy bắt đầu quy trình này sớm nhất có thể. Đảm bảo tiện ích bổ sung của bạn đã được xác minh trước khi chuyển sang Bước 6.

Bước 6: Cung cấp tiện ích bổ sung đã nâng cấp

  1. Mở SDK Google Workspace Marketplace.

  2. Ở bên trái, hãy nhấp vào Cấu hình. Bảng điều khiển này chứa một biểu mẫu để bạn cung cấp thông tin về tiện ích bổ sung.

  3. Cập nhật nội dung mô tả ngắn, nội dung mô tả chi tiết và ảnh chụp màn hình của trang thông tin để phản ánh chức năng mới của tiện ích bổ sung Google Workspace.

  4. Trong phần Tiện ích, hãy nhấp vào nút Nâng cấp lên tiện ích bổ sung của Google Workspace. Trong hộp văn bản xuất hiện, hãy nhập mã triển khai mới mà bạn đã tạo cho tiện ích bổ sung Google Workspace ở bước trước. Nếu mã triển khai của bạn hợp lệ, một danh sách máy chủ được hỗ trợ sẽ xuất hiện.

  5. Nếu bạn đã thêm các phạm vi mới vào tiện ích bổ sung Google Workspace, hãy nhớ thêm các phạm vi đó vào phần Phạm vi OAuth 2.0 trên trang Cấu hình. Các phạm vi được liệt kê trong phần đó phải khớp chính xác với các phạm vi được liệt kê trong tệp kê khai của tiện ích bổ sung.

  6. Xác minh rằng thông tin bạn đã nhập vào biểu mẫu là chính xác. Sau đó, nhấp vào Lưu thay đổi.

Nếu bạn có câu hỏi hoặc gặp vấn đề trong quá trình nâng cấp tiện ích bổ sung của Google Workspace này, hãy liên hệ với chúng tôi.

Câu hỏi thường gặp

Sau đây là các câu hỏi thường gặp về việc nâng cấp tiện ích bổ sung:

Tôi có thể nâng cấp tiện ích bổ sung dành cho Trình chỉnh sửa không?

Bạn có thể chuyển hầu hết các tiện ích bổ sung của Trình chỉnh sửa sang tiện ích bổ sung của Google Workspace. Tuy nhiên, bạn không thể nâng cấp các tiện ích bổ sung này lên tiện ích bổ sung của Google Workspace dễ dàng như các tiện ích bổ sung cho Gmail và Lịch.

Nếu muốn di chuyển tiện ích bổ sung của Trình chỉnh sửa sang tiện ích bổ sung của Google Workspace, bạn cần viết lại giao diện người dùng của tiện ích bổ sung từ HTML thành giao diện dựa trên thẻ và cập nhật cách xử lý JavaScript thành Dịch vụ thẻ.

Một số dịch vụ trong tiện ích bổ sung Trình chỉnh sửa hiện có của bạn có thể không có trong Dịch vụ thẻ. Ví dụ: nếu tiện ích bổ sung của Trình chỉnh sửa có bộ chọn tệp, thì sẽ không có bộ chọn tương đương nào trong Dịch vụ thẻ cho các tiện ích bổ sung của Google Workspace.

Tôi có thể tạo một tiện ích bổ sung riêng cho Google Workspace và giữ lại tiện ích bổ sung hiện có không?

Bạn có thể tạo các tiện ích bổ sung khác cho Google Workspace dưới nhiều tên thương hiệu, nhưng chúng tôi không cho phép các tiện ích bổ sung hội nghị riêng biệt cho Gmail hoặc Lịch dưới cùng một tên thương hiệu với tiện ích bổ sung của bạn cho Google Workspace. Nếu bạn có câu hỏi hoặc muốn yêu cầu trường hợp ngoại lệ, hãy liên hệ với chúng tôi.

Người dùng của tôi có cần phải uỷ quyền lại tiện ích bổ sung sau khi tiện ích đó được nâng cấp không?

Miễn là tiện ích bổ sung Google Workspace của bạn sử dụng cùng một dự án trên Google Cloud Platform (GCP) cơ bản, với mã ứng dụng khách OAuth được liên kết, người dùng sẽ không cần uỷ quyền lại các quyền mà họ đã uỷ quyền trước đó cho tiện ích bổ sung ban đầu của bạn. Tuy nhiên, nếu bạn thêm các phạm vi mới trong quá trình nâng cấp, thì người dùng phải cho phép các phạm vi mới đó trong lần đầu tiên họ sử dụng phiên bản Google Workspace của tiện ích bổ sung.

Tôi có thể nâng cấp tiện ích Chrome lên tiện ích bổ sung Google Workspace và chuyển người dùng không?

Không. Bạn không thể chuyển người dùng, lượt cài đặt và bài đánh giá trang thông tin của một tiện ích Chrome. Bạn phải tạo một tiện ích bổ sung mới cho Google Workspace và hướng người dùng tiện ích Chrome đến Google Workspace Marketplace.

Tôi có thể gói nhiều tiện ích bổ sung với tiện ích bổ sung dành cho Google Workspace không?

Xem phần Liệt kê các công cụ tích hợp ứng dụng cùng nhau.