存取使用者語言代碼和時區

外掛程式可以存取使用者的語言代碼和時區，並使用該資訊自訂介面和行為。您必須設定外掛程式的資訊清單，才能允許外掛程式存取這項資訊。

設定外掛程式資訊清單

您可以按照下列步驟設定外掛程式，以便存取使用者語言代碼和時區資訊：

  1. 在外掛程式的資訊清單檔案中，將 addOns.common.useLocaleFromApp 欄位設為 true。
  2. 如果沒有，請在資訊清單的 oauthScopes 清單中新增下列明確範圍：https://www.googleapis.com/auth/script.locale
  3. 儲存資訊清單變更。

如果您將範圍新增至外掛程式的 oauthScope 清單，則使用者在下次開啟外掛程式時必須重新授權。

取得語言代碼和時區資訊

事件物件會在正確設定時記錄使用者語言代碼資訊。下列欄位會顯示在事件物件的 commonEventObject 子結構中：

  • commonEventObject.userLocale：使用者的語言和國家/地區 ID。例如 en-US。
  • commonEventObject.timeZone.offset：使用者的時區偏移，以毫秒為單位，自世界標準時間 (UTC)。
  • commonEventObject.timeZone.id：使用者的時區 ID。例如 America/New_York。
  • commonEventObject.timeZone：使用者的時區 ID 和偏移量。

詳情請參閱事件物件。

在使用者與外掛程式互動時，事件物件會傳遞至動作回呼函式，並傳遞至首頁和內容相關觸發條件函式。每個回呼或觸發條件函式都可以從事件物件讀取語言代碼和時區資訊，並視需要使用。舉例來說，前往新卡片的回呼函式可能會在決定要新增至資訊卡的文字時參照語言代碼字串。