ユーザーのロケールとタイムゾーンへのアクセス

アドオンは、ユーザーのロケールとタイムゾーンにアクセスし、その情報を使用してインターフェースと動作をカスタマイズできます。アドオンがこの情報にアクセスできるように、アドオンのマニフェストを構成する必要があります。

アドオン マニフェストを構成する

次の手順で、ユーザーの言語 / 地域とタイムゾーンの情報にアクセスするようにアドオンを構成できます。

  1. アドオンのマニフェスト ファイルで、addOns.common.useLocaleFromApp フィールドを true に設定します。
  2. マニフェストの oauthScopes リストに次の明示的なスコープを追加します(https://www.googleapis.com/auth/script.locale)。
  3. マニフェストの変更を保存します。

アドオンの oauthScope リストにスコープを追加した場合、ユーザーは次回アドオンを開いたときに、そのアドオンを再承認する必要があります。

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

イベント オブジェクトには、正しく設定されていれば、ユーザーの言語 / 地域情報が含まれます。イベント オブジェクトの commonEventObject サブ構造体に次のフィールドが表示されます。

  • commonEventObject.userLocale - ユーザーの言語と国/地域の識別子。例: en-US
  • commonEventObject.timeZone.offset - 協定世界時(UTC)からのユーザーのタイムゾーン オフセット(ミリ秒単位)。
  • commonEventObject.timeZone.id - ユーザーのタイムゾーン識別子。 例: America/New_York
  • commonEventObject.timeZone - ユーザーのタイムゾーン ID とオフセット。

詳しくは、イベント オブジェクトをご覧ください。

イベント オブジェクトは、ユーザーによるアドオンの操作に応じてアクション コールバック関数に渡されます。また、ホームページやコンテキスト トリガー関数にも渡されます。各コールバック関数またはトリガー関数は、イベント オブジェクトからロケールとタイムゾーン情報を読み取り、必要に応じて使用できます。たとえば、新しいカードに移動するコールバック関数は、カードに追加するテキストを決定する際にロケール文字列を参照することがあります。