Java 快速入門導覽課程

快速入門說明如何設定及執行呼叫 Google Workspace API 的應用程式。

Google Workspace 快速入門導覽課程會使用 API 用戶端程式庫 驗證和授權流程的詳細資訊建議做法 您為自己的應用程式使用用戶端程式庫本快速入門導覽課程會使用 適合用於測試的簡易驗證方式 環境。在正式環境中，建議您瞭解 驗證與授權 再 選擇存取認證 挑選適合您應用程式的語言版本

建立 Java 指令列應用程式，向 Google Apps Script API 提出要求。

目標

  • 設定環境。
  • 設定範例。
  • 執行範例。

必要條件

  • 擁有已啟用 Google 雲端硬碟的 Google 帳戶。

設定環境

如要完成本快速入門課程，請設定環境。

啟用 API

使用 Google API 前，您必須先在 Google Cloud 專案中啟用這些 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。

  • 在 Google Cloud 控制台中，啟用 Google Apps Script API。

    啟用 API

如要使用新的 Google Cloud 專案完成本快速入門導覽課程，請設定 將自己新增為測試使用者。如果您已為 Cloud 專案完成這個步驟，請跳至下一節。

  1. 在 Google Cloud 控制台中，前往「選單」圖示 > API 與服務 >「OAuth 同意畫面」。

    前往 OAuth 同意畫面

  2. 在「使用者類型」部分選取「內部」，然後按一下「建立」。
  3. 填寫應用程式註冊表單，然後按一下「Save and Continue」。

  4. 目前您可以略過新增範圍，直接按一下「儲存並繼續」。日後您可以製作並使用應用程式 Google Workspace 機構，您必須將「使用者類型」變更為「外部」， 新增應用程式所需的授權範圍。

  5. 查看應用程式註冊摘要。如要修改資訊，請按一下「編輯」。如果應用程式註冊看起來沒問題，請按一下「返回資訊主頁」。

授權電腦版應用程式憑證

如要驗證使用者及存取應用程式中的使用者資料，您必須： 建立一或多個 OAuth 2.0 用戶端 ID。用戶端 ID 可用來識別 單一應用程式傳送至 Google 的 OAuth 伺服器。如果您的應用程式在多個平台上運作 您都必須為每個平台分別建立用戶端 ID。
  1. 在 Google Cloud 控制台中，依序點選「選單」圖示 > 「API 與」「服務」 >「憑證」。

    前往「憑證」

  2. 依序點選「建立憑證」>「OAuth 用戶端 ID」。
  3. 依序點選「應用程式類型」>「桌面應用程式」。
  4. 在「Name」欄位中輸入憑證名稱。這個名稱只會顯示在 Google Cloud 控制台中。
  5. 點選「建立」。系統會顯示「OAuth client created」(已建立 OAuth 用戶端) 畫面，其中顯示新的用戶端 ID 和用戶端密碼。
  6. 按一下「OK」(確定)。新建立的憑證會顯示在「OAuth 2.0 用戶端 ID」之下。
  7. 將下載的 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
    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 值相符。

  2. 在您的新的 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.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
  1. 第一次執行範例時，系統會提示您授予存取權：
    1. 如果尚未登入 Google 帳戶，請在系統提示時登入。如果 您已登入多個帳戶，請選取一個用於授權的帳戶。
    2. 然後點選 [Accept]。

    Java 應用程式會執行並呼叫 Google Apps Script API。

    授權資訊會儲存在檔案系統中，因此下次您執行範例時 這樣系統就不會提示您授權

後續步驟