Premiers pas avec la bibliothèque cliente Java

Pour commencer à utiliser les API Google Photos avec la bibliothèque cliente Java, vous devez configurer la bibliothèque cliente dans votre environnement de développement. Avant cela, configurez votre projet en activant l'API. via la console Google APIs et configurer un ID client OAuth 2.0.

Votre application interagit avec Google Photos pour le compte d'un Utilisateur Google Photos. Par exemple, lorsque vous créez des albums dans la bibliothèque Google Photos d'un utilisateur ou importez des éléments multimédias dans son compte Google Photos, l'utilisateur autorise ces requêtes d'API via le protocole OAuth 2.0.

L'ID client OAuth 2.0 permet aux utilisateurs de votre application de se connecter, de s'authentifier et donc d'utiliser les API Photos. L'API Photos n'est pas compatible avec des comptes de service ; Pour utiliser cette API, les utilisateurs doivent être connectés à un compte Google Compte.

Configurer votre application

Activer l'API

Avant de pouvoir utiliser les API Photos, vous devez les activer pour votre projet.

  1. Accédez à la console Google APIs.
  2. Dans la barre de menu, sélectionnez un projet ou créez-en un.
  3. Pour ouvrir la bibliothèque d'API Google, dans le menu de navigation, sélectionnez API et Services > bibliothèque.
  4. Recherchez "Google Photos APIs" (API Google Photos). Sélectionnez le résultat correct, puis cliquez sur Activer.

Demander un ID client OAuth 2.0

Suivez les étapes ci-dessous pour demander un ID client OAuth et le configurer pour votre application. Cet exemple utilise une application où l'intégralité du flux OAuth est géré côté serveur, comme celui de nos exemples. Le processus de configuration peut varier pour découvrir d'autres scénarios de mise en œuvre.

  1. Accédez à la console Google APIs, puis sélectionnez votre projet.
  2. Dans le menu, sélectionnez API et Services > Identifiants
  3. Sur la page Identifiants, cliquez sur Créer des identifiants > ID client OAuth.
  4. Sélectionnez le type d'application. Dans cet exemple, le type d'application est Application Web :
  5. Enregistrez les origines à partir desquelles votre application est autorisée à accéder aux API Google comme suit :

    1. Pour identifier l'ID client, saisissez un nom.
    2. Dans le champ Origines JavaScript autorisées, saisissez l'origine de votre application. Ce champ n'accepte pas les caractères génériques.

      Vous pouvez saisir plusieurs origines pour permettre à votre application de s'exécuter sur différents protocoles, domaines ou sous-domaines. Les URL que vous saisissez sont autorisées à pour lancer une requête OAuth.

      L'exemple suivant présente une URL de développement local (nos exemples utilisent localhost:8080) et une URL de production.

      http://localhost:8080
      https://myproductionurl.example.com
      
    3. Le champ URI de redirection autorisé est le point de terminaison qui reçoit les réponses du serveur OAuth 2.0. Il s'agit généralement environnement de développement et pointe vers un chemin d'accès dans votre application.

      http://localhost:8080/auth/google/callback
      https://myproductionurl.example.com/auth/google/callback
      
    4. Cliquez sur Créer.

  1. Dans la boîte de dialogue du client OAuth qui s'affiche, téléchargez le fichier JSON contenant la configuration de votre client. Les informations sur vos clients suivantes:

    • ID client
    • Code secret du client

    Ce fichier JSON sera utilisé ultérieurement pour configurer la bibliothèque Google Auth pour Java, qui fonctionne avec cette bibliothèque cliente.

Avant de pouvoir lancer une application publique qui accède aux API Photos, votre application doit être examinée par Google. Un message "Application non validée" s'affiche à l'écran lorsque vous testez votre application, jusqu'à ce qu'elle soit validée.

Configurez la bibliothèque cliente

La bibliothèque cliente Java gère automatiquement tous les appels à l'API backend et expose compatibles, y compris des exemples de code pour certaines tâches courantes de l'API. Tout d'abord, téléchargez et installez la bibliothèque cliente des API Google Photos pour Java, ainsi que les dépendances sur GitHub. Ensuite, configurez vos identifiants OAuth2 pour Java.

Options de téléchargement

Voici quelques options pour télécharger la bibliothèque cliente:

  • Dépendance Gradle:

    Pour utiliser cette bibliothèque avec Gradle, ajoutez la dépendance suivante à votre build.gradle.

    repositories {
      mavenCentral()
    }
    dependencies {
      compile 'com.google.photos.library:google-photos-library-client:1.7.3'
    }
    
  • Dépendance Maven :

    Pour utiliser cette bibliothèque avec Maven, ajoutez ce qui suit à votre fichier Maven pom.xml .

    <dependency>
      <groupId>com.google.photos.library</groupId>
      <artifactId>google-photos-library-client</artifactId>
      <version>1.7.3</version>
    </dependency>
    
  • Télécharger une version:

    La page des versions contient différents artefacts pour chaque version de la bibliothèque, y compris les fichiers JAR.

  • Clonez le dépôt:

    Utilisez cette méthode si vous souhaitez modifier cette bibliothèque ou y contribuer, par comme l'envoi de demandes d'extraction, ou si vous souhaitez essayer nos exemples. Lorsque vous cloner le dépôt, tous les fichiers de ce dépôt seront téléchargés.

    1. Exécutez git clone https://github.com/google/java-photoslibrary.git dans l'invite de commande.
    2. Vous obtiendrez un répertoire java-photoslibrary. Accédez-y en exécutant cd java-photoslibrary.
    3. Ouvrez le fichier build.gradle dans votre IDE ou exécutez ./gradlew assemble à l'invite de commande pour compiler le projet. Consultez ./gradlew tasks pour afficher les tâches disponibles.

Configurer vos identifiants OAuth2 pour Java

Cette bibliothèque cliente fonctionne avec la bibliothèque Google Auth pour Java. Pour en savoir plus, consultez Utiliser OAuth 2.0 avec la bibliothèque cliente des API Google pour Java.

Spécifiez la configuration OAuth de votre client dans le fichier CredentialsProvider lorsque en créant le PhotoLibrarySettings pour un objet PhotosLibraryClient.

Essayer des exemples

Essayez le code ci-dessous pour effectuer votre premier appel d'API à l'aide de la bibliothèque cliente Java.

// 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
}

D'autres exemples sont disponibles sur GitHub.