Что такое пример использования OAuth 2.0 и API Google Spreadsheet с Java?

Где пример кода, показывающий, как использовать Google Data Java Client Library и его поддержку для OAuth 2.0 с помощью Google Spreadsheet API (теперь называемого Google Sheets API)?

Ответ 1

Ответ перенесен из исходного вопроса в соответствие с форматом "Q и A".

Google Data Java Client Library поддерживает OAuth 2.0. К сожалению, в библиотеке нет полных образцов, показывающих, как использовать его с Google Spreadsheet API.

Вот пример, который сработал у меня. Надеюсь, кто-то найдет это полезным.

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeRequestUrl;
import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeTokenRequest;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.auth.oauth2.GoogleTokenResponse;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.jackson.JacksonFactory;
import com.google.gdata.util.ServiceException;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.Arrays;
import java.util.List;

public class NewClass {

  // Retrieve the CLIENT_ID and CLIENT_SECRET from an APIs Console project:
  //     https://code.google.com/apis/console
  static String CLIENT_ID = "your-client-id";
  static String CLIENT_SECRET = "your-client-secret";
  // Change the REDIRECT_URI value to your registered redirect URI for web
  // applications.
  static String REDIRECT_URI = "the-redirect-uri";
  // Add other requested scopes.
  static List<String> SCOPES = Arrays.asList("https://spreadsheets.google.com/feeds");


public static void main (String args[]) throws IOException, ServiceException, com.google.protobuf.ServiceException{
    Credential credencial = getCredentials();
    JavaApplication20.printDocuments(credencial);
}


  /**
   * Retrieve OAuth 2.0 credentials.
   * 
   * @return OAuth 2.0 Credential instance.
   */
  static Credential getCredentials() throws IOException {
    HttpTransport transport = new NetHttpTransport();
    JacksonFactory jsonFactory = new JacksonFactory();

    // Step 1: Authorize -->
    String authorizationUrl =
        new GoogleAuthorizationCodeRequestUrl(CLIENT_ID, REDIRECT_URI, SCOPES).build();

    // Point or redirect your user to the authorizationUrl.
    System.out.println("Go to the following link in your browser:");
    System.out.println(authorizationUrl);

    // Read the authorization code from the standard input stream.
    BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
    System.out.println("What is the authorization code?");
    String code = in.readLine();
    // End of Step 1 <--

    // Step 2: Exchange -->
    GoogleTokenResponse response =
        new GoogleAuthorizationCodeTokenRequest(transport, jsonFactory, CLIENT_ID, CLIENT_SECRET,
            code, REDIRECT_URI).execute();
    // End of Step 2 <--

    // Build a new GoogleCredential instance and return it.
    return new GoogleCredential.Builder().setClientSecrets(CLIENT_ID, CLIENT_SECRET)
        .setJsonFactory(jsonFactory).setTransport(transport).build()
     .setAccessToken(response.getAccessToken()).setRefreshToken(response.getRefreshToken());
  }

  // …
}

Здесь другой класс:

import com.google.api.client.auth.oauth2.Credential;
import com.google.gdata.client.docs.DocsService;
import com.google.gdata.client.spreadsheet.SpreadsheetService;
import com.google.gdata.data.docs.DocumentListEntry;
import com.google.gdata.data.docs.DocumentListFeed;
import com.google.gdata.data.docs.SpreadsheetEntry;
import com.google.gdata.data.spreadsheet.CellEntry;
import com.google.gdata.data.spreadsheet.CellFeed;
import com.google.gdata.data.spreadsheet.SpreadsheetFeed;
import com.google.gdata.data.spreadsheet.WorksheetEntry;
import com.google.gdata.data.spreadsheet.WorksheetFeed;
import com.google.gdata.util.ServiceException;
// ...
import java.io.IOException;
import java.net.URL;
import java.util.List;
// ...

public class JavaApplication20 {
  // …

  static void printDocuments(Credential credential) throws IOException, ServiceException {
    // Instantiate and authorize a new SpreadsheetService object.

     SpreadsheetService service =
            new SpreadsheetService("Aplication-name");
     service.setOAuth2Credentials(credential);
    // Send a request to the Documents List API to retrieve document entries.
    URL SPREADSHEET_FEED_URL = new URL(
        "https://spreadsheets.google.com/feeds/spreadsheets/private/full");
    // Make a request to the API and get all spreadsheets.
    SpreadsheetFeed feed = service.getFeed(SPREADSHEET_FEED_URL,
        SpreadsheetFeed.class);
    List<com.google.gdata.data.spreadsheet.SpreadsheetEntry> spreadsheets = feed.getEntries();
     if (spreadsheets.isEmpty()) {
      // TODO: There were no spreadsheets, act accordingly.
    }
com.google.gdata.data.spreadsheet.SpreadsheetEntry spreadsheet = spreadsheets.get(0);
    System.out.println(spreadsheet.getTitle().getPlainText());
// Get the first worksheet of the first spreadsheet.
    // TODO: Choose a worksheet more intelligently based on your
    // app needs.
    WorksheetFeed worksheetFeed = service.getFeed(
        spreadsheet.getWorksheetFeedUrl(), WorksheetFeed.class);
    List<WorksheetEntry> worksheets = worksheetFeed.getEntries();
    WorksheetEntry worksheet = worksheets.get(0);

    // Fetch the cell feed of the worksheet.
    URL cellFeedUrl = worksheet.getCellFeedUrl();
    CellFeed cellFeed = service.getFeed(cellFeedUrl, CellFeed.class);

    // Iterate through each cell, printing its value.
    for (CellEntry cell : cellFeed.getEntries()) {
      // Print the cell address in A1 notation
      System.out.print(cell.getTitle().getPlainText() + "\t");
      // Print the cell address in R1C1 notation
      System.out.print(cell.getId().substring(cell.getId().lastIndexOf('/') + 1) + "\t");
      // Print the cell formula or text value
      System.out.print(cell.getCell().getInputValue() + "\t");
      // Print the cell calculated value if the cell value is numeric
      // Prints empty string if cell value is not numeric
      System.out.print(cell.getCell().getNumericValue() + "\t");
      // Print the cell displayed value (useful if the cell has a formula)
      System.out.println(cell.getCell().getValue() + "\t");
    }

  }

  // ...
}

Ответ 2

Вы можете найти пошаговое объяснение с примерами здесь. В результате ваш код может выглядеть так:

SpreadsheetService service = new SpreadsheetService("MySpreadsheetIntegration-v1");
service.setProtocolVersion(SpreadsheetService.Versions.V1); // It important to specify the version

service.setRequestFactory(makeAuthorization());

SpreadsheetQuery q = new SpreadsheetQuery(new URL(DEFAULT_SPREADSHEET_QUERY));

SpreadsheetFeed feed;
try {
  feed = service.query(q, SpreadsheetFeed.class);
}
catch (AuthenticationException e) {
  refreshAccessToken(service);

  feed = service.query(q, SpreadsheetFeed.class);
}

SpreadsheetEntry spreadsheet = findSpreadSheet(feed);

...

// do your stuff

...

// a couple of utility methods are used above:

private void refreshAccessToken(SpreadsheetService service) throws Exception {
  String accessToken = callGetAccessTokenApi();

  // save access token

  service.getRequestFactory().setAuthToken(new GoogleAuthTokenFactory.OAuth2Token(new GoogleCredential().setAccessToken(accessToken)));
}

//private static final String GOOGLE_API_HOST = "https://www.googleapis.com/";

private String callGetAccessTokenApi() throws Exception {
  HttpClient client = HttpClients.createDefault();

  String url = String.format(
    "%soauth2/v3/token?client_id=%s&client_secret=%s&refresh_token=%s&grant_type=refresh_token",
    GOOGLE_API_HOST,
    googleAuthorization.getClientId(),
    googleAuthorization.getClientSecret(),
    googleAuthorization.getRefreshToken()
  );
  HttpPost post = new HttpPost(url);
  post.addHeader(ACCEPT_HEADER_NAME, "application/x-www-form-urlencoded");

  try {
    HttpResponse response = client.execute(post);

    JSONObject object = readJson(response);

    return object.getString("access_token");
  }
  finally {
    post.releaseConnection();
  }
}

private Service.GDataRequestFactory makeAuthorization() {
  Service.GDataRequestFactory requestFactory = new HttpGDataRequest.Factory();

  // load access token

  requestFactory.setAuthToken(new GoogleAuthTokenFactory.OAuth2Token(new GoogleCredential().setAccessToken(accessToken)));

  return requestFactory;
}

Ответ 3

(декабрь 2016 г.). Большая часть этого вопроса и большинства ответов здесь сейчас устарела: 1) GData API - это предыдущее поколение API Google. Хотя не все API-интерфейсы GData устарели, все современные API Google используют не протокол данных Google; и 2) Google выпустил новый API Google Таблиц v4 (а не GData) в 2016 году. Чтобы использовать новый API, вам нужно получить Клиентская библиотека API Google API для Java и используйте последний Листы API, который намного более мощный и гибкий, чем любой предыдущий API.

Здесь наш пример кода быстрого запуска Java, чтобы помочь вам начать использовать API - там тоже есть код OAuth2. Кроме того, здесь ссылка на JavaDocs для API листов, в которой перечислены все классы в вашем распоряжении. Если вы не "аллергия" на Python, я также сделал видео, просматривая код авторизации OAuth и еще пару видеороликов с более "реальными" примерами с помощью API-интерфейсов:

Доступ к API Google: Прохождение общего кода (глубокое погружение кода пост)
Перенос данных SQL на листе (глубокое погружение кода post)
Форматирование текста с помощью API-интерфейсов (глубокое погружение кода post)

Последний API предоставляет функции, недоступные в старых версиях, а именно предоставление разработчикам программного доступа к Листу, как если бы вы использовали пользовательский интерфейс (создавать замороженные строки, выполнять форматирование ячеек, изменять размер строк/столбцов, добавлять сводные таблицы, создавать диаграммы и т.д.) Также обратите внимание, что этот API предназначен в первую очередь для программных операций и функциональных возможностей электронных таблиц, как описано выше.

Чтобы выполнять доступ к файловому уровню, такой как загрузка и загрузка, импорт и экспорт (такие же, как загрузка и загрузка, но конвертирование в/из разных форматов), вы должны использовать API Google Диска, и вот пара примеров, которые я создал (также Python):

(простой) Экспорт таблицы Google в виде CSV (blogpost)
(промежуточный) Конвертер "Бедный человек в текст в PDF" (blogpost) (*)

(*) - TL; DR: загрузить обычный текстовый файл на диск, импортировать/конвертировать в формат Документов Google, а затем экспортировать этот документ в формате PDF. Сообщение выше использует Drive API v2; это последующее сообщение описывает перенос его на Drive API v3, а здесь видео разработчика, объединяющее обе записи.

Чтобы узнать больше о том, как использовать API Google (в основном Python или JavaScript), ознакомьтесь с различными видеороликами разработчика Google (series 1 и серия 2) Я создаю.