Set up an Xcode project

Swift Package Manager

The Places SDK for iOS can be installed via Swift Package Manager. To add the SDK, ensure you have removed any existing Places SDK for iOS dependencies.

To add the SDK to a new or existing project, follow these steps:

1. Open your Xcode project or workspace, then go to File > Add Package Dependencies.
2. Enter https://github.com/googlemaps/ios-places-sdk as the URL, press Enter to pull in the package, and click "Add Package".
3. To install a specific version, set the Dependency Rule field to one of the version-based options. For new projects, we recommend specifying the latest version and using the "Exact Version" option. Once complete, click "Add Package".
4. From the Choose Package Products window, verify that GooglePlaces, GooglePlacesSwift, or both, will be added to your designated main target. Once complete, click Add Package.

   If you are updating Google Places Swift from the deprecated GitHub URL

   Important: The GitHub URL to access Google Places Swift has changed starting with version 0.3.0. If you are updating a version of GooglePlacesSwift that was accessed through the old URL, https://github.com/googlemaps/ios-places-swift-sdk, remove it from your Xcode's package dependencies section.

5. To verify your installation, navigate to your target's General pane. In Frameworks, Libraries, and Embedded Content, you should see the installed packages. You can also view the Package Dependencies section of Project Navigator to verify the package and its version.

To update the package for an existing project, follow these steps:

1. From Xcode, go to "File > Packages > Update To Latest Package Versions".

   If you are updating Google Places Swift from the deprecated GitHub URL

   Important: The GitHub URL to access Google Places Swift has changed starting with version 0.3.0. If you are updating a version of GooglePlacesSwift that was accessed through the old URL, https://github.com/googlemaps/ios-places-swift-sdk, remove it from your Xcode's package dependencies section.

2. To verify your installation, go to the Package Dependencies section of Project Navigator to verify the package and its version.

To remove existing Places SDK for iOS installed manually, follow these steps:

1. From your Xcode project configuration settings, find Frameworks, Libraries, and Embedded Content. Use the minus sign(-) to remove the following frameworks:
   • GooglePlaces.xcframework
   • GooglePlacesSwift.xcframework
2. From the top level directory of your Xcode project, remove the GooglePlaces bundle.

Manual installation

This guide shows how to manually add the XCFrameworks containing the Places SDK for iOS and Places Swift SDK for iOS to your project and configure your build settings in Xcode. An XCFramework is a binary package that you can >use on multiple platforms, including machines using Apple silicon. You can choose to add Places SDK for iOS, Places Swift SDK for iOS, or both.

1. Download the following SDK binary and resource files:
   • GooglePlaces
   • GooglePlacesResources
2. If you are installing Places Swift SDK for iOS, install the following files:
   • GooglePlacesSwift
   • GooglePlacesSwiftResources
3. Extract the files to access the XCFramework and resources.
4. Launch Xcode and either open an existing project, or create a new project. If you're newer to iOS development, create a new project and select the iOS App template.
5. Remove any Maps bundles from previous releases from your project.
6. Open the General tab. Drag the following XCFramework into your project under Frameworks, Libraries, and Embedded Content. Make sure to select Do Not Embed:
   • GooglePlaces.xcframework
   If you are installing Places Swift SDK, drag the following XCFramework into your project under Frameworks, Libraries, and Embedded Content. Make sure to select Do Not Embed:
   • GooglePlacesSwift.xcframework
7. Copy the GooglePlaces.bundle from the GooglePlacesResources you downloaded into your Xcode project's top level directory. Make sure to select Copy items into destination group's folder when prompted.
   
   If you are installing Places Swift SDK, copy the GooglePlacesSwift.bundle from the GooglePlacesSwiftResources you downloaded into your Xcode project's top level directory. Make sure to select Copy items into destination group's folder when prompted.
8. Select your project from the Project Navigator, and choose your application's target.
9. Open the Build Phases tab. Within Link Binary with Libraries, add the following frameworks and libraries:
   • CoreGraphics.framework
   • CoreLocation.framework
   • libc++.tbd
   • libz.tbd
   • QuartzCore.framework
   • UIKit.framework

10. Choose your project, rather than a specific target, and open the Build Settings tab. In the Linking - General -> Other Linker Flags section, add -ObjC to "Debug" and "Release". If these settings aren't visible, change the filter in the Build Settings bar from Basic to All.

CocoaPods

The Places SDK for iOS and Places Swift SDK for iOS are available as CocoaPod pods, GooglePlaces and GooglePlacesSwift.

CocoaPods is an open source dependency manager for Swift and Objective-C Cocoa projects. If you don't already have the CocoaPods tool, install it on macOS by running the following command from the terminal. For details, see the CocoaPods Getting Started guide.

sudo gem install cocoapods

Create a Podfile to install the SDKs and their dependencies:

1. If you don't have an Xcode project yet, create one now and save it to your local machine. If you're newer to iOS development, create a new project and select the iOS App template.
2. Create a file named Podfile in your project directory. This file defines your project's dependencies.
3. Edit the Podfile and add your dependencies along with their versions. Here is an example that specifies your application target name, and the names of the GooglePlaces and GooglePlacesSwift pods:

   source 'https://github.com/CocoaPods/Specs.git'
   
   platform :ios, '16.0'
   
   target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
     pod 'GooglePlaces', '10.4.0'
     pod 'GooglePlacesSwift', '10.4.0'
   end

   Make sure to regularly run pod outdated to detect when there is a newer version to ensure you're always on the latest.
4. Save the Podfile.

5. Open a terminal and go to the directory containing the Podfile:

   cd <path-to-project>

6. Run the pod install command. This will install the APIs specified in the Podfile, along with any dependencies they may have.

   pod install

7. Close Xcode, and then open (double-click) your project's .xcworkspace file to launch Xcode. From this time onwards, you must use the .xcworkspace file to open the project.

To update the API for an existing project, follow these steps:

1. Open a terminal and go to the project directory containing the Podfile.
2. Run the pod update command. This will update all of the APIs specified in the Podfile to the latest version.

GooglePlacesSwift

Add your API key to your AppDelegate.swift as follows:

• Add the following import statement:

  import GooglePlacesSwift

• Add the following to your application(_:didFinishLaunchingWithOptions:) method, replacing YOUR_API_KEY with your API key:

  PlacesClient.provideAPIKey("YOUR_API_KEY")

Swift

Add your API key to your AppDelegate.swift as follows:

• Add the following import statement:

  import GooglePlaces

• Add the following to your application(_:didFinishLaunchingWithOptions:) method, replacing YOUR_API_KEY with your API key:

  GMSPlacesClient.provideAPIKey("YOUR_API_KEY")

Objective-C

Add your API key to your AppDelegate.m as follows:

• Add the following import statement:

  @import GooglePlaces;

• Add the following to your application:didFinishLaunchingWithOptions: method, replacing YOUR_API_KEY with your API key:

  [GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];