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

クイックスタートでは、 Google Workspace API

Google Workspace クイックスタートでは、API クライアント ライブラリを使用して 認証と認可のフローの詳細を確認できます。おすすめの方法 独自のアプリ用のクライアント ライブラリを使用します。このクイックスタートでは、テスト環境に適した簡素な認証方法を使用します。本番環境では、Terraform の IAM 構成の 認証と認可 次の日付より前 アクセス認証情報の選択 選択することもできます

作成: Google Apps Script Google Chat API にリクエストを送信できます。

目標

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

前提条件

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

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

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

まだ開いていない場合は、使用する Cloud プロジェクトを開きます。 次のように設定します。

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

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

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

Chat API を有効にする

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

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

    API の有効化

  1. Google Cloud コンソールで、メニュー に移動します。 > API とサービス > OAuth 同意画面。

    OAuth 同意画面に移動

  2. [ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
  3. アプリ登録フォームに入力し、[保存して続行] をクリックします。

  4. ここではスコープの追加をスキップして、[保存して次へ] をクリックします。将来的に、 [ユーザーの種類] を [外部] に変更してから、 アプリに必要な認可スコープを追加します。

  5. アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリの登録に問題がなければ、[ダッシュボードに戻る] をクリックします。

Google Chat アプリを構成する

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

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

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

  2. [Application info] で、次の情報を入力します。

    1. [App name] フィールドに「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
/**
 * 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);
}

  1. [保存] をクリックします。
  2. [無題のプロジェクト] をクリックし、 クイックスタートをクリックし、[名前を変更] をクリックします。

スクリプトを構成する

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

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

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

  2. [プロジェクト番号] フィールドで値をコピーします。
  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
{
  "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. [許可] をクリックします。

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

次のステップ