Node.js ランタイムを使用して、Cloud Functions で Google Workspace アドオンを作成します。
目標
- 環境を設定する。
- Cloud Functions の関数を作成してデプロイする。
- アドオンを作成してデプロイします。
- アドオンをインストールします。
前提条件
- Google Cloud プロジェクト。
- Cloud プロジェクトの課金が有効になっていることを確認します。プロジェクトの課金ステータスを確認する方法をご覧ください。
- Cloud プロジェクトで構成された Cloud SDK。
環境を設定する
Google Cloud コンソールで Cloud プロジェクトを開く
- Google Cloud コンソールで、[プロジェクトの選択] ページに移動します。
- 使用する Google Cloud プロジェクトを選択します。または、[プロジェクトを作成] をクリックし、画面の指示に従います。Google Cloud プロジェクトを作成する場合、プロジェクトの課金を有効にする必要があります。
OAuth 同意画面を構成する
Google Workspace アドオンを使用するには、同意画面の構成が必要です。アドオンの OAuth 同意画面を構成すると、Google がユーザーに表示する内容が定義されます。
- Google Cloud コンソールで、メニュー > [API とサービス] > [OAuth 同意画面] に移動します。
- [ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
- アプリ登録フォームに入力し、[保存して次へ] をクリックします。
現時点では、スコープの追加をスキップして、[保存して次へ] をクリックします。今後、Google Workspace 組織の外部で使用するアプリを作成する場合は、[ユーザーの種類] を [外部] に変更してから、アプリに必要な認証スコープを追加する必要があります。
- アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリの登録に問題がない場合は、[Back to Dashboard] をクリックします。
Cloud 関数を作成してデプロイする
ローカル ターミナルで、Cloud Functions、Cloud Build、Google Workspace アドオン API を有効にします。
gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com
空のディレクトリに、次のサンプルコードを含む
function.js
ファイルを作成します。/** * Cloud Function that loads the homepage for a * Google Workspace Add-on. * * @param {Object} req Request sent from Google * @param {Object} res Response to send back */ exports.loadHomePage = function addonsHomePage (req, res) { res.send(createAction()); }; /** Creates a card with two widgets. */ function createAction() { return { "action": { "navigations": [ { "pushCard": { "header": { "title": "Cats!" }, "sections": [ { "widgets": [ { "textParagraph": { "text": "Your random cat:" } }, { "image": { "imageUrl": "https://cataas.com/cat" } } ] } ] } } ] } }; }
関数をデプロイします。
gcloud functions deploy loadHomePage --runtime nodejs12 --trigger-http
プロンプトが表示されたら、関数の未認証の呼び出しを許可しないことを指定します。関数のデプロイには数分かかる場合があります。
アドオン デプロイを作成する
アドオンのサービス アカウントのメールアドレスを見つけます。
gcloud workspace-add-ons get-authorization
サービス アカウントに
cloudfunctions.invoker
ロールを付与します。gcloud functions add-iam-policy-binding loadHomePage \ --role roles/cloudfunctions.invoker \ --member serviceAccount:SERVICE_ACCOUNT_EMAIL
デプロイされた関数の URL を取得します。URL を取得するには、次のコマンドを実行して
httpsTrigger
セクションのurl
フィールドを探します。gcloud functions describe loadHomePage
次のサンプルコードを使用して
deployment.json
ファイルを作成します。URL
は、前の手順でデプロイされた関数の URL に置き換えます。{ "oauthScopes": ["https://www.googleapis.com/auth/gmail.addons.execute"], "addOns": { "common": { "name": "My HTTP Add-on", "logoUrl": "https://raw.githubusercontent.com/webdog/octicons-png/main/black/beaker.png", "homepageTrigger": { "runFunction": "URL" } }, "gmail": {}, "drive": {}, "calendar": {}, "docs": {}, "sheets": {}, "slides": {} } }
デプロイを作成します。
gcloud workspace-add-ons deployments create quickstart \ --deployment-file=deployment.json
アドオンをインストールする
デプロイを開発モードでインストールします。
gcloud workspace-add-ons deployments install quickstart
アドオンを表示するには、Gmail を開くか再読み込みしてください。右側のツールバーでビーカーのアイコンが表示されます。
アイコンをクリックしてアドオンを開きます。プロンプトが表示されたら、アドオンを承認します。
オプション: クリーンアップ
アカウントに課金されないようにするには、作成したリソースを削除します。
Google アカウントからアドオンをアンインストールします。
gcloud workspace-add-ons deployments uninstall quickstart
このクイックスタートで使用したリソースに対して課金されないようにするには、Cloud プロジェクトを削除します。
gcloud projects delete PROJECT_ID
PROJECT_ID は、クイックスタートに使用した Cloud プロジェクトの ID に置き換えます。Cloud プロジェクト ID は、Google Cloud コンソールの [ダッシュボード] ページで確認できます。
次のステップ
Google Workspace アドオンに機能を追加するには、次のガイドをご覧ください。