Node.js クイックスタート

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

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

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

目標

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

前提条件

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

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

API アクセスが有効になっている Google Workspace ドメインがある。
管理者権限を持つ、そのドメイン内の Google アカウントがある。

環境の設定

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

API を有効にする

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

Google Cloud コンソールで、People 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 という名前のファイルを作成します。

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

people/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 contacts.
const SCOPES = ['https://www.googleapis.com/auth/contacts.readonly'];
// The path to the credentials file.
const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');

/**
 * Prints the display names of the first 10 connections.
 */
async function listConnectionNames() {
  // Authenticate with Google and get an authorized client.
  const auth = await authenticate({
    scopes: SCOPES,
    keyfilePath: CREDENTIALS_PATH,
  });

  // Create a new People API client.
  const service = google.people({version: 'v1', auth});
  // Get the list of connections.
  const result = await service.people.connections.list({
    resourceName: 'people/me',
    pageSize: 10,
    personFields: 'names,emailAddresses',
  });
  const connections = result.data.connections;
  if (!connections || connections.length === 0) {
    console.log('No connections found.');
    return;
  }
  console.log('Connections:');
  // Print the display name of each connection.
  connections.forEach((person) => {
    if (person.names && person.names.length > 0) {
      console.log(person.names[0].displayName);
    } else {
      console.log('No display name found for connection.');
    }
  });
}

await listConnectionNames();

サンプルの実行

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

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

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