Skip to content
Google APIs Client Library for Java
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix CODEOWNERS format Oct 12, 2018
.kokoro Enable autorelease (#1313) Jun 6, 2019
google-api-client-android Bump next snapshot (#1328) Jun 18, 2019
google-api-client-appengine Bump next snapshot (#1328) Jun 18, 2019
google-api-client-assembly Bump next snapshot (#1328) Jun 18, 2019
google-api-client-bom Bump next snapshot (#1328) Jun 18, 2019
google-api-client-gson Bump next snapshot (#1328) Jun 18, 2019
google-api-client-jackson2 Bump next snapshot (#1328) Jun 18, 2019
google-api-client-java6 Bump next snapshot (#1328) Jun 18, 2019
google-api-client-protobuf Bump next snapshot (#1328) Jun 18, 2019
google-api-client-servlet Bump next snapshot (#1328) Jun 18, 2019
google-api-client-xml Bump next snapshot (#1328) Jun 18, 2019
google-api-client Bump next snapshot (#1328) Jun 18, 2019
.gitignore Fix AppEngine tests (#1184) Sep 21, 2018
.travis.yml TravisCI: Cut out android and assembly modules before install and tes… Feb 7, 2018
CODE_OF_CONDUCT.md Add Code of Conduct Jul 2, 2018
LICENSE Add LICENSE Jan 9, 2015
README.md Release google-api-java-client v1.30.0 (#1327) Jun 18, 2019
checkstyle-suppressions.xml api: deprecate com.google.api.client.googleapis.subscriptions Jun 25, 2013
checkstyle.xml Fix checkstyle: allow long URLs inside comments Mar 13, 2015
clirr-ignored-differences.xml Remove ClientLogin (#1224) Jan 2, 2019
findbugs-exclude.xml Remove ClientLogin (#1224) Jan 2, 2019
pom.xml Update dependency com.google.oauth-client:google-oauth-client-bom to … Jun 18, 2019
renovate.json Group AppEngine deps for renovate Jun 17, 2019
versions.txt Bump next snapshot (#1328) Jun 18, 2019

README.md

Google APIs Client Library for Java

Library Maintenance

These client libraries are officially supported by Google. However, these libraries are considered complete and are in maintenance mode. This means that we will address critical bugs and security issues, but will not add any new features. If you're working with Google Cloud Platform APIs such as Datastore, Pub/Sub and many others, consider using the Cloud Client Libraries for Java instead. These are the new and idiomatic Java libraries targeted specifically at Google Cloud Platform Services.

Building locally

One time setup
mkdir /tmp/foo && cd /tmp/foo
wget https://dl.google.com/dl/android/maven2/com/google/android/gms/play-services-basement/8.3.0/play-services-basement-8.3.0.aar
unzip play-services-basement-8.3.0.aar
mvn install:install-file \
  -Dfile=classes.jar \
  -DgroupId=com.google.android.google-play-services \
  -DartifactId=google-play-services \
  -Dversion=1 \
  -Dpackaging=jar
cd -

# we need the google-http-java-client jar cached locally
git clone https://github.com/google/google-http-java-client.git
cd google-http-java-client && mvn compile && mvn install && cd ..

# we need the google-oauth-java-client jar cached locally
git clone https://github.com/google/google-oauth-java-client.git
cd google-oauth-java-client && mvn compile && mvn install
Building And Testing
mvn install

Overview

The Google APIs Client Library for Java is a flexible, efficient, and powerful Java client library for accessing any HTTP-based API on the web, not just Google APIs.

The library has the following features:

Accessing Google APIs

To use Google's Java client libraries to call any Google API, you need two libraries:

  • The core Google APIs Client Library for Java (google-api-java-client), which is the generic runtime library described here. This library provides functionality common to all APIs, for example HTTP transport, error handling, authentication, JSON parsing, media download/upload, and batching.
  • An auto-generated Java library for the API you are accessing, for example the generated Java library for the BigQuery API. These generated libraries include API-specific information such as the root URL, and classes that represent entities in the context of the API. These classes are useful for making conversions between JSON objects and Java objects.

To find the generated library for a Google API, visit Google APIs Client Library for Java. The API-specific Java packages include both the core google-api-java-client and the client-specific libraries.

If you are using the old GData library, you need to migrate.

Developing for Android

If you are developing for Android and the Google API you want to use is included in the Google Play Services library, use that library for the best performance and experience.

To access other Google APIs, use the Google APIs Client Library for Java, which supports Android 4.0 (Ice Cream Sandwich) (or higher).

Other Java environments

Highlighted Features

  • The library makes it simple to call Google APIs.

You can call Google APIs using Google service-specific generated libraries with the Google APIs Client Library for Java. Here's an example that makes a call to the Google Calendar API:

// Show events on user's calendar.
View.header("Show Calendars");
CalendarList feed = client.calendarList().list().execute();
View.display(feed);
  • The library makes authentication easier.

The authentication library can reduce the amount of code needed to handle OAuth 2.0, and sometimes a few lines is all you need. For example:

/** 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");
}
  • The library makes batching and media upload/download easier.

The library offers helper classes for batching, media upload, and media download.

  • The library runs on Google App Engine.

App Engine-specific helpers make quick work of authenticated calls to APIs, and you do not need to worry about exchanging code for tokens. For example:

@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();
  ...
}

If you are developing for Android and the Google API you want to use is included in the Google Play Services library, use that library for the best performance and experience.

To access other Google APIs, use the Google Client Library for Java's Android-specific helper classes, which are well-integrated with Android AccountManager. For example:

@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();
}
  • The library is easy to install.

The Google APIs Client Library for Java is easy to install, and you can download the binary directly from the Downloads page, or you can use Maven or Gradle.

To use Maven, add the following lines to your pom.xml file: //: # ({x-version-update-start:google-api-client:released})

<project>
  <dependencies>
    <dependency>
      <groupId>com.google.api-client</groupId>
      <artifactId>google-api-client</artifactId>
      <version>1.30.0</version>
    </dependency>
  </dependencies>
</project>

To use Gradle, add the following lines to your build.gradle file:

repositories {
    mavenCentral()
}
dependencies {
    compile 'com.google.api-client:google-api-client:1.30.0'
}

CI Status

Java Version Status
Java 7 Kokoro CI
Java 8 Kokoro CI
Java 11 Kokoro CI

Dependencies

This library is built on top of two common libraries, also built by Google, and also designed to work with any HTTP service on the web:

Important Warnings

@Beta

Features marked with the @Beta annotation at the class or method level are subject to change. They might be modified in any way, or even removed, in any major release. You should not use beta features if your code is a library itself (that is, if your code is used on the CLASSPATH of users outside your own control).

Deprecations

Deprecated non-beta features will be removed eighteen months after the release in which they are first deprecated. You must fix your usages before this time. If you don't, any type of breakage might result, and you are not guaranteed a compilation error.

Documentation

Links

For questions or concerns, please file an issue in the GitHub repository.

You can’t perform that action at this time.