在启用结算功能并创建 API 密钥后,设置用于开发应用的 Xcode 项目。
每个版本都有版本说明。
第 1 步:安装所需的软件
如需使用 Maps SDK for iOS 构建项目,请下载并安装:
- Xcode 26.0 版或更高版本
第 2 步:创建 Xcode 项目并安装 Maps SDK for iOS
SDK 安装大小会有所不同。例如,Maps SDK for iOS 9.0 版的安装大小约为 18 MB。
Swift Package Manager
Maps SDK for iOS 可通过 Swift Package Manager 安装。如需添加该 SDK,请确保您已移除所有现有的 Maps SDK for iOS 依赖项。
如需将 SDK 添加到新项目或现有项目中,请按照以下步骤操作:
-
打开 Xcode
project或workspace,然后前往 File(文件)> Add Package Dependencies(添加软件包依赖项)。 - 输入 https://github.com/googlemaps/ios-maps-sdk 作为网址,按 Enter 键拉取软件包,然后点击“Add Package”(添加软件包)。
-
如需安装特定
version,请将依赖项规则字段设置为基于版本的选项之一。对于新项目,我们建议指定最新版本并使用“Exact Version”(确切版本)选项。完成后,点击“添加软件包”。 -
在 Choose Package Products(选择软件包产品)窗口中,验证
GoogleMaps(对于 9.0.0 之前的版本,验证GoogleMaps、GoogleMapsBase和GoogleMapsCore)是否会添加到您指定的main目标。完成后,点击“添加软件包”。 - 如需验证安装,请前往目标的 General(常规)窗格。 在 Frameworks, Libraries, and Embedded Content(框架、库和嵌入式内容)中,您应该会看到已安装的软件包。 您还可以查看“Project Navigator”(项目导航器)的“Package Dependencies”(软件包依赖项)部分,以验证软件包及其版本。
如需更新现有项目的 package,请按以下步骤操作:
如果您要从 9.0.0 之前的版本升级,则必须在升级后移除以下依赖项:
GoogleMapsBase、GoogleMapsCore和GoogleMapsM4B。请勿移除GoogleMaps的依赖项。如需了解详情,请参阅版本 9.0.0 版本说明。在 Xcode 项目配置设置中,找到 Frameworks, Libraries, and Embedded Content(框架、库和嵌入式内容)。使用减号(-) 移除以下框架:
GoogleMapsBase(仅适用于从 9.0.0 之前的版本升级)GoogleMapsCore(仅适用于从 9.0.0 之前的版本升级)GoogleMapsM4B(仅适用于从 9.0.0 之前的版本升级)
- 在 Xcode 中,依次前往 File(文件)> Packages(软件包)> Update To Latest Package Versions(更新到最新软件包版本)。
- 如需验证安装,请前往项目导航器的软件包依赖项部分,验证软件包及其版本。
如需移除使用 CocoaPods 添加的现有 Maps SDK for iOS 依赖项,请按以下步骤操作:
- 关闭 Xcode 工作区。打开终端并执行以下命令:
sudo gem install cocoapods-deintegrate cocoapods-clean pod deintegrate pod cache clean --all
-
如果您不将
Podfile、Podfile.resolved和 Xcodeworkspace用于 CocoaPods 以外的其他用途,请将其移除。
-
在 Xcode 项目配置设置中,找到 Frameworks, Libraries, and Embedded Content(框架、库和嵌入式内容)。使用减号 (-) 移除以下框架:
GoogleMapsGoogleMapsBase(仅适用于 9.2.0 之前的安装版本)GoogleMapsCore(仅适用于 9.2.0 之前的安装版本)GoogleMapsM4B(仅适用于 9.0.0 之前的安装版本)
-
从 Xcode 项目的顶层目录中移除
GoogleMaps软件包。
手动安装
本指南介绍了如何手动将包含 Maps SDK for iOS 的 XCFrameworks 添加到您的项目,以及如何在 Xcode 中配置 build 设置。XCFramework 是一种二进制软件包,可在多个平台上使用,包括使用 Apple 芯片的机器。
- 下载以下 SDK 二进制文件和资源文件:
- 解压缩文件以访问 XCFrameworks 和资源。
- 如果您还没有 Xcode 项目,请立即创建一个并将其保存到本地机器。如果您刚开始接触 iOS 开发:
- 创建新项目。
- 选择 iOS > App 模板。
- 在项目选项界面上:
- 输入项目名称。
- 记录软件包标识符字段的值。 您可以使用该值在下方限制您的 API 密钥。
- 将项目界面设置为分镜脚本。
- 将 Language(语言)设置为 Swift 或 Objective-C。
-
打开常规标签页。将以下 XCFramework 拖放到项目中的 Frameworks, Libraries, and Embedded Content(框架、库和嵌入式内容)下。请务必选择不嵌入:
GoogleMaps.xcframework
-
将
GoogleMaps.bundle从您下载的 GoogleMapsResources 复制到 Xcode 项目的顶级目录中。请务必在系统提示时选择将内容复制到目标群组的文件夹中。 - 从项目导航器中选择您的项目,然后选择应用的目标。
-
打开应用目标的 Build Phases 标签页。
在 Link Binary with Libraries(将二进制文件与库关联)中,添加以下框架和库:
Accelerate.frameworkContacts.frameworkCoreData.frameworkCoreGraphics.frameworkCoreImage.frameworkCoreLocation.frameworkCoreTelephony.frameworkCoreText.frameworkGLKit.frameworkImageIO.frameworklibc++.tbdlibz.tbdMetal.frameworkMetricKit.frameworkOpenGLES.framework(仅当您使用 OpenGL 时)QuartzCore.frameworkSecurity.frameworkSystemConfiguration.frameworkUIKit.framework
-
选择您的项目(而非特定目标),然后打开 Build Settings 标签页。在 Linking - General -> Other Linker Flags(链接 - 常规 -> 其他链接器标志)部分中,将
-ObjC添加到“Debug”(调试)和“Release”(发布)。如果这些设置不可见,请将构建设置栏中的过滤条件从基本更改为全部。 -
如需安装 Places SDK for iOS XCFramework,请参阅 Places SDK for iOS 使用入门。
第 3 步:将您的 API 密钥添加到项目中
在获取 API 密钥中,您为应用生成了 API 密钥。现在,请将该密钥添加到您的 Xcode 项目中。
在下例中,请将 YOUR_API_KEY 替换为您的 API 密钥。
Swift
按照以下方法向 AppDelegate.swift 添加 API 密钥:
- 添加以下 import 语句:
import GoogleMaps
- 使用您的 API 密钥将以下内容添加到
application(_:didFinishLaunchingWithOptions:)方法中:GMSServices.provideAPIKey("YOUR_API_KEY")
- 如果您也使用 Places API,请按照下面的内容再次添加密钥:
GMSPlacesClient.provideAPIKey("YOUR_API_KEY")
Objective-C
按照以下方法向 AppDelegate.m 添加 API 密钥:
- 添加以下 import 语句:
@import GoogleMaps;
- 使用您的 API 密钥将以下内容添加到
application:didFinishLaunchingWithOptions:方法中:[GMSServices provideAPIKey:@"YOUR_API_KEY"];
- 如果您也使用 Places API,请按照下面的内容再次添加密钥:
[GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];
第 4 步(可选):检查 Apple 隐私清单文件
Apple 要求在 App Store 上发布的应用提供应用隐私详细信息。如需了解最新动态和更多信息,请访问 Apple App Store 隐私权详细信息页面。
Apple 隐私清单文件包含在 SDK 的资源包中。如需验证是否已添加隐私清单文件并检查其内容,请创建应用的归档,然后根据归档生成隐私报告。
第 5 步(可选):声明 API 使用的网址协议
从 iOS 9 和 Xcode 7 开始,应用通过在应用的 Info.plist 文件中指定网址协议来声明其打算打开的网址协议。当用户点击地图上的 Google 徽标时,Maps SDK for iOS 会打开 Google 地图移动应用,因此您的应用可以声明相关的网址协议。
如需声明 Maps SDK for iOS 使用的网址协议,请将以下代码行添加到 Info.plist:
<key>LSApplicationQueriesSchemes</key>
<array>
<string>googlechromes</string>
<string>comgooglemaps</string>
</array>
下图展示了 Xcode 界面中的配置:

如果没有上述声明,当用户点按地图上的 Google 徽标时,可能会发生以下错误:
-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"
如需消除这些错误,请将声明添加到 Info.plist。
后续步骤
现在,您已经有了 API 密钥和 Xcode 项目,接下来便可以创建和运行应用了。Navigation SDK for iOS 提供了许多可帮助您顺利上手的教程和示例应用。如需了解详情,请参阅以下文档: