Gmail またはカレンダーを拡張するアドオンをすでに構築して公開している場合は、Google Workspace アドオンにアップグレードできます。このページの指示では、既存の Gmail またはカレンダーのアドオンに Google Workspace の機能を追加し、アップグレードしたアドオンを公開して検出とインストールを可能にする方法について詳しく説明します。
新しい機能を元のアドオンに移行して、Google Workspace Marketplace のリスティング、インストール、ユーザーを維持できます。アップグレードすると、ホームページなどの新しい Google Workspace アドオンの機能も利用できるようになります。
ステップ 1: アドオンの Apps Script プロジェクトのコピーを作成する
アップグレードされたアドオンは、公開されたアドオンと同じ Google Cloud プロジェクトを使用しますが、アップグレードされたバージョンをテストしている間、既存のユーザーに影響を与えないように、基盤となる Apps Script プロジェクトのコピーを作成して使用することが重要です。元のスクリプト プロジェクトのコピーをアップグレードすると、元のコードにいつでもアクセスでき、必要に応じて後で再デプロイすることもできます。
- 既存の Gmail アドオンまたはカレンダーの会議アドオンの Apps Script プロジェクトを開きます。
- 左側の [概要] をクリックします。
- 右側の [コピーを作成] をクリックします。
- 左側の [プロジェクトの設定] > [プロジェクトを変更] をクリックします。
- [GCP Project Number] をクリックします。
- 既存の公開済みアドオン 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 アドオンのアップグレード プロセスについてご不明な点がある場合や、問題が発生した場合は、Google までお問い合わせください。
よくある質問
アドオンのアップグレードに関するよくある質問は次のとおりです。
エディタ アドオンをアップグレードできますか？
ほとんどのエディタ アドオンは 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 アドオンにバンドルできますか？
アプリの統合を一覧表示するをご覧ください。