公開したアドオンをアップグレードする

Gmail またはカレンダーを拡張するアドオンをすでに作成、公開している場合は、Google Workspace アドオンにアップグレードできます。このページでは、Google Workspace の機能を既存の Gmail アドオンまたはカレンダーのアドオンに追加し、アップグレードされたアドオンを公開して検出とインストールができるようにする方法を説明します。

新しい機能を元のアドオンに移行して、Google Workspace Marketplace のリスティング、インストール、ユーザーを保持できます。アップグレードすると、ホームページなどの新しい Google Workspace アドオン機能を活用することもできます。

手順 1: アドオンの Apps Script プロジェクトのコピーを作成する

アップグレードしたアドオンは、公開済みのアドオンと同じ Google Cloud プロジェクトを使用しますが、基盤となる Apps Script プロジェクトのコピーを作成して使用し、アップグレードされたバージョンのテスト中に既存のユーザーが影響を受けないようにすることが重要です。元のスクリプト プロジェクトのコピーをアップグレードする場合も、元のコードにいつでもアクセスでき、必要に応じて後で再デプロイできます。

  1. 既存の Gmail アドオンまたはカレンダー会議アドオンの Apps Script プロジェクトを開きます。
  2. 左側の [概要] をクリックします。
  3. 右側にある、コピーを作成アイコン をクリックします。
  4. 左側で、[プロジェクトの設定] > [プロジェクトを変更] をクリックします。
  5. [GCP プロジェクト番号] をクリックします。
  6. 既存の公開済みアドオン Apps Script プロジェクトに関連付けられているプロジェクト番号と同じ番号を入力します。
  7. [プロジェクトを設定] をクリックします。

ステップ 2: Google Workspace アドオンを統合する

アドオンに追加する Google Workspace アドオン機能を設計して実装する必要があります。

  1. アドオンのホームページ カードに表示するコンテンツと、Gmail、カレンダー、ドライブ、または 3 つのホストの任意の組み合わせに表示するコンテンツを計画します。複数のホストでホームページを設定する場合は、同じホームページにするか、ホストごとにカスタム ホームページ カードを使用するかを決定します。
  2. コピーしたアドオンの Apps Script プロジェクトで、homepageTrigger 関数を使用してホームページ カードを作成します。新しいホームページ インターフェースの制御に必要なサポート関数やロジックを含めます。
  3. Gmail のメッセージ スレッドカレンダーの予定を開くなど、ユーザーの操作によってトリガーされるコンテキスト カードの追加を検討してください。

  4. アドオン(ウィジェット コールバック関数またはコンテキスト トリガー関数)のイベント オブジェクトへのアクセスを更新して、更新されたイベント オブジェクト構造を使用するようにします。新しい構造には、Gmail とカレンダーの会議アドオンで使用されているものと同じイベント オブジェクト フィールドが含まれていますが、これらの元のフィールドは非推奨であり、最終的に削除される予定です。

ステップ 3: アドオンのマニフェストを更新する

Google Workspace アドオンのマニフェスト構造で構成情報を保存する方法は、Gmail アドオンとカレンダー会議アドオンで使用される構造とは大きく変更されました。アドオンをアップグレードする際には、次の表に従ってアドオンの Apps Script プロジェクトのマニフェスト フィールドを更新する必要があります。関連するすべてのサブプロパティを、新しい addOns プロパティに更新する必要があります。

必要に応じて、マニフェストの oauthScopes フィールドも更新し、更新されたアドオンに必要な権限を反映します。

Google Workspace アドオン マニフェストの詳細については、マニフェストをご覧ください。

Gmail のアドオン

元のマニフェスト フィールド 対応が必要です
gmail.composeTrigger addOns.gmail.composeTrigger に移動。
gmail.contextualTriggers[] リストを addOns.gmail.contextualTriggers[] に移動します。
gmail.logoUrl addOns.common.logoUrl に移動。
gmail.name addOns.common.name に移動。
gmail.openLinkUrlPrefixes[] リストを addOns.common.openLinkUrlPrefixes[] に移動します。
gmail.primaryColor addOns.common.layoutProperties.primaryColor に移動。
gmail.secondaryColor addOns.common.layoutProperties.secondaryColor に移動します。
gmail.universalActions[] リストを addOns.common.universalActions[] に移動します。
gmail.universalActions[].text gmail.universalActions[].text フィールドを対応する addOns.common.universalActions[].label フィールドに移動します。
gmail.useLocalFromApp addOns.common.useLocaleFromApp に移動。

カレンダー会議アドオン

元のマニフェスト フィールド 対応が必要です
calendar.createSettingsUrlFunction addOns.calendar.createSettingsUrlFunction に移動。
calendar.conferenceSolution[] addOns.calendar.conferenceSolution[] に移動。
calendar.logoUrl addOns.common.logoUrl に移動。
calendar.name addOns.common.name に移動。

手順 4: アップグレードしたアドオンをテストする

アップグレードしたアドオンを公開前にテストするには、Google Workspace アドオンのテストをご覧ください。

ステップ 5: アップグレードしたアドオンの審査をリクエストする

アップグレードされたアドオンか、ゼロから作成されたアドオンかにかかわらず、すべての Google Workspace アドオンは、Google Workspace Marketplace に掲載される前に承認される必要があります。

審査のためにアドオンを送信する手順は次のとおりです。

  1. アドオンがアドオン公開の要件をすべて満たしていることを確認します。

  2. 公開するコードのバージョンを使用して、(新しい Apps Script プロジェクトで)Google Workspace アドオンのバージョニングされたデプロイを作成します。ヘッドデプロイを使用して公開しようとしないでください。

  3. アドオンのアップグレード中に新しいスコープを追加した場合は、OAuth 検証をリクエストする必要があります。たとえば、Gmail アドオンで Google Workspace アドオン バージョンの新しいドライブまたはカレンダーのスコープを使用している場合は、それらの新しいスコープを提出して検証を受ける必要があります。審査が完了するまでに数日かかることがあるため、できるだけお早めに手続きを開始してください。ステップ 6 に進む前に、アドオンが検証されていることを確認してください。

ステップ 6: アップグレードしたアドオンを利用できるようにする

  1. Google Workspace Marketplace SDK を開きます。

  2. 左側の [構成] をクリックします。このパネルには、アドオンに関する情報を入力するフォームがあります。

  3. リスティングの簡単な説明、詳細な説明、スクリーンショットを更新して、Google Workspace アドオンの新機能を反映します。

  4. [拡張機能] で、[Upgrade to Google Workspace Add-on] ボタンをクリックします。表示されたテキスト ボックスに、前の手順で Google Workspace アドオン用に作成した新しいデプロイ ID を入力します。デプロイ ID が有効な場合、サポートされているホストのリストが表示されます。

  5. Google Workspace アドオンに新しいスコープを追加した場合は、[構成] ページの [OAuth 2.0 スコープ] セクションに追加してください。このセクションに記載されているスコープは、アドオンのマニフェストにリストされているスコープと完全に一致している必要があります。

  6. フォームに入力した情報が正しいことを確認します。次に、[変更を保存] をクリックします。

この Google Workspace アドオンのアップグレード プロセスについてご質問がある場合や問題が発生した場合は、お問い合わせください。

よくある質問

以下は、アドオンのアップグレードに関するよくある質問です。

エディタのアドオンをアップグレードすることはできますか?

ほとんどのエディタ アドオンは Google Workspace アドオンに移行できます。ただし、Gmail やカレンダーのアドオンのように簡単に Google Workspace アドオンにアップグレードすることはできません。

エディタ アドオンを Google Workspace アドオンに移行する場合は、アドオンの UI を HTML からカードベースのインターフェースに書き換え、JavaScript の処理をカードサービスに更新する必要があります。

既存のエディタ アドオン内の一部のサービスが、カードサービスで利用できない場合があります。たとえば、エディタのアドオンにファイル選択ツールが含まれている場合、Google Workspace アドオンのカードサービスにはこれに相当するものがありません。

Google Workspace アドオンを個別に作成し、既存のアドオンを保持できますか?

別のブランド名で追加の Google Workspace アドオンを構築することは可能ですが、Google Workspace アドオンと同じブランド名で Gmail またはカレンダーの会議アドオンを個別に作成することはできません。ご質問がある場合や、例外リクエストを希望される場合は、こちらからお問い合わせください

アップグレード後にユーザーはアドオンを再承認する必要がありますか?

Google Workspace アドオンで、基盤となる同じ Cloud Platform(GCP)プロジェクトと OAuth クライアント ID が関連付けられている限り、ユーザーは元のアドオンで以前に承認した権限を再承認する必要はありません。ただし、アップグレード プロセス中に新しいスコープを追加した場合、ユーザーは Google Workspace バージョンのアドオンを初めて使用するときに新しいスコープを承認する必要があります。

Chrome 拡張機能を Google Workspace アドオンにアップグレードしてユーザーを移行できますか?

いいえ。Chrome 拡張機能のユーザー、インストール、掲載情報のレビューは移行できません。新しい Google Workspace アドオンを作成し、Chrome 拡張機能のユーザーを Google Workspace Marketplace に誘導する必要があります。

Google Workspace アドオンに複数のアドオンをバンドルできますか?

アプリの統合を一覧表示するをご覧ください。