クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。
Google Workspace のクイックスタートでは、API クライアント ライブラリを使用して、認証と承認フローの詳細の一部を処理します。ご自身でアプリを開発する際には、このクライアント ライブラリを使用することをおすすめします。このクイックスタートでは、 テストに適したシンプルな認証アプローチ できます。本番環境では、Terraform の IAM 構成の 認証と認可 次の日付より前 アクセス認証情報の選択 選択することもできます
VM に対してリクエストを行う Node.js コマンドライン アプリケーションを作成する Google Chat API。
目標
- 環境を設定する。
- クライアント ライブラリをインストールする。
- サンプルを設定します。
- サンプルを実行します。
前提条件
このクイックスタートを実行するには、次の前提条件を満たす必要があります。
- Node.js と npm がインストールされている。
- Google Cloud プロジェクト。
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズの Google Workspace アカウント。
環境の設定
このクイックスタートを完了するには、環境を設定します。
API を有効にする
Google API を使用する前に、Google Cloud プロジェクトで有効にする必要があります。 1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、Google Chat API を有効にします。
OAuth 同意画面を構成する
このクイックスタートを完了するために新しい Google Cloud プロジェクトを使用している場合は、OAuth 同意画面を構成し、自分自身をテストユーザーとして追加します。すでに 完了している場合は、次のセクションにスキップしてください。
- Google Cloud コンソールで、メニュー > [API とサービス] > [OAuth 同意画面] に移動します。
- [ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
- アプリ登録フォームに入力し、[保存して次へ] をクリックします。
現時点では、スコープの追加をスキップして [保存して次へ] をクリックします。 今後、Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更し、アプリに必要な認可スコープを追加する必要があります。
- アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリの登録に問題がなければ、[ダッシュボードに戻る] をクリックします。
デスクトップ アプリケーションの認証情報を承認する
エンドユーザーを認証し、アプリ内のユーザーデータにアクセスするには、1 つ以上の OAuth 2.0 クライアント ID を作成する必要があります。クライアント ID は Google の OAuth サーバーに送信します。アプリが複数のプラットフォームで動作する場合 プラットフォームごとに個別のクライアント ID を作成する必要があります。- Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
- [認証情報を作成] > [OAuth クライアント ID] をクリックします。
- [アプリケーションの種類] > [デスクトップ アプリ] をクリックします。
- [名前] フィールドに、認証情報の名前を入力します。この名前は Google Cloud コンソールにのみ表示されます。
- [作成] をクリックします。[OAuth クライアントを作成しました] 画面が表示され、新しいクライアント ID とクライアント シークレットが表示されます。
- [OK] をクリックします。新しく作成された認証情報が [OAuth 2.0 クライアント ID] に表示されます。
- ダウンロードした JSON ファイルを
credentials.json
として保存し、作業ディレクトリに移動します。
Google Chat アプリを構成する
Google Chat API を呼び出すには、Google Chat アプリを構成する必要があります。書き込みリクエストの場合、Google Chat は次の情報を使用することで、UI 内の Google Chat アプリを関連付けます。
Google Cloud コンソールで、Chat API の [構成] ページに移動します。
[Application info] で、次の情報を入力します。
- [App name] フィールドに「
Chat API quickstart app
」と入力します。 - [アバターの URL] フィールドに「
https://developers.google.com/chat/images/quickstart-app-avatar.png
」と入力します。 - [説明] フィールドに「
Quickstart for calling the Chat API
」と入力します。
- [App name] フィールドに「
[インタラクティブ機能] で、[インタラクティブ機能を有効にする] をクリックします。 インタラクティブ機能を無効にするには、 Chat アプリ。
[保存] をクリックします。
クライアント ライブラリをインストールする
npm を使用してライブラリをインストールします。
npm install @google-apps/chat @google-cloud/local-auth@2.1.0 --save
サンプルのセットアップ
作業ディレクトリに、
index.js
という名前のファイルを作成します。次のコードをファイルに貼り付けます。
サンプルの実行
作業ディレクトリでサンプルを実行します。
node .
-
サンプルを初めて実行すると、アクセスの承認を求められます。
<ph type="x-smartling-placeholder">
- </ph>
- Google アカウントにまだログインしていない場合は、ログインを求められたらログインします。複数のアカウントにログインしている場合は、承認に使用するアカウントを 1 つ選択します。
- [Accept] をクリックします。
Nodejs アプリケーションが実行され、Google Chat API が呼び出されます。
認証情報はファイル システムに保存されるため、次回サンプルコードを実行するときに認証を求められることはありません。