Node.js クイックスタート

Google カレンダー 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 Calendar API を有効にします。

API を有効にする

OAuth 同意画面を構成する

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

Google API Console で、メニューアイコン menu > [Google Auth platform] > [Branding] に移動します。
[Branding] に移動
Google Auth Platform をすでに構成している場合は、[Branding]、[Audience]、および [Data Access] で次の OAuth 同意画面の設定を構成できます。[Google Auth platform not configured yet] というメッセージが表示されたら、[Get Started] をクリックします。

[App Information] の [App name] に、アプリの名前を入力します。
[User support email] で、ユーザーが同意について問い合わせる際に使用するサポートのメールアドレスを選択します。
[Next] をクリックします。
[Audience] で [Internal] を選択します。
[Next] をクリックします。
[Contact Information] の [Email address] に、プロジェクトに対する変更の通知を受け取るメールアドレスを入力します。
[Next] をクリックします。
[Finish] で、Google API サービスのユーザーデータに関するポリシーを確認し、同意する場合は [I agree to the Google API Services: User Data Policy] を選択します。
[Continue] をクリックします。
[Create] をクリックします。

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

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

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

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

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

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

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

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

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

calendar/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';

// The scope for reading calendar events.
const SCOPES = ['https://www.googleapis.com/auth/calendar.readonly'];
// The path to the credentials file.
const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');

/**
 * Lists the next 10 events on the user's primary calendar.
 */
async function listEvents() {
  // Authenticate with Google and get an authorized client.
  const auth = await authenticate({
    scopes: SCOPES,
    keyfilePath: CREDENTIALS_PATH,
  });

  // Create a new Calendar API client.
  const calendar = google.calendar({version: 'v3', auth});
  // Get the list of events.
  const result = await calendar.events.list({
    calendarId: 'primary',
    timeMin: new Date().toISOString(),
    maxResults: 10,
    singleEvents: true,
    orderBy: 'startTime',
  });
  const events = result.data.items;
  if (!events || events.length === 0) {
    console.log('No upcoming events found.');
    return;
  }
  console.log('Upcoming 10 events:');

  // Print the start time and summary of each event.
  for (const event of events) {
    const start = event.start?.dateTime ?? event.start?.date;
    console.log(`${start} - ${event.summary}`);
  }
}

await listEvents();

サンプルを実行する

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

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

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