Trang chủ

Trang chủ là một tính năng tiện ích bổ sung mới của Google Workspace cung cấp khả năng xác định một hoặc nhiều thẻ không theo ngữ cảnh. Các thẻ không theo ngữ cảnh được dùng để hiển thị giao diện người dùng khi người dùng bên ngoài một ngữ cảnh cụ thể, chẳng hạn như khi người dùng đang xem hộp thư đến Gmail của họ nhưng chưa mở thư hoặc thư nháp.

Trang chủ cho phép bạn hiển thị nội dung không theo ngữ cảnh, giống như Các ứng dụng của Google trong bảng điều khiển bên truy cập nhanh (Keep, Lịch và Tasks). Trang chủ cũng có thể cung cấp tên bắt đầu khi người dùng mở tiện ích bổ sung của bạn lần đầu tiên và rất hữu ích cho việc giảng dạy cách tương tác với tiện ích bổ sung của bạn.

Bạn có thể xác định trang chủ cho tiện ích bổ sung bằng cách chỉ định tiện ích này trong dự án tệp kê khai và triển khai một hoặc nhiều hàm homepageTrigger (xem Cấu hình trang chủ).

Bạn có thể có nhiều trang chủ, mỗi trang chủ cho một ứng dụng lưu trữ mà tiện ích bổ sung của bạn mở rộng. Bạn cũng có thể quyết định xác định một trang chủ mặc định chung được sử dụng trong những máy chủ mà bạn chưa chỉ định trang chủ tuỳ chỉnh.

Trang chủ tiện ích bổ sung sẽ xuất hiện khi một trong các điều kiện sau được đáp ứng:

  • Khi tiện ích bổ sung được mở lần đầu trong máy chủ (sau khi uỷ quyền).
  • Khi người dùng chuyển từ ngữ cảnh theo ngữ cảnh sang một ngữ cảnh không theo ngữ cảnh khi tiện ích bổ sung đang mở. Ví dụ: từ chỉnh sửa sự kiện trên Lịch cho đến Lịch chính.
  • Khi người dùng nhấp vào nút quay lại đủ số lần để bật các thẻ khác ra khỏi ngăn xếp nội bộ.
  • Khi một lượt tương tác trên giao diện người dùng trong một thẻ không theo ngữ cảnh dẫn đến một Navigation.popToRoot() .

Bạn không bắt buộc phải thiết kế một trang chủ, nhưng bạn nên thiết kế trang chủ; nếu bạn không định nghĩa một thẻ chung chứa tên tiện ích bổ sung của bạn sẽ được sử dụng mỗi khi người dùng điều hướng vào trang chủ.

Cấu hình trang chủ

Tiện ích bổ sung của Google Workspace sử dụng addOns.common.homepageTrigger để định cấu hình nội dung tiện ích bổ sung trên trang chủ (không theo ngữ cảnh) mặc định cho tất cả các ứng dụng lưu trữ trong tiện ích bổ sung tệp kê khai:

    {
      // ...
      "addOns": {
        // ...
        "common": {
          // ...
          "homepageTrigger": {
            "runFunction": "myFunction",
            "enabled": true
          }
        }
      }
    }

  • runFunction: Tên của hàm Apps Script mà Lệnh gọi khung Tiện ích bổ sung của Google Workspace để hiển thị các thẻ tiện ích bổ sung trên trang chủ. Chức năng này là hàm kích hoạt trang chủ. Hàm này phải tạo và trả về một mảng Card tạo nên giao diện người dùng trang chủ. Nếu nhiều thẻ được trả lại, ứng dụng lưu trữ hiển thị các tiêu đề thẻ trong danh sách mà người dùng có thể chọn từ (xem Trả nhiều thẻ).

  • enabled: Liệu có nên bật thẻ trên trang chủ cho phạm vi này hay không. Chiến dịch này là trường không bắt buộc và đặt mặc định là true. Đặt điều kiện này thành false nguyên nhân thẻ trang chủ bị vô hiệu hoá cho tất cả máy chủ (trừ phi bị ghi đè cho các thẻ đó host; xem bên dưới).

Ngoài cấu hình thông thường, còn có các cơ chế ghi đè cho mỗi máy chủ lưu trữ có cấu trúc giống hệt nhau hiện có trong config, tại addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger, và cứ tiếp tục như vậy:

    {
      ...
      "addOns": {
        ...
        "common": {
          // By default, call 'buildHomePage' to render homepage content
          // in all hosts. Since calendar.homepageTrigger below overrides
          // this in Calendar and Drive and the homepageTrigger is disabled
          // for Gmail, this homepage function never executes.
          "homepageTrigger": { "runFunction": "buildHomePage" }
        },
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "buildDriveHomepage" }
        }
        "gmail": {
          // Disable homepage add-on content in Gmail.
          "homepageTrigger": { "enabled": false }
        },
        ...
      }
    }

Lưu ý rằng đoạn mã này tương đương với tệp kê khai trích dẫn sau:

    {
      ...
      "addOns": {
        ...
        "common": { /* ... */ }, // Omitted a default homepageTrigger specification.
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "myCalendarFunction" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "myDriveFunction" }
        }
        "gmail": { /* ... */ },
        ...
      }
    }

Không có phần nào trong số homepageTrigger là phần bắt buộc. Tuy nhiên, giao diện người dùng hiển thị cho tiện ích bổ sung trong một sản phẩm lưu trữ cụ thể bất kỳ phụ thuộc vào sự hiện diện của tương ứng với trường tệp kê khai và liệu có trường nào homepageTrigger. Ví dụ sau đây cho thấy hàm kích hoạt tiện ích bổ sung nào được thực thi (nếu có) để tạo giao diện người dùng trang chủ cho tệp kê khai khác nhau cấu hình:

Luồng trên trang chủ

Đối tượng sự kiện trên trang chủ

Khi được gọi, hàm kích hoạt trang chủ (runFunction) được mô tả ở trên là đã truyền một đối tượng sự kiện chứa dữ liệu từ ngữ cảnh lệnh gọi.

Đối tượng sự kiện trên trang chủ không bao gồm tiện ích hoặc thông tin ngữ cảnh; thời gian được giới hạn ở đối tượng sự kiện chung trường:

Hãy xem phần Đối tượng sự kiện để biết thêm thông tin chi tiết.

Các thẻ không theo ngữ cảnh khác

Giao diện người dùng tiện ích bổ sung của bạn có thể chứa các thẻ không theo ngữ cảnh bổ sung không trang chủ. Ví dụ: trang chủ của bạn có thể có nút mở ra "Cài đặt" nơi người dùng có thể điều chỉnh các chế độ cài đặt tiện ích bổ sung (chẳng hạn như các chế độ cài đặt này) trong hầu hết các trường hợp sẽ không phụ thuộc vào ngữ cảnh và do đó, không phụ thuộc vào ngữ cảnh).

Thẻ không theo ngữ cảnh được xây dựng giống như bất kỳ thẻ nào khác; điểm khác biệt duy nhất là hành động hoặc sự kiện nào tạo và hiển thị thẻ. Xem Phương thức điều hướng để biết thông tin chi tiết về cách tạo hiệu ứng chuyển đổi giữa các thẻ.