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

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

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

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

  • Xcode バージョン 13.0 以降
  • Cocoapods または Carthage

ステップ 2: XCode プロジェクトを作成し、Maps 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 > App] テンプレートを選択します。
    3. [プロジェクト オプション] 画面で、次の操作を行います。
      1. プロジェクト名を入力します。
      2. [バンドル ID] フィールドの値を記録します。この値を使用して、以下の API キーを制限できます。
      3. プロジェクトの [インターフェース] を [ストーリーボード] に設定します。
      4. [言語] を [Swift] または [Objective-C] に設定します。
  2. プロジェクトのディレクトリに、Podfile という名前のファイルを作成します。このファイルでプロジェクトの依存関係を定義します。
  3. Podfile を編集し、依存関係とバージョンを追加します。Maps SDK for iOS に必要な依存関係を含む例を次に示します。
    source 'https://github.com/CocoaPods/Specs.git'
    
    platform :ios, '13.0'
    
    target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
      pod 'GoogleMaps', '7.1.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 が最新バージョンに更新されます。

Carthage を使用する

Maps SDK for iOS は、Swift および Objective-C Cocoa プロジェクトのシンプルな分散依存関係マネージャーである Carthage で使用できます。

  1. Carthage をインストールします。方法はいくつかあります。正確な手順については、Carthage の README ファイルをご覧ください。
  2. Xcode プロジェクトをまだ作成していない場合は、ここで作成して、ローカルマシンに保存します。iOS 開発を初めて行う場合:
    1. 新しいプロジェクトを作成します。
    2. [iOS > App] テンプレートを選択します。
    3. [プロジェクト オプション] 画面で、次の操作を行います。
      1. プロジェクト名を入力します。
      2. [バンドル ID] フィールドの値を記録します。この値を使用して、以下の API キーを制限できます。
      3. プロジェクトの [インターフェース] を [ストーリーボード] に設定します。
      4. [言語] を [Swift] または [Objective-C] に設定します。
  3. プロジェクトのディレクトリに、Cartfile という名前のファイルを作成します。このファイルは、プロジェクトの依存関係を定義します。
  4. Cartfile を編集して、依存関係とそのバージョンを追加します。
    binary "https://dl.google.com/geosdk/GoogleMaps.json" == 6.2.1
    carthage outdated を定期的に実行して、新しいバージョンがあることを検出すると、常に最新の状態に保たれます。必要に応じて、最新バージョンにアップグレードしてください。
  5. Cartfile を保存します。
  6. ターミナル ウィンドウで、Cartfile を含むディレクトリに移動します。
    cd <path-to-project>
  7. carthage update コマンドを実行します。Cartfile で指定した API とその依存関係がインストールされます。
  8. Finder のプロジェクト ディレクトリで、Carthage/Build/iOS の下にあるダウンロードしたフレームワーク ファイルに移動します。
  9. 次のバンドルをプロジェクトにドラッグします(プロンプトが表示されたら、[Copy items 必要に応じて、必要に応じて上記と同じバージョンを使用してください] を選択します)。
    • GoogleMaps-x.x.x/Base/Frameworks/GoogleMapsBase.framework
    • GoogleMaps-x.x.x/Maps/Frameworks/GoogleMaps.framework
    • GoogleMaps-x.x.x/Maps/Frameworks/GoogleMapsCore.framework
    • (プレミアム プランをご利用のお客様のみ)GoogleMaps-x.x.x/M4B/Frameworks/GoogleMapsM4B.framework
  10. プロジェクトで GoogleMaps.framework を右クリックし、[Show In Finder] を選択します。
  11. GoogleMaps.bundleResources フォルダから Xcode プロジェクトの最上位ディレクトリにドラッグします。プロンプトが表示されたら、[コピー先グループにアイテムをコピー] が選択されていないことを確認します。
  12. プロジェクト ナビゲータで目的のプロジェクトを選択し、アプリのターゲットを選択します。
  13. アプリのターゲットの [Build Phases] タブを開き、[Link Binary with Libraries] 内で、次のフレームワークとライブラリを追加します。
    • 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
  14. (特定のターゲットではなく)プロジェクトを選択して、[Build Settings] タブを開きます。[Other Linker Flags] セクションで -ObjC を追加します。これらの設定が表示されない場合は、[Build Settings] バーのフィルタを [Basic] から [All] に変更します。

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

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

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

手動でインストールする

このガイドでは、Maps SDK for iOS を手動でプロジェクトに追加し、Xcode でビルド設定を行う方法について説明します。

  1. SDK ソースファイル(GoogleMaps-7.1.0)をダウンロードします。
  2. ダウンロードしたソースファイルを解凍します。
  3. Xcode プロジェクトをまだ作成していない場合は、ここで作成して、ローカルマシンに保存します。iOS 開発を初めて行う場合:
    1. 新しいプロジェクトを作成します。
    2. [iOS > App] テンプレートを選択します。
    3. [プロジェクト オプション] 画面で、次の操作を行います。
      1. プロジェクト名を入力します。
      2. [バンドル ID] フィールドの値を記録します。この値を使用して、以下の API キーを制限できます。
      3. プロジェクトの [インターフェース] を [ストーリーボード] に設定します。
      4. [言語] を [Swift] または [Objective-C] に設定します。
  4. 次のバンドルをプロジェクトにドラッグします(プロンプトが表示されたら、[Copy items 必要に応じて、必要に応じて上記と同じバージョンを使用してください] を選択します)。
    • GoogleMaps-x.x.x/Base/Frameworks/GoogleMapsBase.framework
    • GoogleMaps-x.x.x/Maps/Frameworks/GoogleMaps.framework
    • GoogleMaps-x.x.x/Maps/Frameworks/GoogleMapsCore.framework
    • (プレミアム プランをご利用のお客様のみ)GoogleMaps-x.x.x/M4B/Frameworks/GoogleMapsM4B.framework
  5. プロジェクトで GoogleMaps.framework を右クリックし、[Show In Finder] を選択します。
  6. GoogleMaps.bundleResources フォルダから Xcode プロジェクトの最上位ディレクトリにドラッグします。プロンプトが表示されたら、[コピー先グループにアイテムをコピー] が選択されていないことを確認します。
  7. プロジェクト ナビゲータで目的のプロジェクトを選択し、アプリのターゲットを選択します。
  8. アプリのターゲットの [Build Phases] タブを開き、[Link Binary with Libraries] 内で、次のフレームワークとライブラリを追加します。
    • 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. (特定のターゲットではなく)プロジェクトを選択して、[Build Settings] タブを開きます。[Other Linker Flags] セクションで -ObjC を追加します。これらの設定が表示されない場合は、[Build Settings] バーのフィルタを [Basic] から [All] に変更します。

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

XCFramework のインストール

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

カルタゴ付き

Maps SDK for iOS は、Swift および Objective-C Cocoa プロジェクトのシンプルな分散依存関係マネージャーである Carthage で使用できます。

  1. Carthage をインストールします。方法はいくつかあります。正確な手順については、Carthage の README ファイルをご覧ください。
  2. Xcode プロジェクトをまだ作成していない場合は、ここで作成して、ローカルマシンに保存します。iOS 開発を初めて行う場合:
    1. 新しいプロジェクトを作成します。
    2. [iOS > App] テンプレートを選択します。
    3. [プロジェクト オプション] 画面で、次の操作を行います。
      1. プロジェクト名を入力します。
      2. [バンドル ID] フィールドの値を記録します。この値を使用して、以下の API キーを制限できます。
      3. プロジェクトの [インターフェース] を [ストーリーボード] に設定します。
      4. [言語] を [Swift] または [Objective-C] に設定します。
  3. プロジェクト ディレクトリに、Cartfile という名前のファイルを作成します。このファイルは、プロジェクトの依存関係を定義します。
  4. Cartfile を編集して、依存関係とバージョンを追加します。

    binary "https://dl.google.com/geosdk/GoogleMaps.json" == 6.2.1-beta
  5. Cartfile を保存します。
  6. ターミナル ウィンドウで、Cartfile を含むディレクトリに移動します。
    cd <path-to-project>
  7. carthage update コマンドを実行します。これにより、Cartfile で指定された API と、必要な依存関係がインストールされます。
  8. Finder のプロジェクト ディレクトリで、Carthage/Build の下にあるダウンロードしたフレームワーク ファイルに移動します。
  9. 次の XCFrameworks をプロジェクトの [Frameworks、ライブラリ、埋め込みコンテンツ] にドラッグします。各 XCFramework で [表示しない] を選択します。
    • GoogleMaps-x.x.x/GoogleMapsBase.xcframework
    • GoogleMaps-x.x.x/GoogleMaps.xcframework
    • GoogleMaps-x.x.x/GoogleMapsCore.xcframework
    • (プレミアム プランをご利用のお客様のみ)GoogleMaps-x.x.x/GoogleMapsM4B.xcframework
  10. プロジェクトで GoogleMaps.xcframework を右クリックし、[Show In Finder] を選択します。
  11. GoogleMaps.bundleios-arm64_x86_64-simulator/GoogleMaps.framework/Resources フォルダから Xcode プロジェクトの最上位ディレクトリにドラッグします。プロンプトが表示されたら、[必要に応じてアイテムをコピー] が選択されていないことを確認します。
  12. Project Navigator からプロジェクトを選択し、アプリケーションのターゲットを選択します。
  13. アプリのターゲットにある [Build Phases] タブを開き、[Link Binary with Libraries] 内で、次のフレームワークとライブラリを追加します。
    • 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
  14. 特定のターゲットではなくプロジェクトを選択し、[Build Settings] タブを開きます。[その他のリンカーフラグ] セクションで、-ObjC を追加します。これらの設定が表示されない場合は、[Build Settings] バーのフィルタを [Basic] から [All] に変更します。

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

手動

このガイドでは、Maps SDK for iOS を手動でプロジェクトに追加し、Xcode でビルド設定を行う方法について説明します。

  1. SDK ソースファイル(GoogleMaps-7.1.0-beta-xcframework)をダウンロードします。
  2. ダウンロードしたソースファイルを解凍します。
  3. Xcode プロジェクトをまだ作成していない場合は、ここで作成して、ローカルマシンに保存します。iOS 開発を初めて行う場合:
    1. 新しいプロジェクトを作成します。
    2. [iOS > App] テンプレートを選択します。
    3. [プロジェクト オプション] 画面で、次の操作を行います。
      1. プロジェクト名を入力します。
      2. [バンドル ID] フィールドの値を記録します。この値を使用して、以下の API キーを制限できます。
      3. プロジェクトの [インターフェース] を [ストーリーボード] に設定します。
      4. [言語] を [Swift] または [Objective-C] に設定します。
  4. 次の XCFrameworks をプロジェクトの [Frameworks、ライブラリ、埋め込みコンテンツ] にドラッグします。各 XCFramework で [表示しない] を選択します。
    • GoogleMaps-x.x.x/GoogleMapsBase.xcframework
    • GoogleMaps-x.x.x/GoogleMaps.xcframework
    • GoogleMaps-x.x.x/GoogleMapsCore.xcframework
    • (プレミアム プランをご利用のお客様のみ)GoogleMaps-x.x.x/GoogleMapsM4B.xcframework
  5. プロジェクトで GoogleMaps.xcframework を右クリックし、[Show In Finder] を選択します。
  6. GoogleMaps.bundleios-arm64_x86_64-simulator/GoogleMaps.framework/Resources フォルダから Xcode プロジェクトの最上位ディレクトリにドラッグします。プロンプトが表示されたら、[必要に応じてアイテムをコピー] が選択されていないことを確認します。
  7. Project Navigator からプロジェクトを選択し、アプリケーションのターゲットを選択します。
  8. アプリのターゲットにある [Build Phases] タブを開き、[Link Binary with Libraries] 内で、次のフレームワークとライブラリを追加します。
    • 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. 特定のターゲットではなくプロジェクトを選択し、[Build Settings] タブを開きます。[その他のリンカーフラグ] セクションで、-ObjC を追加します。これらの設定が表示されない場合は、[Build Settings] バーのフィルタを [Basic] から [All] に変更します。

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

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

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

次の例では、YOUR_API_KEY を API キーに置き換えます。

Swift

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

  1. 次の import ステートメントを追加します。
    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 ステートメントを追加します。
    @import GoogleMaps;
  2. API キーを使用して、application:didFinishLaunchingWithOptions: メソッドに以下を追加します。
    [GMSServices provideAPIKey:@"YOUR_API_KEY"];
  3. Places API も使用している場合は、キーを次のように追加します。
    [GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];

ステップ 4(省略可): Metal レンダリング フレームワークの使用をオプトインする

Maps SDK for iOS を使用すると、Apple の Metal レンダリング フレームワークの使用をオプトインできます。アプリで Metal レンダラを試すには、地図ビューを作成する前に、Objective-C では [GMSServices setMetalRendererEnabled:YES]、Swift では GMSServices.setMetalRendererEnabled(true) を呼び出します。

SDK を手動でインストールする場合は、XCode に Metal.framework も追加する必要があります。

ステップ 5: 地図を追加する

次のコードは、既存の ViewController にシンプルな地図を追加する方法を示しています。

  1. アプリのデフォルト ViewController でメソッドを追加または更新して、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
    
          
  2. アプリを実行すると、オーストラリアのシドニーが中央に配置された地図が 1 つ表示されます。マーカーが表示されているのに地図が表示されない場合は、API キーを指定していることをご確認ください。

ステップ 6(省略可): 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 プロジェクトを準備したら、アプリを作成して実行できます。Maps SDK for iOS には、利用の開始に役立つ多くのチュートリアルとサンプルアプリが用意されています。詳しくは以下をご覧ください。