Google Apps Script のクイックスタート

クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。

Google Workspace のクイックスタートでは、API クライアント ライブラリを使用して、認証と承認フローの詳細の一部を処理します。ご自身でアプリを開発する際には、このクライアント ライブラリを使用することをおすすめします。このクイックスタートでは、テスト環境に適した簡素な認証方法を使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と承認について学習することをおすすめします。

Google Chat API にリクエストを送信する Google Apps Script を作成します。

目標

• 環境を構成する。
• スクリプトを作成して構成します。
• スクリプトを実行します。

前提条件

• Google Cloud プロジェクト。

• Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。

Cloud プロジェクトを構成する

このクイックスタートを完了するために新しい Google Cloud プロジェクトを使用している場合は、そのプロジェクトを構成して、自分自身をテストユーザーとして追加する必要があります。Cloud プロジェクトでこれらの手順をすでに完了している場合は、次のセクションに進みます。

Google Cloud コンソールで Cloud プロジェクトを開く

このサンプルに使用する Cloud プロジェクトをまだ開いていない場合は、開きます。

1. Google Cloud コンソールで [プロジェクトを選択] ページに移動します。

   Cloud プロジェクトを選択する

2. 使用する Google Cloud プロジェクトを選択します。または、[プロジェクトを作成] をクリックし、画面の指示に沿って操作します。Google Cloud プロジェクトを作成する場合は、プロジェクトの課金を有効にする必要がある場合があります。

Chat API を有効にする

Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。

• Google Cloud コンソールで、Google Chat API を有効にします。

  API の有効化

OAuth 同意画面を構成する

1. Google Cloud コンソールで、メニュー > > [ブランディング] に移動します。

   [ブランディング] に移動

2. をすでに設定している場合は、[ブランディング]、[オーディエンス]、[データアクセス] で次の OAuth 同意画面の設定を構成できます。[ まだ設定されていません] というメッセージが表示された場合は、[使ってみる] をクリックします。
1. [アプリ情報] の [アプリ名] に、アプリの名前を入力します。
2. [ユーザー サポートメール] で、ユーザーが同意について問い合わせる際に使用するサポートのメールアドレスを選択します。
3. [続行] をクリックします。
4. [視聴者] で [内部] を選択します。
5. [続行] をクリックします。
6. [連絡先情報] で、プロジェクトの変更に関する通知を受け取るメールアドレスを入力します。
7. [続行] をクリックします。
8. [完了] で Google API サービスのユーザーデータに関するポリシーを確認し、同意する場合は [Google API サービス: ユーザーデータに関するポリシーに同意します] を選択します。
9. [続行] をクリックします。
10. [作成] をクリックします。
3. 現時点では、スコープの追加はスキップできます。 今後、Google Workspace 組織の外部で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更する必要があります。次に、アプリに必要な認可スコープを追加します。詳細については、OAuth 同意画面を構成するガイドをご覧ください。

Google Chat アプリを構成する

Google Chat API を呼び出すには、Google Chat アプリを構成する必要があります。書き込みリクエストの場合、Google Chat は次の情報を使用することで、UI 内の Google Chat アプリを関連付けます。

1. Google Cloud コンソールで、Chat API の [構成] ページに移動します。

   [Chat API の構成] ページに移動

2. [アプリケーション情報] で、次の情報を入力します。

   1. [アプリ名] フィールドに「Chat API quickstart app」と入力します。
   2. [アバターの URL] フィールドに「https://developers.google.com/chat/images/quickstart-app-avatar.png」と入力します。
   3. [説明] フィールドに「Quickstart for calling the Chat API」と入力します。

3. [インタラクティブ機能] で、[インタラクティブ機能を有効にする] トグルをオフにすると、Chat アプリのインタラクティブ機能が無効になります。

4. [保存] をクリックします。

スクリプトを作成する

1. script.google.com/create に移動して、新しいスクリプトを作成します。
2. スクリプト エディタの内容を次のコードに置き換えます。

chat/quickstart/Code.gs

GitHub で表示

/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken
    });
    // Handle response pages
    if (responsePage.spaces) {
      responsePage.spaces.forEach((space) => console.log(space));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

3. [保存] をクリックします。
4. [無題のプロジェクト] をクリックし、[Quickstart] と入力して、[名前を変更] をクリックします。

スクリプトを構成する

Cloud プロジェクト番号をコピーする

1. Google Cloud コンソールで、メニュー > [IAM と管理] > [設定] に移動します。

   [IAM と管理] の [設定] に移動

2. [プロジェクト番号] フィールドで値をコピーします。

Google Cloud プロジェクトをリンクする

1. Apps Script プロジェクトを開きます。
2. [プロジェクトの設定] をクリックします。
3. [Google Cloud Platform（GCP）プロジェクト] で、[プロジェクトを変更] をクリックします。
4. [GCP プロジェクト番号] に、Google Cloud プロジェクト番号を貼り付けます。
5. [プロジェクトを設定] をクリックします。

Google Chat API を有効にする

1. Apps Script プロジェクトを開きます。

1. [プロジェクトの設定] をクリックします。
2. [全般設定] で、[「appsscript.json」マニフェスト ファイルをエディタで表示する] を有効にします。
3. [エディタ] をクリックし、ファイル appscript.json を選択して、内容を次のコードに置き換えます。

chat/quickstart/appsscript.json

GitHub で表示

{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.spaces.readonly"
  ],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [{
      "userSymbol": "Chat",
      "version": "v1",
      "serviceId": "chat"
    }]
  }
}

サンプルの実行

Apps Script エディタで [実行] をクリックします。

サンプルを初めて実行すると、アクセスを承認するよう求められます。

1. [権限を確認] をクリックします。
2. アカウントを選択してください。
3. [許可] をクリックします。

スクリプトの実行ログがウィンドウの下部に表示されます。

うまくいった

これで完了です。 詳しくは、以下の「参考資料」をご覧ください。

問題が発生しました

残念です 問題の詳細をお知らせください。 一般的なエラーと解決策については、下記の トラブルシューティングをご覧ください。 コードでバグを見つけた場合は、 GitHub で問題を報告するか、pull リクエストを送信してください。

次のステップ

• Google Apps Script アドバンスト サービスのドキュメント