Java Quickstart

Complete the steps described in the rest of this page to create a simple Java command-line application that makes requests to the Google Apps Script API.

Prerequisites

To run this quickstart, you need the following prerequisites:

  • Java 1.8 or greater
  • Gradle 2.3 or greater.
  • A Google Cloud Platform project with the API enabled. To create a project and enable an API, refer to Create a project and enable the API

    Note: For this quickstart, you are enabling the "Google Apps Script API".
    
    • Authorization credentials for a desktop application. To learn how to create credentials for a desktop application, refer to Create credentials.
    • A Google account with Google Drive enabled

    Step 1: Prepare the project

    To prepare the project:

    1. In your working directory, run the following commands to create a new project structure:

      gradle init --type basic
      mkdir -p src/main/java src/main/resources 
      
    2. Copy the credentials.json file you downloaded as a prerequisite into the newly-created src/main/resources/ directory.

    3. Open the default build.gradle file and replace its contents with the following code:

      appsScript/quickstart/build.gradle
      apply plugin: 'java'
      apply plugin: 'application'
      
      mainClassName = 'AppsScriptQuickstart'
      sourceCompatibility = 1.8
      targetCompatibility = 1.8
      version = '1.0'
      
      repositories {
          mavenCentral()
      }
      
      dependencies {
          compile 'com.google.api-client:google-api-client:1.23.0'
          compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
          compile 'com.google.apis:google-api-services-script:v1-rev175-1.23.0'
      }
      

    Step 2: Set up the sample

    To set up the sample:

    1. In src/main/java/, create a file named apps_scriptQuickstart.java.
    2. Include the following code in apps_scriptQuickstart.java:

      appsScript/quickstart/src/main/java/AppsScriptQuickstart.java
      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.jackson2.JacksonFactory;
      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 = JacksonFactory.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());
          }
      }

    Step 3: Run the sample

    To run the sample:

    1. Execute the following command:

      gradle run
      

      This command builds and runs the sample.

    2. (optional). If this is your first time running the sample, the sample opens a new window prompting you to authorize access to your data:

      1. If you are not already signed in to your Google account, you are prompted to sign in. If you are signed in to multiple Google accounts, you are asked to select one account to use for authorization.
      1. Click Accept. The app is authorized to access your data.
    3. The sample executes.

    If you have problems, refer to the Troubleshoot the sample section.

    Troubleshoot the sample

    This section describes a common issue that you can encounter while attempting to run this quickstart.

    This app isn't verified

    If the OAuth consent screen displays the warning "This app isn't verified," your app is requesting scopes that provide access to sensitive user data. If your application uses sensitive scopes, your your app must go through the verification process to remove that warning and other limitations. During the development phase you can continue past this warning by clicking Advanced > Go to {Project Name} (unsafe).

    Further reading

    For further information on the APIs used in this quickstart, refer to the following: