Xcode プロジェクトを設定する

課金を有効にして API キーを作成したら、アプリの開発に使用する Xcode プロジェクトをセットアップできます。

各リリースのリリースノートをご覧ください。

ステップ 1: 必要なソフトウェアをインストールする

Maps SDK for iOS を使用してプロジェクトをビルドするには、以下をダウンロードしてインストールする必要があります。

  • Xcode バージョン 15.0 以降

ステップ 2: Xcode プロジェクトを作成し、Maps SDK for iOS をインストールする

Swift Package Manager

Maps SDK for iOS は Swift Package Manager からインストールできます。SDK を追加するには、既存の Maps SDK for iOS の依存関係をすべて削除してください。

SDK を新規または既存のプロジェクトに追加する手順は次のとおりです。

  1. Xcode project または workspace を開き、[File] > [Add Package Dependencies] に移動します。
  2. URL として https://github.com/googlemaps/ios-maps-sdk を入力し、Enter キーを押してパッケージを取得し、[パッケージを追加] をクリックします。
  3. 特定の version をインストールするには、[依存関係ルール] フィールドをバージョンベースのオプションのいずれかに設定します。新しいプロジェクトの場合は、最新バージョンを指定し、[Exact Version] オプションを使用することをおすすめします。完了したら、[パッケージを追加] をクリックします。

既存のプロジェクトの package を更新する手順は次のとおりです。

  1. 9.0.0 より前のバージョンからアップグレードする場合は、アップグレード後に GoogleMapsBase、GoogleMapsCore、GoogleMapsM4B の依存関係を削除する必要があります。GoogleMaps の依存関係は削除しないでください。詳細については、バージョン 9.0.0 リリースノートをご覧ください。

    Xcode プロジェクトの構成設定で、[フレームワーク、ライブラリ、埋め込みコンテンツ] を見つけます。マイナス記号（-）を使用して、次のフレームワークを削除します。

    • GoogleMapsBase（9.0.0 より前のバージョンからのアップグレードの場合のみ）
    • GoogleMapsCore（9.0.0 より前のバージョンからのアップグレードの場合のみ）
    • GoogleMapsM4B（9.0.0 より前のバージョンからのアップグレードの場合のみ）
  2. Xcode で、[File] > [Packages] > [Update To Latest Package Versions] に移動します。
  3. インストールを確認するには、Project Navigator の [Package Dependencies] セクションに移動して、パッケージとそのバージョンを確認します。

CocoaPods を使用して追加された既存の Maps SDK for iOS の依存関係を削除する手順は次のとおりです。

  1. Xcode ワークスペースを閉じます。ターミナルを開き、次のコマンドを実行します。
    sudo gem install cocoapods-deintegrate cocoapods-clean 
pod deintegrate 
pod cache clean --all
  2. CocoaPods 以外で使用していない場合は、Podfile、Podfile.resolved、Xcode の workspace を削除します。

手動でインストールされた既存の Maps SDK for iOS を削除する手順は次のとおりです。
  1. Xcode プロジェクトの構成設定で、[フレームワーク、ライブラリ、埋め込みコンテンツ] を見つけます。マイナス記号（-）を使用して、次のフレームワークを削除します。
    • GoogleMaps
    • GoogleMapsBase（バージョン 9.2.0 より前のインストールの場合のみ）
    • GoogleMapsCore（バージョン 9.2.0 より前のインストールの場合のみ）
    • GoogleMapsM4B（バージョン 9.0.0 より前のインストールの場合のみ）
  2. Xcode プロジェクトの最上位ディレクトリから、GoogleMaps バンドルを削除します。

手動インストール

このガイドでは、Maps SDK for iOS を含む XCFramework をプロジェクトに手動で追加し、Xcode でビルド設定を構成する方法を説明します。XCFramework は、Apple シリコンを使用するマシンなど、複数のプラットフォームで使用できるバイナリ パッケージです。

  1. 次の SDK バイナリとリソース ファイルをダウンロードします。
  2. ファイルを抽出して XCFrameworks とリソースにアクセスします。
  3. Xcode プロジェクトをまだ作成していない場合は、ここで作成してローカルマシンに保存します。iOS 開発を初めて行う場合:
    1. 新しいプロジェクトを作成する。
    2. [iOS > アプリ] テンプレートを選択します。
    3. プロジェクト オプション画面で次のように操作します。
      1. プロジェクト名を入力します。
      2. [Bundle identifier] フィールドの値を記録します。この値を使用して、以下の API キーを制限できます。
      3. プロジェクトの [インターフェース] を [ストーリーボード] に設定します。
      4. [Language] を [Swift] または [Objective-C] に設定します。
  4. [全般] タブを開きます。次の XCFramework をプロジェクトの [フレームワーク、ライブラリ、埋め込みコンテンツ] にドラッグします。[埋め込まない] を選択します。
    • GoogleMaps.xcframework
  5. ダウンロードした GoogleMapsResources から GoogleMaps.bundle を Xcode プロジェクトの最上位ディレクトリにコピーします。プロンプトが表示されたら、[Copy items into destination group's folder] を選択してください。
  6. プロジェクト ナビゲータで目的のプロジェクトを選択し、アプリのターゲットを選択します。
  7. アプリケーションのターゲットの [Build Phases] タブを開きます。 [Link Binary with Libraries] 内に、次のフレームワークとライブラリを追加します。
    • Accelerate.framework
    • Contacts.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（OpenGL を使用している場合のみ）
    • QuartzCore.framework
    • Security.framework
    • SystemConfiguration.framework
    • UIKit.framework

  8. （特定のターゲットではなく）プロジェクトを選択して、[Build Settings] タブを開きます。[Linking - General -> Other Linker Flags] セクションで、[Debug] と [Release] に -ObjC を追加します。これらの設定が表示されない場合は、[Build Settings] バーのフィルタを [Basic] から [All] に変更します。

  9. Places SDK for iOS XCFramework をインストールする方法については、Places SDK for iOS スタートガイドをご覧ください。

CocoaPods

Maps SDK for iOS は CocoaPods ポッドとして提供されています。CocoaPods は、Swift と Objective-C の Cocoa プロジェクトで依存関係を管理するためのオープンソース ツールです。

CocoaPods ツールがない場合は、ターミナルから以下のコマンドを実行して、macOS 上に CocoaPods ツールをインストールします。詳しくは、CocoaPods スタートガイドをご覧ください。

sudo gem install cocoapods

Maps SDK for iOS の Podfile を作成し、これを使用して API とその依存関係をインストールします。

  1. Xcode プロジェクトをまだ作成していない場合は、ここで作成してローカルマシンに保存します。iOS 開発を初めて行う場合:
    1. 新しいプロジェクトを作成する。
    2. [iOS > アプリ] テンプレートを選択します。
    3. プロジェクト オプション画面で次のように操作します。
      1. プロジェクト名を入力します。
      2. [Bundle identifier] フィールドの値を記録します。この値を使用して、以下の API キーを制限できます。
      3. プロジェクトの [インターフェース] を [ストーリーボード] に設定します。
      4. [Language] を [Swift] または [Objective-C] に設定します。
  2. プロジェクトのディレクトリに、Podfile という名前のファイルを作成します。このファイルでプロジェクトの依存関係を定義します。
  3. Podfile を編集して、依存関係とそのバージョンを追加します。次の例では、Maps SDK for iOS に必要な依存関係を追加しています。
    source 'https://github.com/CocoaPods/Specs.git'

platform :ios, '16.0'

target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
  pod 'GoogleMaps', '10.0.0'
end
     pod outdated を定期的に実行して、新しいバージョンがあるかどうかを検出し、常に最新の状態に保つようにしてください。必要に応じて、最新バージョンにアップグレードします。
  4. Podfile を保存します。

  5. ターミナルを開き、Podfile を含むディレクトリに移動します。

    cd <path-to-project>

  6. pod install コマンドを実行します。Podfile で指定した API とその依存関係がインストールされます。

    pod install

  7. Xcode を終了し、プロジェクトの .xcworkspace ファイルを（ダブルクリックして）開いて、Xcode を起動します。これ以降、このプロジェクトを開くには .xcworkspace ファイルを使用する必要があります。

既存のプロジェクトの API を更新する手順は次のとおりです。

  1. ターミナルを開き、Podfile を含むプロジェクト ディレクトリに移動します。
  2. pod update コマンドを実行します。これにより、Podfile で指定されたすべての API が最新バージョンに更新されます。

ステップ 3: API キーをプロジェクトに追加する

API キーを取得するで、アプリの API キーを生成しました。このキーを Xcode プロジェクトに追加します。

以下の例で YOUR_API_KEY とある箇所は、実際の API キーに置き替えてください。

Swift

次のように、API キーを AppDelegate.swift に追加します。

  1. 以下のインポート文を追加します。
    import GoogleMaps
  2. API キーを使用して、次のコードを application(_:didFinishLaunchingWithOptions:) メソッドに追加します。
    GMSServices.provideAPIKey("YOUR_API_KEY")
  3. Places API も使用している場合は、次のようにキーを再度追加します。
    GMSPlacesClient.provideAPIKey("YOUR_API_KEY")

Objective-C

次のように、API キーを AppDelegate.m に追加します。

  1. 以下のインポート文を追加します。
    @import GoogleMaps;
  2. API キーを使用して、次のコードを application:didFinishLaunchingWithOptions: メソッドに追加します。
    [GMSServices provideAPIKey:@"YOUR_API_KEY"];
  3. Places API も使用している場合は、次のようにキーを再度追加します。
    [GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];

ステップ 4（省略可）: Apple プライバシー マニフェスト ファイルを検査する

Apple は、App Store のアプリにアプリのプライバシーに関する詳細情報を表示することを義務付けています。最新情報と詳細については、Apple App Store のプライバシーに関する詳細情報のページをご覧ください。

Apple プライバシー マニフェスト ファイルは、SDK のリソース バンドルに含まれています。プライバシー マニフェスト ファイルが含まれていることを確認して、その内容を検査するには、アプリのアーカイブを作成し、アーカイブからプライバシー レポートを生成します。

ステップ 5（省略可）: API で使用する URL スキームを宣言する

iOS 9 と Xcode 7 以降では、アプリの Info.plist ファイルでスキームを指定することによって、開く URL スキームをアプリで宣言できます。Maps SDK for iOS では、ユーザーが地図上の Google ロゴをクリックすると Google マップ モバイルアプリが開きます。そのため、アプリで関連する URL スキームを宣言できます。

Maps SDK for iOS で使用される URL スキームを宣言するには、Info.plist に次の行を追加します。

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

次のスクリーンショットは、Xcode でのユーザー インターフェースでの設定を示しています。

Xcode の「LSApplicationQueriesSchemes」構成

上記の宣言がないと、ユーザーが地図上の 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 には、開発を始めるのに役立つチュートリアルやサンプルアプリが豊富に用意されています。詳しくは、以下をご覧ください。