Java クイックスタート

Google Apps Script API にリクエストを行う Java コマンドライン アプリケーションを作成します。

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

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

目標

• 環境をセットアップする。
• サンプルをセットアップする。
• サンプルを実行する。

前提条件

• Java 11 以降。
• Gradle 7.0 以降。
• 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 プロジェクトでこの手順をすでに完了している場合は、次のセクションに進んでください。

1. Google API Console で、メニュー アイコン menu 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 menu > [Google Auth Platform] > [クライアント] に移動します。

   [クライアント] に移動

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

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

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

職場環境を整える

1. 作業ディレクトリに、新しいプロジェクト構造を作成します。

   gradle init --type basic
   mkdir -p src/main/java src/main/resources 
   

2. src/main/resources/ ディレクトリに、以前にダウンロードした credentials.json ファイルをコピーします。

3. デフォルトの build.gradle ファイルを開き、その内容を次のコードに置き換えます。

   appsScript/quickstart/build.gradle

   GitHub で表示
   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'AppsScriptQuickstart'
   sourceCompatibility = 11
   targetCompatibility = 11
   version = '1.0'
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'com.google.api-client:google-api-client:2.0.0'
       implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
       implementation 'com.google.apis:google-api-services-script:v1-rev20220323-2.0.0'
   }

サンプルのセットアップ

1. src/main/java/ ディレクトリに、build.gradle ファイルの mainClassName 値と一致する名前の新しい Java ファイルを作成します。

2. 新しい Java ファイルに次のコードを追加します。

   appsScript/quickstart/src/main/java/AppsScriptQuickstart.java

   GitHub で表示
   import com.google.api.client.auth.oauth2.Credential;
   import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
   import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
   import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
   import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.javanet.NetHttpTransport;
   import com.google.api.client.json.JsonFactory;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.client.util.store.FileDataStoreFactory;
   import com.google.api.services.script.Script;
   import com.google.api.services.script.model.Content;
   import com.google.api.services.script.model.CreateProjectRequest;
   import com.google.api.services.script.model.File;
   import com.google.api.services.script.model.Project;
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.security.GeneralSecurityException;
   import java.util.Arrays;
   import java.util.Collections;
   import java.util.List;
   
   public class AppsScriptQuickstart {
     private static final String APPLICATION_NAME = "Apps Script API Java Quickstart";
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
     private static final String TOKENS_DIRECTORY_PATH = "tokens";
   
     /**
      * Global instance of the scopes required by this quickstart.
      * If modifying these scopes, delete your previously saved credentials folder at /secret.
      */
     private static final List<String> SCOPES =
         Collections.singletonList("https://www.googleapis.com/auth/script.projects");
     private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
   
     /**
      * Creates an authorized Credential object.
      *
      * @param HTTP_TRANSPORT The network HTTP Transport.
      * @return An authorized Credential object.
      * @throws IOException If the credentials.json file cannot be found.
      */
     private static Credential getCredentials(final NetHttpTransport HTTP_TRANSPORT)
         throws IOException {
       // Load client secrets.
       InputStream in = AppsScriptQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
       if (in == null) {
         throw new FileNotFoundException("Resource not found: " + CREDENTIALS_FILE_PATH);
       }
       GoogleClientSecrets clientSecrets =
           GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in));
   
       // Build flow and trigger user authorization request.
       GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder(
           HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, SCOPES)
           .setDataStoreFactory(new FileDataStoreFactory(new java.io.File(TOKENS_DIRECTORY_PATH)))
           .setAccessType("offline")
           .build();
       LocalServerReceiver receiver = new LocalServerReceiver.Builder().setPort(8888).build();
       return new AuthorizationCodeInstalledApp(flow, receiver).authorize("user");
     }
   
     public static void main(String... args) throws IOException, GeneralSecurityException {
       // Build a new authorized API client service.
       final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
       Script service =
           new Script.Builder(HTTP_TRANSPORT, JSON_FACTORY, getCredentials(HTTP_TRANSPORT))
               .setApplicationName(APPLICATION_NAME)
               .build();
       Script.Projects projects = service.projects();
   
       // Creates a new script project.
       Project createOp = projects.create(new CreateProjectRequest().setTitle("My Script")).execute();
   
       // Uploads two files to the project.
       File file1 = new File()
           .setName("hello")
           .setType("SERVER_JS")
           .setSource("function helloWorld() {\n  console.log(\"Hello, world!\");\n}");
       File file2 = new File()
           .setName("appsscript")
           .setType("JSON")
           .setSource("{\"timeZone\":\"America/New_York\",\"exceptionLogging\":\"CLOUD\"}");
       Content content = new Content().setFiles(Arrays.asList(file1, file2));
       Content updatedContent = projects.updateContent(createOp.getScriptId(), content).execute();
   
       // Logs the project URL.
       System.out.printf("https://script.google.com/d/%s/edit\n", updatedContent.getScriptId());
     }
   }

サンプルの実行

1. サンプルを実行します。

   gradle run
   

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

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

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

次のステップ

• API エクスプローラで Google Workspace API を試す
• Apps Script API リファレンス ドキュメント
• Java 用 Google API クライアント ドキュメント
• Google Apps Script API Javadoc ドキュメント