Node.js クイックスタート

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

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

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

目標

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

前提条件

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

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

環境の設定

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

API を有効にする

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

    API の有効化

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

  1. Google API コンソールで、メニュー > Google 認証プラットフォーム > ブランディング に移動します。

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

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

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

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

    [クライアント] に移動

  2. [Create Client] をクリックします。
  3. [アプリケーション タイプ] > [デスクトップ アプリ] をクリックします。
  4. [名前] フィールドに、認証情報の名前を入力します。この名前は Google Cloud コンソールにのみ表示されます。
  5. 省略可: アプリがユーザーに代わってアクションを実践する AI エージェントの場合は、[このクライアントを AI 搭載エージェントに使用する] を選択します。アプリが AI エージェント ワークフローと標準ユーザー機能の両方をサポートしている場合は、それぞれに個別の OAuth クライアントを作成してください。クライアントの作成後にこの設定を変更することはできません。
  6. [Create] をクリックします。

    新しく作成した認証情報が [OAuth 2.0 クライアント ID] に表示されます。

  7. ダウンロードした JSON ファイルを credentials.json として保存し、作業ディレクトリに移動します。

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

  • npm を使用してライブラリをインストールします。

    npm install googleapis@105 @google-cloud/local-auth@2.1.0 --save
    

サンプルのセットアップ

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

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

    people/quickstart/index.js
    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();

サンプルの実行

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

    node .
    
  1. サンプルを初めて実行すると、アクセスを承認するよう求められます。
    1. Google アカウントにまだログインしていない場合は、ログインを求められたらログインします。複数のアカウントにログインしている場合は、承認に使用するアカウントを 1 つ選択します。
    2. [Accept] をクリックします。

    Node.js アプリケーションが実行され、People API が呼び出されます。

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

次のステップ