Firebase を Apple プロジェクトに追加する

  • 以下をインストールします。

    • Xcode 14.1 以降

  • プロジェクトが次の要件を満たしていることを確認します。

    • 以下のバージョンまたはそれ以降のプラットフォームをターゲットにしている必要があります。
      • iOS 11
      • macOS 10.13
      • tvOS 12
      • watchOS 6

  • アプリを実行するための物理的な Apple デバイスを設定するか、またはシミュレータを使用します。

    Apple プラットフォームで Cloud Messaging を使用する場合の前提条件は次のとおりです。

    • 物理的な Apple デバイスを設定します。
    • Apple Developer アカウントの Apple Push Notification Authentication Key を取得します。
    • プッシュ通知を XCode の [App] > [Capabilities] で有効にします。

Xcode プロジェクトがない場合、Firebase プロダクトを試してみるだけであれば、クイックスタート サンプルをダウンロードしてお使いいただけます。

Apple アプリに Firebase を追加する前に、アプリに接続するための Firebase プロジェクトを作成します。Firebase プロジェクトの詳細については、Firebase プロジェクトについて理解するをご覧ください。

  1. Firebase コンソールで [プロジェクトを追加] をクリックします。

    • Firebase リソースを既存の Google Cloud プロジェクトに追加するには、そのプロジェクト名を入力するか、プルダウン メニューから選択します。

    • 新しいプロジェクトを作成するには、任意のプロジェクト名を入力します。必要に応じて、プロジェクト名の下に表示されるプロジェクト ID を編集することもできます。

  2. Firebase の利用規約が表示されたら、内容を読み、同意します。

  3. [続行] をクリックします。

  4. （省略可）プロジェクトに対し Google アナリティクスを設定します。これにより、次の Firebase プロダクトを使用する際のエクスペリエンスを最適化できます。

    既存の Google アナリティクス アカウントを選択するか、新しいアカウントを作成します。

    新しいアカウントを作成する場合は、アナリティクス レポートのロケーションを選択し、プロジェクトのデータ共有設定と Google アナリティクスの規約に同意します。

  5. [プロジェクトを作成]（既存の Google Cloud プロジェクトを使用する場合は [Firebase を追加]）をクリックします。

Firebase プロジェクトのリソースが自動的にプロビジョニングされます。処理が完了すると、Firebase コンソールに Firebase プロジェクトの概要ページが表示されます。

Apple アプリで Firebase を使用するには、アプリを Firebase プロジェクトに登録する必要があります。アプリの登録は、プロジェクトへのアプリの「追加」とも呼ばれます。

  1. Firebase コンソールに移動します。

  2. プロジェクトの概要ページの中央にある iOS+ アイコンをクリックして、設定ワークフローを起動します。

    すでに Firebase プロジェクトにアプリを追加している場合は、[アプリを追加] をクリックするとプラットフォームのオプションが表示されます。

  3. アプリのバンドル ID を [Apple バンドル ID] フィールドに入力します。

    • バンドル ID は、Apple のエコシステム内でアプリケーションを一意に識別するものです。

    • バンドル ID を確認する: Xcode でプロジェクトを開き、プロジェクト ナビゲータで最上位のアプリを選択し、[General] タブを選択します。

      [Bundle Identifier] フィールドの値がバンドル ID です（例: com.yourcompany.yourproject）。

    • バンドル ID の値は大文字と小文字が区別されます。Firebase プロジェクトに登録すると、該当の Firebase アプリのバンドル ID は変更できなくなることに注意してください。

  4. （省略可）その他のアプリ情報（アプリのニックネームと App Store ID）を入力します。

  5. [アプリを登録] をクリックします。

  1. [GoogleService-Info.plist をダウンロード] をクリックして、Firebase Apple プラットフォーム構成ファイル（GoogleService-Info.plist）を取得します。

    • Firebase 構成ファイルには、プロジェクト用の機密ではない一意の識別子が含まれています。この構成ファイルの詳細については、Firebase プロジェクトについて理解するをご覧ください。

    • Firebase 構成ファイルはいつでも再ダウンロードできます。

    • 構成ファイル名に (2) などの文字が追加されていないことを確認します。

  2. 構成ファイルを Xcode プロジェクトのルートに移動します。メッセージが表示されたら、構成ファイルをすべてのターゲットに追加するオプションを選択します。

プロジェクトに複数のバンドル ID がある場合は、Firebase コンソールで登録済みアプリに各バンドル ID を関連付けて、各アプリで固有の GoogleService-Info.plist ファイルを使用できるようにする必要があります。

Swift Package Manager を使用して Firebase の依存関係のインストールと管理を行います。

  1. Xcode でアプリのプロジェクトを開いたまま、[File] > [Add Packages] の順に移動します。
  2. プロンプトが表示されたら、Firebase Apple プラットフォーム SDK リポジトリを追加します。
    3.   https://github.com/firebase/firebase-ios-sdk
  3. 使用する SDK のバージョンを選択します。

  4. 使用する Firebase ライブラリを選択します。

    Firebase プロジェクトで Google アナリティクスが有効になっている場合は、必ず FirebaseAnalytics を追加してください。アナリティクスに IDFA 収集機能がない場合は、代わりに FirebaseAnalyticsWithoutAdId を追加してください。

上記の作業が完了すると、Xcode は依存関係の解決とバックグラウンドでのダウンロードを自動的に開始します。

最後に、アプリケーションに初期化コードを追加します。この手順は、アプリに Firebase を追加するときにすでに完了している可能性があります。クイックスタートのサンプル プロジェクトを使用した場合は自動で完了しています。

  1. UIApplicationDelegate に FirebaseCore モジュールと、アプリのデリゲートが使用する他の Firebase モジュールをインポートします。たとえば、Cloud Firestore と Authentication を使用するには、次のようにします。
    SwiftUISwiftObjective-C
     
    import SwiftUI
    import FirebaseCore
    import FirebaseFirestore
    import FirebaseAuth
    // ...
          
    import FirebaseCore
    import FirebaseFirestore
    import FirebaseAuth
    // ...
          
    @import FirebaseCore;
    @import FirebaseFirestore;
    @import FirebaseAuth;
    // ...
         
  2. アプリ デリゲートの application(_:didFinishLaunchingWithOptions:) メソッドで、FirebaseApp 共有インスタンスを構成します。
    SwiftUISwiftObjective-C
     
    // Use Firebase library to configure APIs
    FirebaseApp.configure()
     
    // Use Firebase library to configure APIs
    FirebaseApp.configure()
     
    // Use Firebase library to configure APIs
    [FIRApp configure];
  3. SwiftUI を使用している場合は、アプリケーション デリゲートを作成し、UIApplicationDelegateAdaptor または NSApplicationDelegateAdaptor を介して App 構造体に接続する必要があります。また、アプリ デリゲートのメソッドの実装入れ替えを無効にする必要があります。詳細については、SwiftUI の手順をご覧ください。
    SwiftUI
     
    @main
    struct YourApp: App {
          // register app delegate for Firebase setup
          @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate

          var body: some Scene {
            WindowGroup {
              NavigationView {
                ContentView()
              }
            }
          }
    }
         
  4. Google アナリティクス用の Firebase SDK を追加した場合は、アプリを実行して、Firebase のインストールに成功したという確認を Firebase コンソールに送信します。

設定は以上です。状況に応じて次の手順に進んでください。

設定の際に問題が発生した場合は、Apple プラットフォームのトラブルシューティングとよくある質問をご覧ください。

使用可能なライブラリ

このセクションでは、Apple プラットフォームでサポートされている Firebase プロダクトを一覧表示しています。Firebase Apple プラットフォーム ライブラリの詳細については、以下をご覧ください。

サービスまたはプロダクト Pod SwiftPM ライブラリ アナリティクスの追加
AdMob pod 'Google-Mobile-Ads-SDK' 該当なし
アナリティクス pod 'FirebaseAnalytics' FirebaseAnalytics
App Check pod 'FirebaseAppCheck' FirebaseAppCheck
App Distribution pod 'FirebaseAppDistribution' FirebaseAppDistribution
Authentication pod 'FirebaseAuth' FirebaseAuth
Cloud Firestore pod 'FirebaseFirestore' FirebaseFirestore
Cloud Functions for Firebase Client SDK pod 'FirebaseFunctions' FirebaseFunctions
Cloud Messaging pod 'FirebaseMessaging' FirebaseMessaging
Cloud Storage pod 'FirebaseStorage' FirebaseStorage
Crashlytics pod 'FirebaseCrashlytics' FirebaseCrashlytics
Dynamic Links pod 'FirebaseDynamicLinks' FirebaseDynamicLinks
In-App Messaging pod 'FirebaseInAppMessaging' FirebaseInAppMessaging
（必須）
Firebase インストール pod 'FirebaseInstallations' FirebaseInstallations
Firebase ML カスタムモデル API pod 'FirebaseMLModelDownloader' FirebaseMLModelDownloader
Performance Monitoring pod 'FirebasePerformance' FirebasePerformance
Realtime Database pod 'FirebaseDatabase' FirebaseDatabase
Remote Config pod 'FirebaseRemoteConfig' FirebaseRemoteConfig

Swift Package Manager を使用せずに統合する

Swift Package Manager を使用しない場合でも、CocoaPods を使用するか、フレームワークを直接インポートすることで、Firebase SDK を利用できます。

CocoaPods

CocoaPods 統合の詳細については、こちらのガイドをご覧ください。

フレームワーク

iOS プラットフォームのサポートに加えて、zip には .xcframework ファイルが含まれるようになりました。詳しくは、GitHub の Firebase Apple プラットフォーム SDK の README をご覧ください。

  1. framework SDK zip をダウンロードします。このファイルのサイズは約 200 MB で、ダウンロードに時間がかかる場合があります。

  2. ファイルを解凍し、アプリに含めるフレームワークを統合します。

    統合の手順は次のいずれかの場所でご確認いただけます。

    フレームワークのバージョンまたは依存関係については、ダウンロードした zip ディストリビューション内の METADATA.md ファイルをご覧ください。

  3. ターゲットのビルド設定で Other Linker Settings に -ObjC リンカーフラグを追加します。

次のステップ

以下で Firebase の詳細を確認します。

Firebase サービスをアプリに追加します。