Maps SDK for iOS sample code

Select platform: Android iOS JavaScript

The Maps SDK for iOS repository on GitHub contains samples illustrating the use of the Maps SDK for iOS in your iOS app. The sample app contains code for feature highlights of the SDK, and can be used starting point for your app.

Maps SDK for iOS samples list

Key sample activities from the demo app are listed below and reproduced at the linked pages for quick reference. See the GitHub samples folder for the full list of available samples.

Run the full sample app locally

The Maps SDK for iOS sample app is available as a download archive from GitHub. Follow these steps to install and try the Maps SDK for iOS sample app.

  1. Run git clone https://github.com/googlemaps-samples/maps-sdk-for-ios-samples.git to clone the samples repository into a local directory.
  2. Open a terminal window, navigate to the directory where you cloned the sample files, and drill down into the GoogleMaps directory:

    Swift

    cd maps-sdk-for-ios-samples-main/GoogleMaps-Swift
    pod install
    open GoogleMapsSwiftDemos.xcworkspace

    Objective-C

    cd maps-sdk-for-ios-samples-main/GoogleMaps
    pod install
    open GoogleMapsDemos.xcworkspace
  3. In Xcode, press the compile button to build the app with the current scheme. The build produces an error, prompting you to enter your API key in the SDKConstants.swift file for Swift orSDKDemoAPIKey.h file for Objective-C.
  4. If you don't yet have an API key, follow the instructions to set up a project on the Google Cloud Console and get an API key. When configuring the key on the Cloud Console, you can restrict the key to the sample app's bundle identifier to ensure that only your app can use the key. The default bundle identifier of the SDK samples app is com.example.GoogleMapsDemos.
  5. Edit the SDKConstants.swift file for Swift orSDKDemoAPIKey.h file for Objective-C and paste your API key into the definition of either the apiKey or kAPIKey constant. For example:

    Swift

    static let apiKey = "YOUR_API_KEY"

    Objective-C

    static NSString *const kAPIKey = @"YOUR_API_KEY";
  6. In the SDKConstants.swift file (Swift) orSDKDemoAPIKey.h file (Objective-C), remove the following line, because it's used to register the user-defined issue:

    Swift

    #error (Register for API Key and insert here. Then delete this line.)

    Objective-C

    #error Register for API Key and insert here.
  7. Build and run the project. The iOS simulator window appears, showing a list of Maps SDK Demos.
  8. Choose one of the options displayed, to experiment with a feature of the Maps SDK for iOS.
  9. If prompted to allow GoogleMapsDemos to access your location, choose Allow.