Gmail またはカレンダーを拡張するアドオンをすでに構築して公開している場合は、Google Workspace アドオンにアップグレードできます。このページでは、既存の Gmail アドオンまたはカレンダーのアドオンに Google Workspace の機能を追加し、アップグレードしたアドオンを公開して検出とインストールを可能にする手順について説明します。
新しい機能を元のアドオンに移行することで、Google Workspace Marketplace のリスティング、インストール、ユーザーを維持できます。アップグレードすると、ホームページなどの新しい Google Workspace アドオン機能も利用できます。
ステップ 1: アドオンの Apps Script プロジェクトのコピーを作成する
アップグレードしたアドオンは、公開済みのアドオンと同じ Google Cloud プロジェクトを使用しますが、基盤となる Apps Script プロジェクトのコピーを作成して使用し、アップグレードされたバージョンをテストする際に既存のユーザーが影響を受けないようにすることが重要です。また、元のスクリプト プロジェクトのコピーをアップグレードすると、いつでも元のコードにアクセスでき、必要に応じて後で再デプロイできます。
- 既存の Gmail アドオンまたはカレンダー会議アドオンの Apps Script プロジェクトを開きます。
- 左側の [概要] をクリックします。
- 右側の「コピーを作成」アイコン をクリックします。
- 画面左側で、[プロジェクト設定] > [プロジェクトを変更] をクリックします。
- [GCP プロジェクト番号] をクリックします。
- 既存の公開済みのアドオン Apps Script プロジェクトに関連付けられているものと同じプロジェクト番号を入力します。
- [プロジェクトを設定] をクリックします。
ステップ 2: Google Workspace アドオンを統合する
アドオンに追加する Google Workspace アドオン機能を設計して実装する必要があります。
- アドオンのホームページ カードに表示するコンテンツと、それらを Gmail、カレンダー、ドライブ、または 3 つのホストの組み合わせに表示するかどうかを計画します。1 つのホームページを複数のホストに表示する場合は、同じホームページにするか、ホストごとにカスタム ホームページ カードを使用するかを決定します。
- コピーしたアドオン Apps Script プロジェクトで、
homepageTrigger関数を使用してホームページ カードを作成します。新しいホームページ インターフェースの制御に必要なサポート関数やロジックも必ず含めてください。 Gmail のメッセージ スレッドやカレンダーの予定を開くなど、ユーザーの操作によってトリガーされるコンテキスト カードを追加することを検討してください。
アドオン（ウィジェット コールバック関数またはコンテキスト トリガー関数）でのイベント オブジェクトへのアクセスを更新して、更新されたイベント オブジェクト構造を使用します。新しい構造には、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 に掲載する前に承認を受ける必要があります。
アドオンを送信して審査を受ける手順は次のとおりです。
アドオンがアドオンの公開要件をすべて満たしていることを確認します。
公開するコードのバージョンを使用して、Google Workspace アドオンのバージョニングされたデプロイメントを（新しい Apps Script プロジェクトで）作成します。ヘッド デプロイを使用して公開しないでください。
アドオンのアップグレード中に新しいスコープを追加した場合は、OAuth 検証をリクエストする必要があります。たとえば、Gmail アドオンが Google Workspace アドオン バージョンの新しいドライブ スコープやカレンダー スコープを使用している場合、これらの新しいスコープを検証のために提出する必要があります。検証が完了するまでに数日かかることが多いため、できるだけ早くプロセスを開始してください。手順 6 に進む前に、アドオンを検証してください。
ステップ 6: アップグレードしたアドオンを利用できるようにする
Google Workspace Marketplace SDK を開きます。
左側の [設定] をクリックします。このパネルには、アドオンに関する情報を入力するフォームがあります。
リスティングの簡単な説明、詳細な説明、スクリーンショットを更新して、Google Workspace アドオンの新機能を反映させます。
[拡張機能] で、[Upgrade to Google Workspace Add-on] ボタンをクリックします。表示されたテキスト ボックスに、前の手順で Google Workspace アドオン用に作成した新しいデプロイ ID を入力します。デプロイ ID が有効な場合、サポートされているホストのリストが表示されます。
Google Workspace アドオンに新しいスコープを追加した場合は、[構成] ページの [OAuth 2.0 スコープ] セクションに必ず追加してください。このセクションに記載されているスコープは、アドオンのマニフェストに記載されているスコープと完全に一致する必要があります。
フォームに入力した情報が正しいことを確認します。次に、[変更を保存] をクリックします。
この Google Workspace アドオンのアップグレード プロセスでご不明な点や問題が発生した場合は、お問い合わせください。
よくある質問
アドオンのアップグレードに関するよくある質問は次のとおりです。
エディタ アドオンをアップグレードできますか？
ほとんどのエディタ アドオンは Google Workspace アドオンに移行できます。ただし、Gmail やカレンダーのアドオンほど簡単には Google Workspace アドオンにアップグレードすることはできません。
エディタ アドオンを Google Workspace アドオンに移行する場合は、アドオンの UI を HTML からカードベースのインターフェースに書き換え、JavaScript 処理をカードサービスに更新する必要があります。
既存のエディタ アドオンの一部のサービスは、カードサービスで利用できない場合があります。たとえば、エディタのアドオンにファイル選択ツールが含まれている場合、Google Workspace アドオンのカードサービスに同等のものはありません。
Google Workspace アドオンを別途構築して、既存のアドオンを維持することはできますか？
別のブランド名で追加の Google Workspace アドオンを作成することは可能ですが、Google Workspace アドオンと同じブランド名で Gmail またはカレンダーの会議アドオンを個別に作成することはできません。ご質問がある場合や例外をリクエストしたい場合は、Google までお問い合わせください。
ユーザーはアップグレード後にアドオンを再承認する必要がありますか？
Google Workspace アドオンが基盤となる同じ Cloud Platform（GCP）プロジェクトを使用し、OAuth クライアント ID が関連付けられている限り、ユーザーは元のアドオンに対して以前に承認した権限を再承認する必要はありません。ただし、アップグレード プロセス中に新しいスコープを追加した場合、ユーザーは Google Workspace バージョンのアドオンを初めて使用するときに新しいスコープを承認する必要があります。
Chrome 拡張機能を Google Workspace アドオンにアップグレードしてユーザーを移行できますか？
いいえ。Chrome 拡張機能のユーザー、インストール、リスティングのレビューは移行できません。新しい Google Workspace アドオンを作成し、Chrome 拡張機能のユーザーを Google Workspace Marketplace に誘導する必要があります。
Google Workspace アドオンに複数のアドオンをバンドルすることはできますか？
アプリの統合をまとめて一覧表示するをご覧ください。