Configurer un projet Xcode

Une fois que vous avez activé la facturation et créé une clé API, vous pouvez configurer le projet Xcode que vous utilisez pour développer votre application.

Des notes de version sont disponibles pour chaque version.

Étape 1 : Installez le logiciel requis

Pour créer un projet à l'aide du SDK Maps pour iOS, vous devez télécharger et installer:

  • Xcode version 14.0 ou ultérieure

  • CocoaPods

Étape 2: Créez le projet Xcode et installez le SDK Maps pour iOS

Utiliser CocoaPods

Le SDK Maps pour iOS est disponible en tant que pod CocoaPods. CocoaPods est un gestionnaire de dépendances Open Source pour les projets Cocoa Swift et Objective-C.

Si vous ne possédez pas encore l'outil CocoaPods, installez-le sur macOS en exécutant la commande ci-dessous à partir du terminal. Pour plus de détails, consultez le guide de démarrage de CocoaPods.

sudo gem install cocoapods

Créez un Podfile pour le SDK Maps pour iOS, et utilisez-le pour installer l'API et ses dépendances :

  1. Si vous n'avez pas encore de projet Xcode, créez-en un et enregistrez-le sur votre ordinateur local. Si vous débutez dans le développement iOS :
    1. Créez un projet.
    2. Sélectionnez le modèle iOS > Application.
    3. Sur l'écran des options du projet :
      1. Saisissez le nom du projet.
      2. Notez la valeur du champ Identifiant de groupe. Vous pouvez utiliser cette valeur pour restreindre votre clé API ci-dessous.
      3. Définissez le champ Interface du projet sur Storyboard.
      4. Définissez le paramètre Langue sur Swift ou Goal-C.
  2. Créez un fichier nommé Podfile dans le répertoire de votre projet. Ce fichier définit les dépendances de votre projet.
  3. Modifiez Podfile et ajoutez vos dépendances avec leurs versions. Voici un exemple qui inclut la dépendance dont vous avez besoin pour le SDK Maps pour iOS : 
    source 'https://github.com/CocoaPods/Specs.git'

platform :ios, '14.0'

target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
  pod 'GoogleMaps', '8.2.0'
end
    Veillez à exécuter régulièrement pod outdated pour détecter s'il existe une version plus récente afin d'être toujours à jour. Si nécessaire, passez à la dernière version.
  4. Enregistrez le Podfile.

  5. Ouvrez un terminal et accédez au répertoire contenant Podfile:

    cd <path-to-project>

  6. Exécutez la commande pod install. Cela installera les API spécifiées dans le Podfile, ainsi que toutes les éventuelles dépendances.

    pod install

  7. Fermez Xcode, puis ouvrez (double-cliquez) le fichier .xcworkspace de votre projet pour lancer Xcode. À partir de ce moment, vous devez utiliser le fichier .xcworkspace pour ouvrir le projet.

Pour mettre à jour l'API pour un projet existant, procédez comme suit:

  1. Ouvrez un terminal et accédez au répertoire du projet contenant Podfile.
  2. Exécutez la commande pod update. Toutes les API spécifiées dans le Podfile seront mises à jour vers la dernière version.

Installer le XCFramework

Un XCFramework est un package binaire que vous pouvez utiliser sur plusieurs plates-formes, y compris les machines utilisant le chipset M1, afin d'installer le SDK Maps pour iOS. Ce guide explique comment ajouter le XCFramework contenant le SDK Maps pour iOS à votre projet et configurer vos paramètres de compilation dans Xcode.

Manuellement

Ce guide explique comment ajouter manuellement le SDK Maps pour iOS à votre projet et configurer vos paramètres de compilation dans Xcode.

  1. Téléchargez les fichiers sources du SDK : GoogleMaps-8.2.0.
  2. Décompressez les fichiers sources. Accédez au dossier Framework pour accéder à XCFramework.
  3. Si vous n'avez pas encore de projet Xcode, créez-en un et enregistrez-le sur votre ordinateur local. Si vous débutez dans le développement iOS :
    1. Créez un projet.
    2. Sélectionnez le modèle iOS > Application.
    3. Sur l'écran des options du projet :
      1. Saisissez le nom du projet.
      2. Notez la valeur du champ Identifiant de groupe. Vous pouvez utiliser cette valeur pour restreindre votre clé API ci-dessous.
      3. Définissez le champ Interface du projet sur Storyboard.
      4. Définissez le paramètre Langue sur Swift ou Goal-C.
  4. Faites glisser les XCFrameworks suivants dans votre projet sous Frameworks, bibliothèques et contenu intégré. Veillez à sélectionner Do Not Embed (Ne pas intégrer) pour chaque XCFramework :
    • GoogleMaps-x.x.x/GoogleMapsBase.xcframework
    • GoogleMaps-x.x.x/GoogleMaps.xcframework
    • GoogleMaps-x.x.x/GoogleMapsCore.xcframework
    • (Clients du forfait Premium uniquement) GoogleMaps-x.x.x/GoogleMapsM4B.xcframework
  5. Effectuez un clic droit sur GoogleMaps.xcframework dans votre projet, puis sélectionnez Show In Finder (Afficher dans le Finder).
  6. Faites glisser GoogleMaps.bundle du dossier ios-arm64_x86_64-simulator/GoogleMaps.framework/Resources vers le répertoire de premier niveau de votre projet Xcode. Lorsque vous y êtes invité, vérifiez que l'option Copy items if needed (Copier les éléments si nécessaire) n'est pas sélectionnée.
  7. Sélectionnez votre projet dans le navigateur de projets, puis choisissez la cible de votre application.
  8. Ouvrez l'onglet Build Phases (Phases de compilation) de la cible de votre application et, dans Link Binary with Libraries (Associer le binaire avec des bibliothèques), puis ajoutez les frameworks et bibliothèques suivants :
    • Accelerate.framework
    • CoreData.framework
    • CoreGraphics.framework
    • CoreImage.framework
    • CoreLocation.framework
    • CoreTelephony.framework
    • CoreText.framework
    • GLKit.framework
    • ImageIO.framework
    • libc++.tbd
    • libz.tbd
    • Metal.framework
    • OpenGLES.framework
    • QuartzCore.framework
    • SystemConfiguration.framework
    • UIKit.framework

  9. Choisissez votre projet plutôt qu'une cible spécifique et ouvrez l'onglet Build Settings (Paramètres de compilation). Dans la section Other Linker Flags (Autres indicateurs Linker), ajoutez -ObjC. Si ces paramètres ne sont pas visibles, modifiez le filtre de la barre Build Settings (Paramètres de compilation) en remplaçant Basic (De base) par All (Tous).

  10. Pour installer le SDK Places pour iOS XCFramework, consultez Premiers pas avec le SDK Places pour iOS.

À Carthage

Installer la balise manuellement

Ce guide explique comment ajouter manuellement le SDK Maps pour iOS à votre projet et configurer vos paramètres de compilation dans Xcode.

  1. Téléchargez les fichiers sources du SDK : GoogleMaps-8.2.0.
  2. Décompressez les fichiers sources.
  3. Si vous n'avez pas encore de projet Xcode, créez-en un et enregistrez-le sur votre ordinateur local. Si vous débutez dans le développement iOS :
    1. Créez un projet.
    2. Sélectionnez le modèle iOS > Application.
    3. Sur l'écran des options du projet :
      1. Saisissez le nom du projet.
      2. Notez la valeur du champ Identifiant de groupe. Vous pouvez utiliser cette valeur pour restreindre votre clé API ci-dessous.
      3. Définissez le champ Interface du projet sur Storyboard.
      4. Définissez le paramètre Langue sur Swift ou Goal-C.
  4. Faites glisser les groupes suivants dans votre projet: (Lorsque vous y êtes invité, sélectionnez Copy items if needed, Please use the same version as above (Copier les éléments si nécessaire, veuillez utiliser la même version que ci-dessus).)
    • GoogleMaps-x.x.x/Base/Frameworks/GoogleMapsBase.xcframework
    • GoogleMaps-x.x.x/Maps/Frameworks/GoogleMaps.xcframework
    • GoogleMaps-x.x.x/Maps/Frameworks/GoogleMapsCore.xcframework
    • (Clients du forfait Premium uniquement) GoogleMaps-x.x.x/M4B/Frameworks/GoogleMapsM4B.xcframework
  5. Effectuez un clic droit sur GoogleMaps.xcframework dans votre projet, puis sélectionnez Show In Finder (Afficher dans le Finder).
  6. Faites glisser GoogleMaps.bundle du dossier Resources vers le répertoire de premier niveau de votre projet Xcode. Lorsque vous y êtes invité, vérifiez que l'option Copy items into destination group's folder (Copier les éléments dans le dossier du groupe de destination) n'est pas sélectionnée.
  7. Sélectionnez votre projet dans Project Navigator, puis choisissez la cible de votre application.
  8. Ouvrez l'onglet Build Phases (Phases de compilation) de la cible de votre application et, dans Link Binary with Libraries (Associer le binaire avec des bibliothèques), ajoutez les frameworks et bibliothèques suivants :
    • Accelerate.framework
    • CoreData.framework
    • CoreGraphics.framework
    • CoreImage.framework
    • CoreLocation.framework
    • CoreTelephony.framework
    • CoreText.framework
    • GLKit.framework
    • ImageIO.framework
    • libc++.tbd
    • libz.tbd
    • Metal.framework
    • OpenGLES.framework
    • QuartzCore.framework
    • SystemConfiguration.framework
    • UIKit.framework

  9. Choisissez votre projet plutôt qu'une cible spécifique, et ouvrez l'onglet Build Settings (Paramètres de build). Dans la section Other Linker Flags (Autres indicateurs Linker), ajoutez -ObjC. Si ces paramètres ne sont pas visibles, modifiez le filtre dans la barre Build Settings (Paramètres de build) de Basic (De base) à All (Tous).

  10. Pour installer le SDK Places pour iOS, consultez Premiers pas avec le SDK Places pour iOS.

Étape 3 : Ajoutez votre clé API au projet

Dans Obtenir une clé API, vous avez généré une clé API pour votre application. Ajoutez maintenant cette clé à votre projet Xcode.

Dans les exemples suivants, remplacez YOUR_API_KEY par votre clé API.

Swift

Ajoutez votre clé API à votre fichier AppDelegate.swift comme suit :

  1. Ajoutez l'instruction d'importation suivante : 
    import GoogleMaps
  2. Ajoutez les éléments suivants à votre méthode application(_:didFinishLaunchingWithOptions:) à l'aide de votre clé API : 
    GMSServices.provideAPIKey("YOUR_API_KEY")
  3. Si vous utilisez également l'API Places, ajoutez à nouveau votre clé comme indiqué ci-dessous : 
    GMSPlacesClient.provideAPIKey("YOUR_API_KEY")

Objective-C

Ajoutez votre clé API à votre fichier AppDelegate.m comme suit :

  1. Ajoutez l'instruction d'importation suivante : 
    @import GoogleMaps;
  2. Ajoutez les éléments suivants à votre méthode application:didFinishLaunchingWithOptions: à l'aide de votre clé API : 
    [GMSServices provideAPIKey:@"YOUR_API_KEY"];
  3. Si vous utilisez également l'API Places, ajoutez à nouveau votre clé comme indiqué ci-dessous : 
    [GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];

Étape 4 (facultative): Activez le framework de rendu Metal

Le SDK Maps pour iOS vous permet d'activer le framework de rendu Metal d'Apple. Pour tester le moteur de rendu Metal dans votre application, appelez [GMSServices setMetalRendererEnabled:YES] dans Goal-C ou GMSServices.setMetalRendererEnabled(true) dans Swift avant de créer des vues de carte.

Si vous installez le SDK manuellement, vous devez également veiller à ajouter Metal.framework dans Xcode.

Étape 5 : Ajoutez une carte

Le code ci-dessous montre comment ajouter une carte simple à un ViewController existant:

  1. Ajoutez ou mettez à jour des méthodes dans le ViewController par défaut de votre application pour créer et initialiser une instance de GMSMapView.

    Swift

    /*
 * Copyright 2020 Google Inc. All rights reserved.
 *
 *
 * 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
 *
 *     http://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.
 */

import UIKit
import GoogleMaps

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.
        // Create a GMSCameraPosition that tells the map to display the
        // coordinate -33.86,151.20 at zoom level 6.
        let camera = GMSCameraPosition.camera(withLatitude: -33.86, longitude: 151.20, zoom: 6.0)
        let mapView = GMSMapView.map(withFrame: self.view.frame, camera: camera)
        self.view.addSubview(mapView)

        // Creates a marker in the center of the map.
        let marker = GMSMarker()
        marker.position = CLLocationCoordinate2D(latitude: -33.86, longitude: 151.20)
        marker.title = "Sydney"
        marker.snippet = "Australia"
        marker.map = mapView
  }
}

    Objective-C

    /*
* Copyright 2020 Google Inc. All rights reserved.
*
*
* 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
*
*     http://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.
*/

#import "ViewController.h"
#import <GoogleMaps/GoogleMaps.h>

@interface ViewController ()

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
  // Do any additional setup after loading the view.
  // Create a GMSCameraPosition that tells the map to display the
  // coordinate -33.86,151.20 at zoom level 6.
  GMSCameraPosition *camera = [GMSCameraPosition cameraWithLatitude:-33.86
                                                          longitude:151.20
                                                               zoom:6];
  GMSMapView *mapView = [GMSMapView mapWithFrame:self.view.frame camera:camera];
  mapView.myLocationEnabled = YES;
  [self.view addSubview:mapView];

  // Creates a marker in the center of the map.
  GMSMarker *marker = [[GMSMarker alloc] init];
  marker.position = CLLocationCoordinate2DMake(-33.86, 151.20);
  marker.title = @"Sydney";
  marker.snippet = @"Australia";
  marker.map = mapView;
}

@end

    ViewController.m

  2. Exécutez votre application. Vous devriez voir une carte avec un seul repère centré sur Sydney, en Australie. Si vous voyez le repère, mais que la carte n'est pas visible, vérifiez que vous avez fourni votre clé API.

Étape 6 (facultative): Déclarer les schémas d'URL utilisés par l'API

À partir d'iOS 9 et Xcode 7, les applications peuvent déclarer les schémas d'URL qu'elles ont l'intention d'ouvrir en les spécifiant dans le fichier Info.plist de l'application. Le SDK Maps pour iOS ouvre l'application mobile Google Maps lorsque l'utilisateur clique sur le logo Google sur la carte. Votre application peut donc déclarer les schémas d'URL pertinents.

Pour déclarer les schémas d'URL utilisés par le SDK Maps pour iOS, ajoutez les lignes suivantes à votre fichier Info.plist:

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>googlechromes</string>
    <string>comgooglemaps</string>
</array>

La capture d'écran ci-dessous montre la configuration dans l'interface utilisateur Xcode :

Configuration de LSApplicationQueriesSchemes dans Xcode

Sans la déclaration ci-dessus, les erreurs suivantes peuvent se produire lorsque l'utilisateur appuie sur le logo Google sur la carte:

-canOpenURL: failed for URL: "comgooglemaps://" - error: "This app is not allowed to query for scheme comgooglemaps"
-canOpenURL: failed for URL: "googlechromes://" - error: "This app is not allowed to query for scheme googlechromes"

Pour éliminer ces erreurs, ajoutez la déclaration à votre Info.plist comme décrit ci-dessus.

Étapes suivantes

Maintenant que vous disposez d'une clé API et d'un projet Xcode, vous pouvez créer et exécuter des applications. Le SDK Maps pour iOS fournit de nombreux tutoriels et applications exemples pour vous aider à démarrer. Pour en savoir plus, consultez les pages suivantes :