Node.js クイックスタート

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

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

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

目標

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

前提条件

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

  • Google アカウントがある。

環境の設定

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

API を有効にする

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

    API を有効にする

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

  1. Google API Console で、メニュー アイコン menu > [Google Auth Platform] > [ブランディング] に移動します。

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

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

    [クライアント] に移動

  2. [クライアントの作成] をクリックします。
  3. [アプリケーション タイプ] [>] [デスクトップ アプリ] をクリックします。
  4. [名前] フィールドに、認証情報の名前を入力します。この名前は Google API Console にのみ表示されます。
  5. [作成] をクリックします。

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

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

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

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

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

サンプルのセットアップ

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

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

    drive/activity-v2/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 Drive activity.
    const SCOPES = ['https://www.googleapis.com/auth/drive.activity.readonly'];
    // The path to the credentials file.
    const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');
    
    /**
     * Lists the recent activity in your Google Drive.
     */
    async function listDriveActivity() {
      // Authenticate with Google and get an authorized client.
      const auth = await authenticate({
        scopes: SCOPES,
        keyfilePath: CREDENTIALS_PATH,
      });
    
      // Create a new Drive Activity API client.
      const service = google.driveactivity({version: 'v2', auth});
    
      // The parameters for the activity query.
      const params = {
        pageSize: 10,
      };
    
      // Query for recent activity.
      const result = await service.activity.query({requestBody: params});
      const activities = result.data.activities;
      if (!activities || activities.length === 0) {
        console.log('No activity.');
        return;
      }
      console.log('Recent activity:');
      // Print the recent activity.
      console.log(JSON.stringify(activities, null, 2));
    }
    
    await listDriveActivity();

サンプルの実行

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

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

    Node.js アプリケーションが実行され、Google ドライブ Activity API が呼び出されます。

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

次のステップ