Google Photos Library API Java Client Library

This repository contains the Java client library for the Google Photos Library API.

Requirements and preparation

• Java 1.8+
• Gradle build system >= 6.5.1 or Maven recommended.
• OAuth 2.0 credentials configured for your project as described below. (Note that to run the samples, use the "other" client type.)

Download the client library

Firstly, download the library or include it in your build configuration. Then, set up OAuth 2.0 credentials to access the API.

Next, you can follow the samples to see the client library in action.

Option 1: Gradle dependency

To use this library with Gradle, add the following dependency to your build.gradle file and replace VERSION_NUMBER with the latest available release):

repositories {
    mavenCentral()
}
dependencies {
    implementation 'com.google.photos.library:google-photos-library-client:VERSION_NUMBER'
}

Option 2: Maven dependency

To use this library with Maven, add the following to your Maven pom.xml file and replace VERSION_NUMBER with the latest available release):

<dependency>
  <groupId>com.google.photos.library</groupId>
  <artifactId>google-photos-library-client</artifactId>
  <version>VERSION_NUMBER</version>
</dependency>

Option 3: Download a release

The releases page contains different artifacts for each library release, including jar files.

Option 4: Clone the repository

Use this method if you want to alter or contribute to this library (e.g., submitting pull requests) or wish to try our samples. When you clone the repository, all files in this repository will be downloaded.

1. Run git clone https://github.com/google/java-photoslibrary.git at the command prompt.
2. You'll get a java-photoslibrary directory. Navigate to it by running cd java-photoslibrary.
3. Open the build.gradle file in your IDE or run ./gradlew assemble at the command prompt to build the project. See ./gradlew tasks to see available tasks

Set up your OAuth2 credentials for Java

The Google Photos Library API uses OAuth2 as the authentication mechanism. Note that the Library API does not support service accounts.

To complete the “Enable the API” and “Configure OAuth2.0” steps in the below procedure, refer to the get started guide in the developer documentation

Follow the below steps:

1. Set up a Google developers project
2. Enable the Google Photos Library API in your developer project
3. Configure OAuth 2.0 credentials, including a callback URI
4. Either download your OAuth credentials as a JSON file or note your client ID and secret.

To try out the samples in this repository, select "other" as the application type.

This client library works with the Google Auth Library for Java. Specify your client OAuth configuration in the CredentialsProvider when creating the PhotoLibrarySettings for a PhotosLibraryClient object. See the file PhotosLibraryClientFactory.java for an example on how to create a new PhotosLibraryClient object with credentials from the Google Auth Library.

Sample usage

API calls

Here's a short example that shows how to create a new album:

// [START sample_usage]
// Set up the Photos Library Client that interacts with the API
PhotosLibrarySettings settings =
     PhotosLibrarySettings.newBuilder()
    .setCredentialsProvider(
        FixedCredentialsProvider.create(/* Add credentials here. */)) 
    .build();

try (PhotosLibraryClient photosLibraryClient =
    PhotosLibraryClient.initialize(settings)) {

    // Create a new Album  with at title
    Album createdAlbum = photosLibraryClient.createAlbum("My Album");

    // Get some properties from the album, such as its ID and product URL
    String id = album.getId();
    String url = album.getProductUrl();

} catch (ApiException e) {
    // Error during album creation
}
// [END sample_usage]

The Google Photos Library API should be accessed via the PhotosLibraryClient class, which contains some additional abstractions and utility methods. You should not use the underlying InternalPhotosLibraryClient and associated classes directly.

Google API Extensions

This library uses the *Google API Extensions for Java (GAX Java) library for API access.

In particular, there are three ways of making calls to each of the API's methods:

• A "flattened" method (recommended). With this type of method, the fields of the request type have been converted into function parameters. Use the class PhotosLibraryClient to make these requests.
• A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
• A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

Paged responses and Callables

Using the Google API Extensions library, pagination as described in the Google Photos Library API developer documentation is supported via PagedListResponse, for example ListAlbumsPagedResponse.

try {
    // Make a request to list all albums in the user's library
    // Iterate over all the albums in this list
    // Pagination is handled automatically
    ListAlbumsPagedResponse response = photosLibraryClient.listAlbums();

    for (Album album : response.iterateAll()) {
        // Get some properties of an album and do something with them.
        String id = album.getId();
    }
} catch (ApiException e) {
    // Handle error
}

Retry configuration

The default retry configuration follows the AIP guidance for retrying API requests, which is configured in com.google.photos.library.v1.internal.stub.PhotosLibraryStubSettings and com.google.photos.library.v1.PhotosLibrarySettings.

Here's an example that shows how to customize the retry configuration for the getAlbum(..) call and for uploading media bytes:

// Create a new retry configuration.
RetrySettings retrySettings=RetrySettings.newBuilder()
        .setInitialRetryDelay(Duration.ofSeconds(4))
        .setRetryDelayMultiplier(1.5)
        .setMaxAttempts(7)
        .setMaxRetryDelay(Duration.ofSeconds(60))
        .setTotalTimeout(Duration.ofMinutes(15))
        .build();

// Set the status codes returned from the API that should be retried.
 Set<StatusCode.Code>retryableCodes=
        Set.of(StatusCode.Code.DEADLINE_EXCEEDED,StatusCode.Code.UNAVAILABLE);

 PhotosLibrarySettings.Builder librarySettingsBuilder=
        PhotosLibrarySettings.newBuilder();

// Configure these retry settings for the "getAlbums" call.
librarySettingsBuilder.getAlbumSettings()
        .setRetrySettings(retrySettings)
        .setRetryableCodes(retryableCodes);

// Configure these retry settings for the upload media call.
librarySettingsBuilder.updateMediaItemSettings()
        .setRetrySettings(retrySettings)
        .setRetryableCodes(retryableCodes);

// Configure other client options, for example authentication credentials.

// Create the client.
PhotosLibraryClient client = PhotosLibraryClient.initialize(librarySettingsBuilder.build());

Samples

A few examples are included in the sample directory. They show how to access media items, filter media, share albums and upload files.

The API developer documentation also includes code snippets for this client library in Java.

Reference documentation

Javadoc for this library can be found in the gh-pages branch of this repository. You can browse it at https://google.github.io/java-photoslibrary/index.html

General Google Photos Library API documentation can be found on our Google Developers site: https://developers.google.com/photos

Getting support

For client library specific bug reports, feature requests, and patches, create an issue on the issue tracker.

See the support page for any other API questions, bug reports, or feature requests.

Announcements and updates

For general Google Photos Library API and client library updates and news, follow:

• Java client library release notes
• Google Photos Library API release notes

License

Copyright 2018 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.