JavaScript クイックスタート

Google Apps Script API にリクエストを行う JavaScript ウェブアプリケーションを作成します。

クイックスタートでは、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 で、メニュー > [Google Auth Platform] > [Branding] に移動します。
[Branding] に移動
Google Auth Platform をすでに構成している場合は、[Branding]、[Audience]、および [Data Access] で次の OAuth 同意画面の設定を構成できます。[**Google Auth Platform はまだ構成されていません**] というメッセージが表示されたら、[**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 で、メニュー > [Google Auth Platform] > [Clients] に移動します。
[Clients] に移動
[Create Client] をクリックします。
[Application type] > [Web application] をクリックします。
[Name] フィールドに、認証情報の名前を入力します。この名前は Google API Console にのみ表示されます。
アプリに関連する承認済み URI を追加します。
- クライアントサイドアプリ（JavaScript）–[Authorized JavaScript origins] で [Add URI] をクリックします。次に、ブラウザリクエストに使用する URI を入力します。これにより、アプリケーションが OAuth 2.0 サーバーに API リクエストを送信できるドメインが識別されます。
- サーバーサイドアプリ（Java、Python など）–[Authorized redirect URIs] で [Add URI] をクリックします。次に、OAuth 2.0 サーバーがレスポンスを送信できるエンドポイント URI を入力します。
[Create] をクリックします。
新しく作成した認証情報が [OAuth 2.0 クライアント ID] に表示されます。

クライアント ID をメモします。ウェブアプリケーションではクライアントシークレットは使用されません。

これらの認証情報は、このクイックスタートで後ほど必要になるため、メモしておいてください。

API キーを作成する

Google Cloud コンソールで、メニュー > [APIs & Services] > [Credentials] に移動します。
[認証情報] に移動
[Create credentials] > [API key] をクリックします。
新しい API キーが表示されます。
- Copy をクリックして、アプリのコードで使用する API キーをコピーします。API キーは、プロジェクトの認証情報の [API キー] セクションにもあります。
- 不正使用を防ぐため、API キーを使用できる場所と対象の API を制限することをおすすめします。詳細については、 API 制限を追加するをご覧ください。

サンプルのセットアップ

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

index.html ファイルに、次のサンプルコードを貼り付けます。

apps-script/quickstart/index.html

GitHub で表示

<!DOCTYPE html>
<html>
  <head>
    <title>Google Apps Script API Quickstart</title>
    <meta charset="utf-8" />
  </head>
  <body>
    <p>Google Apps Script API Quickstart</p>

    <!--Add buttons to initiate auth sequence and sign out-->
    <button id="authorize_button" onclick="handleAuthClick()">Authorize</button>
    <button id="signout_button" onclick="handleSignoutClick()">Sign Out</button>

    <pre id="content" style="white-space: pre-wrap;"></pre>

    <script type="text/javascript">
      /* exported gapiLoaded */
      /* exported gisLoaded */
      /* exported handleAuthClick */
      /* exported handleSignoutClick */

      // TODO(developer): Set to client ID and API key from the Developer Console
      const CLIENT_ID = '<YOUR_CLIENT_ID>';
      const API_KEY = '<YOUR_API_KEY>';

      // Discovery doc URL for APIs used by the quickstart
      const DISCOVERY_DOC = 'https://script.googleapis.com/$discovery/rest?version=v1';

      // Authorization scopes required by the API; multiple scopes can be
      // included, separated by spaces.
      const SCOPES = 'https://www.googleapis.com/auth/script.projects';

      let tokenClient;
      let gapiInited = false;
      let gisInited = false;

      document.getElementById('authorize_button').style.visibility = 'hidden';
      document.getElementById('signout_button').style.visibility = 'hidden';

      /**
       * Callback after api.js is loaded.
       */
      function gapiLoaded() {
        gapi.load('client', initializeGapiClient);
      }

      /**
       * Callback after the API client is loaded. Loads the
       * discovery doc to initialize the API.
       */
      async function initializeGapiClient() {
        await gapi.client.init({
          apiKey: API_KEY,
          discoveryDocs: [DISCOVERY_DOC],
        });
        gapiInited = true;
        maybeEnableButtons();
      }

      /**
       * Callback after Google Identity Services are loaded.
       */
      function gisLoaded() {
        tokenClient = google.accounts.oauth2.initTokenClient({
          client_id: CLIENT_ID,
          scope: SCOPES,
          callback: '', // defined later
        });
        gisInited = true;
        maybeEnableButtons();
      }

      /**
       * Enables user interaction after all libraries are loaded.
       */
      function maybeEnableButtons() {
        if (gapiInited && gisInited) {
          document.getElementById('authorize_button').style.visibility = 'visible';
        }
      }

      /**
       *  Sign in the user upon button click.
       */
      function handleAuthClick() {
        tokenClient.callback = async (resp) => {
          if (resp.error !== undefined) {
            throw (resp);
          }
          document.getElementById('signout_button').style.visibility = 'visible';
          document.getElementById('authorize_button').innerText = 'Refresh';
          await createScript();
        };

        if (gapi.client.getToken() === null) {
          // Prompt the user to select a Google Account and ask for consent to share their data
          // when establishing a new session.
          tokenClient.requestAccessToken({prompt: 'consent'});
        } else {
          // Skip display of account chooser and consent dialog for an existing session.
          tokenClient.requestAccessToken({prompt: ''});
        }
      }

      /**
       *  Sign out the user upon button click.
       */
      function handleSignoutClick() {
        const token = gapi.client.getToken();
        if (token !== null) {
          google.accounts.oauth2.revoke(token.access_token);
          gapi.client.setToken('');
          document.getElementById('content').innerText = '';
          document.getElementById('authorize_button').innerText = 'Authorize';
          document.getElementById('signout_button').style.visibility = 'hidden';
        }
      }

      /**
       * Creates a new 'Hello world' script.
       */
      async function createScript() {
        let response;
        try {
          const createRequest = {
            resource: {
              title: 'My Script',
            },
          };
          response = await gapi.client.script.projects.create(createRequest);

          const updateContentRequest = {
            scriptId: response.result.scriptId,
            resource: {
              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"}',
              }],
            },
          };
          response = await gapi.client.script.projects.updateContent(updateContentRequest);
          const output = `Script URL: https://script.google.com/d/${response.result.scriptId}/edit`;
          document.getElementById('content').innerText = output;
        } catch (err) {
          document.getElementById('content').innerText = err.message;
          return;
        }
      }
    </script>
    <script async defer src="https://apis.google.com/js/api.js" onload="gapiLoaded()"></script>
    <script async defer src="https://accounts.google.com/gsi/client" onload="gisLoaded()"></script>
  </body>
</html>

次のように置き換えます。

YOUR_CLIENT_ID: ウェブアプリケーションの認証情報を承認したときに作成したクライアント ID。
YOUR_API_KEY: 作成した API キー。

サンプルの実行

作業ディレクトリに http-server パッケージをインストールします。
```
npm install http-server
```
作業ディレクトリでウェブサーバーを起動します。
```
npx http-server -p 8000
```

ブラウザで http://localhost:8000 にアクセスします。
アクセス権限の承認を求めるプロンプトが表示されます。
1. Google アカウントにまだログインしていない場合は、プロンプトが表示されたらログインします。複数のアカウントにログインしている場合は、承認に使用するアカウントを 1 つ選択します。
2. [Accept] をクリックします。

JavaScript アプリケーションが実行され、Google Apps Script API が呼び出されます。

次のステップ

API エクスプローラで Google Workspace API を試す
- Apps Script API リファレンスドキュメント
- GitHub の google-api-javascript-client セクション

JavaScript クイックスタート コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

目標