Google Workspace 外掛程式應與擴充的主機應用程式的樣式和版面配置一致。他們應使用熟悉的控制項和行為，自然地擴充 UI。本指南說明如何處理文字、圖片、控制項和品牌宣傳，以提升使用者體驗。
如果外掛程式會開啟獨立網頁，且這些網頁是外掛程式運作不可或缺的一部分 (例如外掛程式的設定頁面)，請確保這些網頁也遵循這些樣式規範。
文字和圖片
本節說明如何在外掛程式中正確使用文字和圖片。
外掛程式名稱
您必須在專案資訊清單中設定外掛程式名稱，並在設定外掛程式以供發布時設定名稱。 這個名稱會顯示在許多地方，例如 Google Workspace Marketplace 產品資訊和選單中。選擇名稱時：
- 使用每字字首大寫格式。
- 避免使用標點符號，尤其是括號，除非是品牌名稱的一部分。
- 盡量簡短，最好不要超過 15 個半形字元。在 Google Workspace Marketplace 資訊和其他位置，系統可能會自動截斷過長的名稱。
- 外掛程式名稱不得包含「Google」、「Gmail」或其他 Google 產品名稱。
- 請勿在加購內容名稱中加入「加購」一詞。
- 省略版本資訊。
寫作風格
您不必寫太多內容，圖示、版面配置和簡短標籤應能清楚說明大部分動作。如果發現外掛程式的某個部分需要比簡短標籤更詳盡的說明，建議您建立外掛程式的專屬說明網頁，並提供該網頁的連結。
撰寫 UI 文字時：
- 使用句首字母大寫格式 (特別是按鈕、標籤和資訊卡動作)。
- 請盡量使用簡短的文字，避免使用專業術語或縮寫。
通用和資訊卡動作
如果您在外掛程式中使用通用動作或資訊卡動作，這些動作會顯示為您定義的資訊卡中的選單項目。您可以為這些動作選擇要在選單中使用的文字。選擇要使用的文字時：
- 避免選單文字只是重複外掛程式名稱。
- 每個選單項目都以動作字詞開頭，例如「執行」、「設定」或「建立」。
- 請說明工作，而不是動作顯示的 UI 元件。
- 如果動作會啟動工作流程，且沒有單一動詞可描述其功能，請將動作命名為「開始」。
- 請減少選單項目數量，避免使用者必須捲動瀏覽長長的清單。如要實作更多動作，不妨考慮使用多張資訊卡，每張卡片都包含不同的動作。
錯誤訊息
發生錯誤時，請務必使用簡單易懂的語言。從使用者的角度說明問題，並建議修正方式。
- 請勿允許使用者查看程式碼擲回的任何例外狀況。請改用
try...catch陳述式攔截例外狀況，然後顯示容易理解的錯誤訊息。 - 發布前，請檢查外掛程式是否會在 UI 中顯示偵錯資訊。
教學型內容
您可能希望設計卡片，向使用者顯示說明資訊或說明外掛程式的操作方式。如果您為外掛程式建立說明內容，請記得：
- 盡可能以項目符號或編號清單顯示操作說明。引導使用者完成操作，並清楚參照具名的 UI 元素。
- 請務必清楚說明所有規定，例如以特定方式設定試算表。
- 歡迎連結至外部說明內容，例如支援網頁。
圖片
外掛程式使用的圖片可以是內建圖示類型，也可以是網址指定的公開代管圖片。使用代管圖片時，請確保所有外掛程式使用者都能存取這些圖片。
控制項
本節提供互動式小工具的使用者體驗指南。
按鈕
請使用按鈕控制使用者介面的主要動作，而非其他小工具。
- 大多數文字按鈕標籤應以動詞開頭。
- 在大多數情況下，按鈕列最多只能有三個按鈕。
DecoratedText
DecoratedText 小工具 可讓您呈現附有圖示、按鈕或切換鈕的文字內容。
- 文字內容應採用句首字母大寫格式。
- 如果 DecoratedText 小工具的文字無法完整顯示在可用空間中，系統會截斷文字。因此，請盡量縮短文字內容。
選取輸入內容
您可以在外掛程式中使用各種選取輸入小工具：下拉式選取方塊、核取方塊和選項按鈕。
- 如果使用者可以選取多個選項，或完全不選取任何選項，請使用核取方塊。 如果使用者只能選擇一個選項，請使用圓形按鈕 (或選取選單)。 如果想在 UI 中節省空間，並提供簡短的替代方案清單，請使用下拉式選單。
- 為每個選項指派的文字使用句首字母大寫格式。
- 請避免使用選取項目變更來觸發難以復原的重大動作，因為使用者在選取時經常會出錯。請改為加入可讀取目前所選值的按鈕，然後觸發動作。
- 如果是下拉式選單，請依字母順序或所有使用者都能理解的邏輯架構排序選項 (例如依序顯示星期幾，從週日或週一開始)。
- 將特定選取輸入小工具中的選項數量限制在合理的範圍內。如果選項太多，使用者可能會覺得小工具難以使用。在這種情況下，建議將選項分成不同類別，並使用多個小工具。
輸入文字
文字輸入欄位可供使用者輸入字串資料。
- 請勿使用文字輸入，讓使用者輸入一組特定可能項目中的其中一個。請改用下拉式選單。
- 使用提示和建議，協助使用者輸入正確格式和內容的文字。
- 如果要輸入的文字超過幾個字，請使用多行文字輸入。
品牌宣傳
本節提供使用者體驗指南，說明如何在外掛程式介面中加入品牌元素。
在外掛程式中
如要在外掛程式 UI 中加入品牌宣傳，請簡短輕巧地呈現。這有助於使用者專注於外掛程式功能。
- 外掛程式的所有方面都必須遵守品牌宣傳指南。
- 請勿加入「Google」、「Gmail」或其他 Google 產品名稱。
- 請勿加入 Google 產品圖示，即使經過修改也一樣。
- 品牌宣傳文字中請勿加入「外掛程式」一詞。
- 品牌宣傳文字應不超過幾個字。
在 Google Workspace Marketplace 中
設定要發布的外掛程式時，您會提供多個圖像和文字素材資源，用於建立 Google Workspace Marketplace 資訊。
商店資訊和這些素材資源的所有方面都必須遵守品牌宣傳指南。