首頁

首頁是 Google Workspace 的全新外掛程式功能 ，以利定義一或多張非內容資訊卡。 非內容資訊卡的用途，是在使用者 不特定情境的資訊，例如使用者正在查看 Gmail 收件匣時 但尚未開啟郵件或草稿

首頁 會顯示非背景資訊，例如 Google 應用程式 快速存取側邊面板 (Keep、Google 日曆和 Tasks)。首頁也可以提供初始指引 會顯示使用者初次開啟外掛程式的時間，對於教學也很有幫助 新的使用者與外掛程式互動的方式

你可以在專案中指定外掛程式的首頁 資訊清單並實作一或多個 homepageTrigger 函式 (請參閱 「首頁設定」)。

您可以建立多個首頁，每個首頁分別對應至每個外掛程式的應用程式 。您也可以定義一個常見的預設首頁，也就是 用於您尚未指定自訂首頁的主機。

系統會在符合下列任一條件時顯示外掛程式首頁：

  • 首次在主機中開啟這個外掛程式時 (取得授權後)。
  • 使用者從內容比對內容切換至非情境式背景資訊時 。舉例來說，從編輯日曆活動到 。
  • 當使用者點選返回按鈕夠多次時 將所有其他資訊卡彈出。
  • 在非內容資訊卡中的 UI 互動導致 Navigation.popToRoot()敬上 呼叫。

雖然不是強制規定，但我們強烈建議您設計首頁如果您沒有定義任何通用卡片 是每次使用者瀏覽內容時 例如首頁。

首頁設定

Google Workspace 外掛程式會使用 addOns.common.homepageTrigger敬上 ] 欄位設定預設首頁 (非內容相關) 外掛程式內容 外掛程式中的所有代管應用程式 資訊清單：

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

  • runFunction：Cloud Script 函式的名稱 Google Workspace 外掛程式架構會叫用，顯示首頁外掛程式資訊卡。 這個函式是首頁觸發函式。這個函式必須建立 然後傳回 Card 的陣列 構成首頁 UI 的物件。如果傳回多張卡片， 主機應用程式會在清單中顯示可供選取的卡片標頭 來自 (請參閱 退回多張卡片)。

  • enabled：是否要針對這個範圍啟用首頁資訊卡。這個 欄位為選填，預設值為 true。將此項目設為 false 的原因 停用所有主機的首頁資訊卡 (除非為該資訊卡覆寫這項設定) host;請參閱下文)。

，瞭解如何調查及移除這項存取權。

除了常用設定以外 每個主機應用程式的 config、addOns.gmail.homepageTrigger、addOns.calendar.homepageTrigger 依此類推

    {
      ...
      "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 }
        },
        ...
      }
    }

請注意，這相當於下列資訊清單摘錄：

    {
      ...
      "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": { /* ... */ },
        ...
      }
    }

所有 homepageTrigger 個區段皆為必填。不過， 是否使用特定主機產品，則取決於 對應資訊清單欄位，並指出是否有相關聯的資訊清單 homepageTrigger。以下範例說明哪些外掛程式觸發條件函式 系統會執行 (如有) 來為不同的資訊清單建立首頁 UI 配置：

首頁流程

首頁事件物件

呼叫時，上述首頁觸發函式 (runFunction) 會改為 傳遞事件物件 包含叫用情境的資料

首頁事件物件不包含小工具或情境資訊；這個 傳遞的資訊僅限於 常見的事件物件 欄位：

  • commonEventObject.clientPlatform
  • commonEventObject.hostApp
  • commonEventObject.userLocale 和 commonEventObject.userTimezone (但 請參閱「存取使用者語言代碼和時區」一文 )。

詳情請參閱事件物件。

其他非內容資訊卡

外掛程式 UI 可包含其他非情境資訊卡， 首頁。舉例來說，首頁上可能會有一個按鈕，可開啟 「設定」可供使用者調整外掛程式設定 (例如設定) 的資訊卡 在大多數情況下，與上下文無關，因此與內容無關。

非內容卡的建構方式與其他卡片類似；唯一的差別是 產生哪些動作或事件並顯示資訊卡詳情請見 瀏覽方法 ，進一步瞭解如何建立資訊卡之間的轉場效果。