Accéder aux API Google dans une application iOS

Certains services Google, tels que Drive, Gmail et bien d'autres, fournissent des API publiques que vous pouvez utiliser pour créer des applications qui aident les utilisateurs à exploiter leurs données dans ces services. Pour accéder à ces services, les applications doivent implémenter l'un des flux clients OAuth 2.0 afin d'obtenir le consentement des utilisateurs et des jetons d'accès, qui permettent d'accéder aux API.

Vous pouvez utiliser la bibliothèque Google Sign-In, qui implémente le flux OAuth 2.0 pour vous, afin d'obtenir des jetons d'accès pour l'utilisateur connecté.

Prérequis

Avant que votre application iOS puisse appeler les API Google, procédez comme suit :

1. Activer les API pour votre projet.

Toute application qui appelle des API Google doit activer ces API dans la console Google Cloud.

Pour activer une API pour votre projet :

  1. Ouvrez la bibliothèque d'API dans la console Google Cloud.
  2. Si vous y êtes invité, sélectionnez un projet ou créez-en un.
  3. Sélectionnez l'API que vous souhaitez activer, puis cliquez sur Activer.

2. Créer des identifiants d'autorisation

Toute application iOS qui utilise OAuth 2.0 pour accéder aux API Google doit disposer d'identifiants d'autorisation qui l'identifient auprès du serveur d'autorisation Google. Les étapes suivantes expliquent comment créer des identifiants pour votre projet :

  1. Accédez à la page Identifiants de la console Google Cloud.
  2. Cliquez sur Créer un client (ou Créer des identifiants > ID client OAuth).
  3. Sélectionnez le type d'application iOS.
  4. Saisissez un nom pour le client OAuth. Ce nom identifie le client sur la page "Identifiants" de votre projet.
  5. Saisissez l'identifiant du bundle de votre application. L'ID du bundle correspond à la valeur de la clé CFBundleIdentifier dans le fichier Info.plist de votre application. La valeur est généralement affichée dans le volet "General" (Général) ou "Signing & Capabilities" (Signature et fonctionnalités) de l'éditeur de projet Xcode, ou sur la page "App Information" (Informations sur l'application) d'Apple App Store Connect. Vérifiez que vous utilisez l'ID du bundle approprié, car il ne peut pas être modifié si vous utilisez App Check.
  6. (Facultatif) Saisissez l'ID App Store de votre application si elle est publiée sur l'App Store d'Apple. L'ID de magasin est une chaîne numérique incluse dans chaque URL de l'App Store d'Apple.
  7. (Facultatif) Saisissez votre ID d'équipe. Consultez Trouver votre ID d'équipe dans la documentation du compte de développeur Apple. L'ID d'équipe est requis si vous activez App Check pour votre client.
  8. (Facultatif) Activez App Check pour votre application iOS. Lorsque vous activez App Check, le service App Attest d'Apple est utilisé pour vérifier que les requêtes OAuth 2.0 provenant de votre client OAuth sont authentiques et proviennent de votre application, ce qui permet de réduire le risque d'usurpation d'identité de l'application.
  9. Cliquez sur Créer.

Votre ID client est généré et s'affiche dans la console Google Cloud. Ajoutez le schéma d'URL de l'ID client inversé (par exemple, com.googleusercontent.apps.1234567890-abcdef) au fichier Info.plist de votre application pour gérer les redirections d'autorisation.

3. Effectuer une intégration Google Sign-In standard

Effectuez l'intégration de base de Google Sign-In avant de demander des champs d'application incrémentiels et d'appeler les API Google.

1. Vérifier les champs d'application accordés

Avant d'appeler une API Google, vérifiez les champs d'application qui ont déjà été accordés à votre application à l'aide de la propriété grantedScopes de GIDGoogleUser :

Swift

let driveScope = "https://www.googleapis.com/auth/drive.readonly"
let grantedScopes = user.grantedScopes
if grantedScopes == nil || !grantedScopes!.contains(driveScope) {
  // Request additional Drive scope.
}

Objective-C

NSString *driveScope = @"https://www.googleapis.com/auth/drive.readonly";

// Check if the user has granted the Drive scope
if (![user.grantedScopes containsObject:driveScope]) {
  // request additional drive scope
}

Selon qu'un champ d'application a été accordé ou non par l'utilisateur, vous devrez peut-être demander un champ d'application supplémentaire pour prendre en charge une interaction particulière.

2. Demander des champs d'application supplémentaires

Si vous devez demander des champs d'application supplémentaires, appelez addScopes:presentingViewController:completion ou addScopes:presentingWindow:completion pour demander à l'utilisateur d'accorder un accès supplémentaire à votre application.

Par exemple, pour demander un accès en lecture seule aux fichiers Drive d'un utilisateur :

Swift

let additionalScopes = ["https://www.googleapis.com/auth/drive.readonly"]
guard let currentUser = GIDSignIn.sharedInstance.currentUser else {
    return ;  /* Not signed in. */
}

currentUser.addScopes(additionalScopes, presenting: self) { signInResult, error in
    guard error == nil else { return }
    guard let signInResult = signInResult else { return }

    // Check if the user granted access to the scopes you requested.
}

Objective-C

NSArray *additionalScopes = @[ @"https://www.googleapis.com/auth/drive.readonly" ];
GIDGoogleUser *currentUser = GIDSignIn.sharedInstance.currentUser;

[currentUser addScopes:additionalScopes
           presentingViewController:self
                         completion:^(GIDSignInResult * _Nullable signInResult,
                                      NSError * _Nullable error) {
    if (error) { return; }
    if (signInResult == nil) { return; }

    // Check if the user granted access to the scopes you requested.
}];

3. Effectuer un appel d'API avec de nouveaux jetons

Pour vous assurer que vos appels d'API Google sont toujours associés à des jetons d'accès non arrivés à expiration, encapsulez les appels dans un bloc refreshTokensIfNeededWithCompletion: :

Swift

currentUser.refreshTokensIfNeeded { user, error in
    guard error == nil else { return }
    guard let user = user else { return }

    // Get the access token to attach it to a REST or gRPC request.
    let accessToken = user.accessToken.tokenString

    // Or, get an object that conforms to GTMFetcherAuthorizationProtocol for
    // use with GTMAppAuth and the Google APIs client library.
    let authorizer = user.fetcherAuthorizer()
}

Objective-C

[currentUser refreshTokensIfNeededWithCompletion:^(
                              GIDGoogleUser * _Nullable user,
                              NSError * _Nullable error) {
    if (error) { return; }
    if (user == nil) { return; }

    // Get the access token to attach it to a REST or gRPC request.
    NSString *accessToken = user.accessToken.tokenString;

    // Or, get an object that conforms to GTMFetcherAuthorizationProtocol for
    // use with GTMAppAuth and the Google APIs client library.
    id<GTMFetcherAuthorizationProtocol> authorizer = [user fetcherAuthorizer];
}];

Utilisez le jeton d'accès pour appeler l'API, soit en l'incluant dans l'en-tête d'une requête REST ou gRPC (Authorization: Bearer ACCESS_TOKEN), soit en utilisant l'outil d'autorisation de récupération avec la bibliothèque cliente des API Google.