repository·main·Indexed 23 days ago
https://github.com/googleapis/google-api-java-clientA flexible Java client library for accessing HTTP-based APIs, featuring specialized support for Google APIs. It provides a consistent OAuth 2.0 library, lightweight XML and JSON data models, protocol buffer support, and generated libraries for Google APIs. Compatible with Java 7+, Android 1.6+, and Google App Engine. Includes modular extensions for GSON, Jackson2, and platform-specific integrations for Android, Servlets, and App Engine.
The Google APIs Client Library for Java is a flexible and efficient client for accessing any HTTP-based API, including Google APIs.
Key features include:
Supported Environments:
The Google APIs Client Library for Java is compatible with the following environments:
The library supports two modes for downloading media:
Access tokens typically expire after 1 hour. GoogleCredentials handles automatic refreshing if a long-lived refresh token is available (obtained via access_type=offline during the authorization flow). To maintain these tokens across application restarts, you must persist them using a DataStoreFactory.
Available implementations include:
AppEngineDataStoreFactory: Persists credentials using the Google App Engine Data Store API.FileDataStoreFactory: Persists credentials in a file.MemoryDataStoreFactory: Persists credentials in memory (volatile; only useful for the lifetime of the process).You can also provide a custom implementation of DataStoreFactory to use your own storage mechanism.
If you are building a web application that interacts with user data via OAuth 2.0-enabled APIs, the library provides helpers to:
AuthorizationCodeFlow.PersistenceCapable (e.g., using Google Cloud Datastore).Credential.GoogleCredential.Builder.setServiceAccountUser(String) during the credential construction process.AccountManager class for centralized identity management and credential token storage. For specific details on the OAuth 2.0 flow on Android, refer to the project's OAuth 2.0 instructions.When using the library, be aware of the following stability markers:
Features annotated with @Beta at the class or method level are subject to change or removal in any major release. Warning: Do not use @Beta features if you are developing a library intended for use by others (i.e., code that will reside on the CLASSPATH of external users).
Non-beta features marked as deprecated will be removed eighteen months after the release in which they were first deprecated. You must update your code within this window to avoid breakage, as removal may not always result in a compilation error.
The Google API Client Library for Java is modular. You should choose the module that matches your target platform or preferred data format to ensure compatibility and optimal performance.
google-api-client: The base library designed for compatibility across all supported Java platforms, including Android.google-api-client-android for Java Google Android applications (requires SDK >= 2.1). It depends on google-api-client and google-http-client-android.google-api-client-servlet for Java servlet web applications. It depends on google-api-client and google-oauth-client-servlet.google-api-client-appengine for Google App Engine applications. It depends on google-api-client, google-api-client-servlet, google-oauth-client-appengine, and google-http-client-appengine.If you require specific serialization or transport formats, use these modules:
google-api-client-gson (depends on google-api-client and google-http-client-gson).google-api-client-jackson2 (depends on google-api-client and google-http-client-jackson2).google-api-client-protobuf (depends on google-api-client and google-http-client-protobuf).google-api-client-xml (depends on google-api-client and google-http-client-xml).The library follows specific stability guidelines:
@Beta are subject to change or removal in any major release. Avoid using beta features if you are building a library intended for use by third parties (i.e., code that will reside on the CLASSPATH of users outside your control).To set up a Google App Engine application using the Java Client Library, follow these steps:
war/WEB-INF/lib directory, or use Maven.When developing for Android, if the API you need is available in the [Google Play Services library], use that for optimal performance. For all other Google APIs, use the Google APIs Client Library for Java's Android-specific helper classes. These classes integrate with the Android AccountManager for identity management.
To initialize a service, use GoogleAccountCredential.usingOAuth2() to create credentials and then pass them to the service's Builder.
@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();
}