API Client Library for Java | Google for Developers (original) (raw)
适用于 Java 的 Google API 客户端库提供所有 Google API 通用的功能，例如 HTTP 传输、错误处理、身份验证、JSON 解析、媒体下载/上传和批处理。该库包含一个强大的 OAuth 2.0 库，它具有一致的界面；轻量级且高效的 XML 和 JSON 数据模型（支持任何数据架构）；以及对协议缓冲区的支持。
要使用 Google 的 Java 版客户端库调用 Google API，您需要为要访问的 Google API 生成 Java 库。这些生成的库包含核心 google-api-java-client 库以及特定于 API 的信息（如根网址）。这些 API 还包含在 API 上下文中表示实体且有助于在 JSON 对象和 Java 对象之间进行转换的类。
Beta 版功能
在类或方法级别带有 @Beta 标记的功能可能会发生变化。在任何主要版本中，它们可能会被修改或移除。如果您的代码本身就是库（也就是说，如果您的代码在您无法控制的用户的 CLASSPATH 中使用），请勿使用 Beta 版功能。
已弃用的功能
已弃用的非 Beta 版功能将在首次弃用之日起的 18 个月后移除。您必须在此期限之前修正您的使用情况。否则，可能会导致任何类型的破坏，并且无法保证出现编译错误。
Java 版 Google API 客户端库的亮点
调用 Google API 非常简单
您可以通过适用于 Java 的 Google API 客户端库，使用 Google 服务生成的库来调用 Google API。（如需查找为 Google API 生成的客户端库，请访问支持的 Google API 列表）。以下示例使用 Java 版日历 API 客户端库调用 Google 日历 API：
// Show events on user's calendar. View.header("Show Calendars"); CalendarList feed = client.calendarList().list().execute(); View.display(feed);
该库可简化批处理和媒体上传/下载
此库简化了身份验证
该库包含一个强大的身份验证库，可以减少您需要处理 OAuth 2.0 的代码量。有时，只需几行即可。例如：
/** Authorizes the installed application to access user's protected data. */ private static Credential authorize() throws Exception { // load client secrets GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(CalendarSample.class.getResourceAsStream("/client_secrets.json"))); // set up authorization code flow GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder( httpTransport, JSON_FACTORY, clientSecrets, Collections.singleton(CalendarScopes.CALENDAR)).setDataStoreFactory(dataStoreFactory) .build(); // authorize return new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user"); }
该库在 Google App Engine 上运行
App Engine 专属帮助程序可以快速完成对 API 的经过身份验证的调用，而您无需担心如何交换代码来换取令牌。
例如：
@Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException { AppIdentityCredential credential = new AppIdentityCredential(Arrays.asList(UrlshortenerScopes.URLSHORTENER)); Urlshortener shortener = new Urlshortener.Builder(new UrlFetchTransport(), new JacksonFactory(), credential) .build(); UrlHistory history = shortener.URL().list().execute(); ... }
该库可在 Android 4.4 或更高版本上运行。
适用于 Java 的 Google 客户端库的 Android 专用帮助程序类已与 Android AccountManager 充分集成。例如：
@Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // Google Accounts credential = GoogleAccountCredential.usingOAuth2(this, Collections.singleton(TasksScopes.TASKS)); SharedPreferences settings = getPreferences(Context.MODE_PRIVATE); credential.setSelectedAccountName(settings.getString(PREF_ACCOUNT_NAME, null)); // Tasks client service = new com.google.api.services.tasks.Tasks.Builder(httpTransport, jsonFactory, credential) .setApplicationName("Google-TasksAndroidSample/1.0").build(); }
安装简单
如果您不使用生成的库，可以直接从下载页面下载适用于 Java 的 Google API 客户端库的二进制文件，也可以使用 Maven 或 Gradle。如需使用 Maven，请将以下行添加到您的 pom.xml 文件中：
com.google.api-client google-api-client 1.32.1如需使用 Gradle，请将以下行添加到 build.gradle 文件中：
repositories { mavenCentral() } dependencies { compile 'com.google.api-client:google-api-client:1.32.1' }
有关安装和设置 Google API 的更多详情 请参阅下载 和设置说明。