Node.js クイックスタート

Google Apps Script API にリクエストを行う Node.js コマンドラインアプリケーションを作成します。

クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。このクイックスタートでは、テスト環境に適した簡素化された認証方法を使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と認可について学習することをおすすめします。

このクイックスタートでは、Google Workspace が推奨する API クライアントライブラリを使用して、認証と認可フローの詳細を処理します。

目標

環境をセットアップする。
クライアントライブラリをインストールする。
サンプルをセットアップする。
サンプルを実行する。

前提条件

このクイックスタートを実行するには、次の前提条件を満たしている必要があります。

Node.js と npm がインストールされている。
Google Cloud プロジェクト。

Google ドライブが有効になっている Google アカウントがある。

環境をセットアップする

このクイックスタートを完了するには、環境をセットアップします。

API を有効にする

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

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

API を有効にする

OAuth 同意画面を構成する

このクイックスタートを新しい Google Cloud プロジェクトで完了する場合は、OAuth 同意画面を構成します。Cloud プロジェクトでこの手順をすでに完了している場合は、次のセクションに進んでください。

Google API Console で、メニューアイコン menu > [Google Auth Platform] > [ブランディング] に移動します。
[ブランディング] に移動
Google Auth Platform をすでに構成している場合は、[ブランディング]、[対象]、[データアクセス] で次の OAuth 同意画面の設定を構成できます。[**Google Auth Platform はまだ構成されていません**] というメッセージが表示されたら、[**スタートガイド**] をクリックします。

[アプリ情報] の [アプリ名] に、アプリの名前を入力します。
[**ユーザーサポートメール**] で、ユーザーが同意について問い合わせる際に使用するサポートのメールアドレスを選択します。
[続行] をクリックします。
[対象] で [内部] を選択します。
[続行] をクリックします。
[連絡先情報] で、プロジェクトに対する変更の通知を受け取る [メールアドレス] を入力します。
[続行] をクリックします。
[完了] で、Google API サービスのユーザーデータに関するポリシーを確認し、同意する場合は [Google API サービス: ユーザーデータに関するポリシーに同意します] を選択します。
[続行] をクリックします。
[作成] をクリックします。

現時点では、スコープの追加はスキップできます。今後、 Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更する必要があります。次に、アプリに必要な認可スコープを追加します。詳細については、 OAuth 同意画面を構成するをご覧ください。

デスクトップアプリケーションの認証情報を認可する

エンドユーザーを認証してアプリ内のユーザーデータにアクセスするには、1 つ以上の OAuth 2.0 クライアント ID を作成する必要があります。クライアント ID は、Google の OAuth サーバーで個々のアプリを識別するために使用します。アプリが複数のプラットフォームで実行される場合は、プラットフォームごとに個別のクライアント ID を作成する必要があります。

Google API Console で、メニューアイコン Menu > [Google Auth Platform] > [クライアント] に移動します。
[クライアント] に移動
[クライアントの作成] をクリックします。
[アプリケーションタイプ] [>] [デスクトップアプリ] をクリックします。
[名前] フィールドに、認証情報の名前を入力します。この名前は Google API Console にのみ表示されます。
[作成] をクリックします。
新しく作成した認証情報が [OAuth 2.0 クライアント ID] に表示されます。
ダウンロードした JSON ファイルを credentials.json として保存し、ファイルを作業ディレクトリに移動します。

クライアントライブラリをインストールする

npm を使用してライブラリをインストールします。
```
npm install googleapis@105 @google-cloud/local-auth@2.1.0 --save
```

サンプルをセットアップする

作業ディレクトリに index.js という名前のファイルを作成します。

ファイルに次のコードを貼り付けます。

apps-script/quickstart/index.js

GitHub で表示

import path from 'node:path';
import process from 'node:process';
import {authenticate} from '@google-cloud/local-auth';
import {google} from 'googleapis';

const SCOPES = ['https://www.googleapis.com/auth/script.projects'];
const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');

/**
 * Creates a new script project, upload a file, and log the script's URL.
 */
async function callAppsScript() {
  const auth = await authenticate({
    scopes: SCOPES,
    keyfilePath: CREDENTIALS_PATH,
  });

  const script = google.script({version: 'v1', auth});
  const project = await script.projects.create({
    requestBody: {
      title: 'My Script',
    },
  });

  if (!project.data.scriptId) {
    throw new Error('Failed to create project');
  }

  await script.projects.updateContent({
    scriptId: project.data.scriptId,
    auth,
    requestBody: {
      files: [
        {
          name: 'hello',
          type: 'SERVER_JS',
          source: 'function helloWorld() {\n  console.log("Hello, world!");\n}',
        },
        {
          name: 'appsscript',
          type: 'JSON',
          source:
            '{"timeZone":"America/New_York","exceptionLogging":' + '"CLOUD"}',
        },
      ],
    },
  });
  console.log(`https://script.google.com/d/${project.data.scriptId}/edit`);
}

await callAppsScript();

サンプルを実行する

作業ディレクトリでサンプルを実行します。
```
node .
```

サンプルを初めて実行すると、アクセス権の認可を求めるメッセージが表示されます。
1. Google アカウントにまだログインしていない場合は、ログインを求められたらログインします。複数のアカウントにログインしている場合は、認可に使用するアカウントを 1 つ選択します。
2. [Accept] をクリックします。
Node.js アプリケーションが実行され、Google Apps Script API が呼び出されます。

認可情報はファイルシステムに保存されるため、次回サンプルコードを実行するときに認可を求められることはありません。