Google Workspace アドオン ユーザーのロケールとタイムゾーンを取得する

このガイドでは、アドオンでユーザーの言語 / 地域とタイムゾーンを取得し、その情報を使用してインターフェースと動作をカスタマイズする方法について説明します。Google Apps Script 固有のガイドについては、Apps Script デベロッパー向けドキュメントのユーザーの言語 / 地域とタイムゾーンを取得するをご覧ください。

アドオンのデプロイ リソースを構成する

アドオンがユーザーの言語 / 地域とタイムゾーンを取得できるようにするには、アドオンのデプロイ リソースを構成します。

  1. アドオンのデプロイ リソースで、addOns.common.useLocaleFromApp フィールドを true に設定します。
  2. デプロイ リソースの oauthScopes リストに https://www.googleapis.com/auth/script.locale 認可スコープを追加します。このスコープにより、アドオンに国、言語、タイムゾーンを表示する権限が付与されます。
  3. 更新したデプロイ リソースを保存します。

アドオンの oauthScopes リストにスコープを追加した後、ユーザーは次回アドオンを使用するときに再承認する必要があります。

ロケールとタイムゾーンの情報を取得する

イベント オブジェクトには、ユーザーの言語 / 地域に関する情報が含まれます。この情報は、次の commonEventObject プロパティから取得できます。

  • commonEventObject.userLocale - ユーザーの言語と国 / 地域の識別子。たとえば、en-US は米国で話されている英語を表します。
  • commonEventObject.timeZone.offset - 協定世界時(UTC)からのユーザーのタイムゾーン オフセット(ミリ秒単位)。
  • commonEventObject.timeZone.id - ユーザーのタイムゾーン識別子。例: America/New_York
  • commonEventObject.timeZone - ユーザーのタイムゾーン ID とオフセット。

イベント オブジェクトは、ユーザーがアドオンを操作する(たとえば、ボタンをクリックする)と、action コールバック関数、homepageTrigger 関数、contextualTrigger 関数に渡されます。各コールバック関数またはトリガー関数は、イベント オブジェクトからロケールとタイムゾーンの情報を取得し、必要に応じて使用できます。たとえば、新しいカードに移動するコールバック関数は、カードに追加するテキストを決定する際に、言語 / 地域の文字列を参照できます。