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 つのホストの組み合わせで表示するかを計画します。複数のホストにホームページを表示する場合は、同じホームページを表示するか、ホストごとにカスタム ホームページ カードを表示するかを決定します。
- コピーしたアドオンの 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 アドオンの新しい機能を反映します。
[拡張機能] で、[Google Workspace アドオンにアップグレード] ボタンをクリックします。表示されたテキスト ボックスに、前の手順で Google Workspace アドオン用に作成した新しいデプロイ ID を入力します。デプロイ ID が有効な場合は、サポートされているホストのリストが表示されます。
Google Workspace アドオンに新しいスコープを追加した場合は、[構成] ページの [OAuth 2.0 スコープ] セクションに追加してください。このセクションにリストされているスコープは、アドオンのマニフェストにリストされているスコープと完全に一致している必要があります。
フォームに入力した情報が正しいことを確認します。その後、[変更を保存] をクリックします。
Google Workspace アドオンのアップグレード プロセスについてご不明な点がある場合や問題が発生した場合は、お問い合わせください。
よくある質問
アドオンのアップグレードに関するよくある質問を以下に示します。
エディタ アドオンをアップグレードできますか？
ほとんどの Editor アドオンは、Google Workspace アドオンに移行できます。ただし、Gmail やカレンダーのアドオンほど簡単に Google Workspace アドオンにアップグレードすることはできません。
エディタ アドオンを Google Workspace アドオンに移行する場合は、アドオンの UI を HTML からカードベースのインターフェースに書き換え、JavaScript の処理を カード サービスに更新する必要があります。
既存のエディタ アドオンの一部のサービスは、カード サービスではご利用いただけない場合があります。たとえば、エディタ アドオンにファイル選択ツールが含まれている場合、Google Workspace アドオンのカード サービスで同等の機能は利用できません。
別の Google Workspace アドオンを作成して、既存のアドオンを維持できますか？
別のブランド名で Google Workspace アドオンを追加で作成することはできますが、Google Workspace アドオンと同じブランド名で Gmail またはカレンダーの会議アドオンを別途作成することはできません。ご不明な点がある場合や例外をリクエストする場合は、お問い合わせください。
アップグレード後にユーザーがアドオンの再承認が必要になりますか？
Google Workspace アドオンが、関連付けられた OAuth クライアント ID とともに、同じ基盤となる Cloud Platform（GCP）プロジェクトを使用している限り、ユーザーは元のアドオンに対して以前に承認した権限を再承認する必要はありません。ただし、アップグレード プロセス中に新しいスコープを追加した場合、ユーザーは Google Workspace バージョンのアドオンを初めて使用するときに、その新しいスコープを承認する必要があります。
Chrome 拡張機能を Google Workspace アドオンにアップグレードしてユーザーを移行できますか？
いいえ。Chrome 拡張機能のユーザー数、インストール数、リスティングのレビューは移行できません。新しい Google Workspace アドオンを作成し、Chrome 拡張機能のユーザーを Google Workspace Marketplace に誘導する必要があります。
Google Workspace アドオンに複数のアドオンをバンドルできますか？
アプリの統合を一覧表示するをご覧ください。