1. 概要
|
|
「iOS アプリへの Firebase App Distribution SDK の統合」Codelab へようこそ。この Codelab では、App Distribution SDK をアプリに追加して、新しいビルドがダウンロード可能になったときにテスターにアプリ内アラートを表示します。基本設定とカスタム設定の両方を使用して、テスターがログインしてアップデートを受け取るようにする方法を学びます。次に、新しいリリースを App Distribution に push し、アプリ内で新しいビルドアラートをトリガーします。
学習内容
- App Distribution を使用してプレリリース版のアプリをライブテスターに配布する方法
- App Distribution iOS SDK をアプリに統合する方法
- インストールできる新しいプレリリース ビルドがある場合にテスターに通知する方法
- 独自のテストニーズに合わせて SDK をカスタマイズする方法
必要なもの
- Xcode 12（またはそれ以降）
- CocoaPods 1.9.1 以降
- アドホック配信用の Apple Developer アカウント
- テスト用の物理 iOS デバイス。（この Codelab の大部分は iOS シミュレータ アプリで機能しますが、シミュレータではリリースをダウンロードできません）。
このチュートリアルをどのように使用されますか？
iOS アプリの作成経験について、どのように評価されますか。
2. Firebase コンソール プロジェクトを作成する
新しい Firebase プロジェクトを追加
- Firebase にログインします。
- Firebase コンソールで [プロジェクトを追加] をクリックし、プロジェクトに「Firebase Codelab」という名前を付けます。
このプロジェクトでは Google アナリティクスを有効にする必要はありません。
- [プロジェクトの作成] をクリックします。
Firebase にアプリを追加する
ドキュメントに沿って、アプリを Firebase に登録します。iOS バンドル ID として「com.google.firebase.codelab.AppDistribution.<your_name>」を使用します。
プロンプトが表示されたら、プロジェクトの GoogleService-Info.plist ファイルをダウンロードします。この値は後で使用します。
3. サンプル プロジェクトを取得する
コードのダウンロード
まず、サンプル プロジェクトのクローンを作成します。
git clone git@github.com:googlecodelabs/firebase-appdistribution-ios.git
Git がインストールされていない場合は、GitHub ページまたはこちらのリンクをクリックして、サンプル プロジェクトをダウンロードすることもできます。
依存関係をダウンロードして Xcode でプロジェクトを開く
- 同じディレクトリで Podfile を開きます。
cd firebase-appdistribution-ios/start Open Podfile
- 次の行を podfile に追加します。
Podfile
pod 'Firebase/AppDistribution'
プロジェクト ディレクトリで pod update を実行し、Xcode でプロジェクトを開きます。
pod install --repo-update xed .
Firebase アプリに合わせてバンドル ID を更新する
左側のメニューで AppDistributionExample をダブルクリックします。次に、[全般] タブに移動し、Firebase アプリのバンドル ID と一致するようにバンドル ID を変更します。バンドル ID は、プロジェクト設定で確認できます。「com.google.firebase.codelab.AppDistribution.<your_name>」のようになります。
アプリに Firebase を追加する
先ほどダウンロードした GoogleService-Info.plist ファイルをファイル システムで見つけ、Xcode プロジェクトのルートにドラッグします。また、このファイルはプロジェクトの設定ページからいつでもダウンロードできます。
AppDistributionExample/AppDelegate.swift ファイルで、ファイルの先頭に Firebase をインポートします。
AppDistributionExample/AppDelegate.swift
import Firebase
didFinishLaunchingWithOptions メソッドに、Firebase を構成する呼び出しを追加します。
AppDistributionExample/AppDelegate.swift
FirebaseApp.configure()
4. App Distribution SDK を使用してアプリ内の新しいビルドアラートを設定する
このステップでは、Firebase App Distribution SDK をアプリに追加し、アプリの新しいビルドがインストール可能になるとテスターにアプリ内アラートを表示します。そのためには、「Firebase Codelab」プロジェクトで Firebase App Testers API が有効になっていることを（Google Cloud コンソールで）確認します。同じアカウントでログインし、上部のプルダウン メニューから適切なプロジェクトを選択する必要があります。
アプリ内アラートを構成する
App Distribution SDK では、テスター向けのアプリ内ビルドアラートを設定する方法が 2 つあります。1 つは基本的なアラート構成で、テスターに表示するログイン ダイアログがあらかじめ組み込まれています。もう 1 つは、独自のユーザー インターフェース（UI）をカスタマイズできる高度なアラート構成です。
まず、基本的なアラート構成から始めましょう。checkForUpdate を使用すると、アラートをまだ有効にしていないテスターに対して、事前に構築されたアラートの有効化ダイアログを表示して、新しいビルドが利用可能かどうかを確認できます。テスターは、App Distribution でアプリへのアクセス権を持つアカウントにログインしてアラートを有効にします。このメソッドを呼び出すと、このメソッドにより次のシーケンスが実行されます。
- テスターがアラートを有効にしているか確認します。そうでない場合は、Google アカウントで App Distribution にログインするよう求めるダイアログが表示されます。
アラートの有効化は、テストデバイスで 1 回限りのプロセスであり、アプリがアップデートされても継続します。アラートは、アプリをアンインストールするか signOutTester メソッドが呼び出されるまで、テストデバイスで有効なままになります。詳細については、メソッドのリファレンス ドキュメント（Swift または Objective-C）をご覧ください。
アプリには任意の時点で checkForUpdate を含めることができます。たとえば、起動時に新たに利用可能になったビルドをインストールするようテスターに促すには、UIViewController の viewDidAppear に checkForUpdate を含めます。
AppDistributionViewController.swift ファイルで、ファイルの先頭に Firebase をインポートします。
AppDistributionViewController.swift
import Firebase
AppDistributionExample/AppDistributionViewController.swift を開き、次のようにして viewDidAppear メソッドに行をコピーします。
AppDistributionViewController.swift
override func viewDidAppear(_ animated: Bool) {
checkForUpdate()
}
次に、checkForUpdate() メソッドを実装します。
AppDistributionViewController.swift
private func checkForUpdate() {
AppDistribution.appDistribution().checkForUpdate(completion: { [self] release, error in
var uiAlert: UIAlertController
if error != nil {
uiAlert = UIAlertController(title: "Error", message: "Error Checking for update! \(error?.localizedDescription ?? "")", preferredStyle: .alert)
} else if release == nil {
uiAlert = UIAlertController(title: "Check for Update", message: "No releases found!!", preferredStyle: .alert)
uiAlert.addAction(UIAlertAction(title: "Ok", style: UIAlertAction.Style.default))
} else {
guard let release = release else { return }
let title = "New Version Available"
let message = "Version \(release.displayVersion)(\(release.buildVersion)) is available."
uiAlert = UIAlertController(title: title, message: message, preferredStyle: .alert)
uiAlert.addAction(UIAlertAction(title: "Update", style: UIAlertAction.Style.default) {
_ in
UIApplication.shared.open(release.downloadURL)
})
uiAlert.addAction(UIAlertAction(title: "Cancel", style: UIAlertAction.Style.cancel) {
_ in
})
}
self.present(uiAlert, animated: true, completion: nil)
})
}
5. テスターを作成してアプリをダウンロードするよう招待する
このステップでは、Firebase コンソールを使用してテスターにビルドを配布し、アプリをビルドして実装をテストします。
アプリを作成する
プレリリース版のアプリをテスターに配布する準備ができたら、ビルド先として [任意の iOS デバイス（arm64）] を選択し、[プロダクト] -> [アーカイブ] を選択します。アーカイブを作成したら、Development ディストリビューション プロファイルを使用して署名済みのディストリビューションを作成します。
ビルドが完了すると、指定したフォルダに IPA ファイルといくつかのログファイルが保存されます。次のステップで、IPA ファイルをテスターに配布します。
アプリのビルドで問題が発生した場合は、Apple のコード署名のドキュメントでトラブルシューティングの手順をご覧ください。
テスターにアプリを配布する
テスターにアプリを配布するには、Firebase コンソールを使用して IPA ファイルをアップロードします。
- Firebase コンソールの [App Distribution] ページを開きます。指示に従って Firebase プロジェクトを選択します。
- [開始] を押します。
- [リリース] ページで、配布するアプリをプルダウン メニューから選択します。
- アプリの IPA ファイルをコンソールにドラッグしてアップロードします。
- アップロードが完了したら、ビルドを受け取るテスター グループと個々のテスターを指定します。（招待を受け取るには、メールアドレスを追加してください）。次に、ビルドのリリースノートを追加します。テスター グループの作成について詳しくは、テスターを管理するをご覧ください。
- [Distribute] をクリックして、テスターがビルドを利用できるようにします。
ご自身をリリースのテスターとして追加する
これで、Firebase コンソールで、アプリのリリースに追加したテスターを確認できます。
メールアドレスを指定したため、アプリをテストするための招待メールが Firebase App Distribution から届きます。これで最初のテスターになります。以下の手順に沿って、テストデバイスでテスターとして設定します。
テストデバイスを登録する
アドホック リリースをダウンロードしてテストするには、まずテストデバイスを登録する必要があります。
- iOS のテストデバイスで、Firebase App Distribution から送信されたメールを開き、[使ってみる] リンクをタップします。必ず Safari でリンクを開いてください。
- Firebase App Distribution テスター ウェブアプリが表示されたら、Google アカウントでログインし、[招待に応じる] をタップします。
招待されたリリースが表示されます。
- [デバイスを登録] をタップして UDID を Firebase と共有し、後でアプリのプロビジョニング プロファイルを更新できるようにします。
- 手順に沿って設定に移動し、プロファイルをダウンロードして UDID を共有します。
App Distribution に戻ると、リリースが [Device 登録済み] としてマークされています。
これで、テスターの UDID がデベロッパーと共有されました。テスターにアプリの新しいバージョンをビルドするかどうかは、デベロッパー次第です。
コンソールでテスター情報を表示する
Firebase コンソールのデベロッパー ビューに戻ると、テスターがリリースに [Accepted] と表示されます。
デベロッパーが使用しているデバイスがプロビジョニング プロファイルに含まれていない場合は、デベロッパーにもメールが届きます。追加する必要がある新しい UDID を通知するメッセージが表示されます。すべての UDID をテキスト ファイルとしてエクスポートすることもできます。
- すべての UDID をエクスポートするには、[テスターとグループ] タブを開きます。
- [Apple UDID をエクスポート] をクリックします。
このファイルには、テストデバイスの UDID を含める必要があります。
Device ID Device Name Device Platform
1234567890 tester.app.distribtuion@gmail.com - iPhone SE 2nd Gen ios
このようなメールが届いたら、UDID を使用してプロビジョニング プロファイルを更新し、次の手順に沿って新しいビルドをテスターに配布します。
- デバイスを Apple デベロッパー ポータルに追加します。
- オプション 1: デバイスの UDID を CSV ファイルとしてインポートする。App Distribution ダッシュボードの [テスターとグループ] タブで、[すべてのテスター] を選択し、[Apple UDID をエクスポート] をクリックして CSV ファイルをダウンロードします。次に、[複数のデバイスを登録] オプションを使用して、Apple デベロッパー アカウントにファイルをインポートします。詳しくは、Apple のドキュメントをご覧ください。Apple デベロッパー アカウントでインポートできるデバイスの数は、1 年間に限られることにご注意ください。
- オプション 2: UDID をメールで収集して入力します。Apple デベロッパー ポータルの [Add Devices] ページで、受信したメールに記載されている新しい UDID を登録します。
- 登録済みのデバイスをプロビジョニング プロファイルに追加します。
- プロビジョニング プロファイルをダウンロードし、それを使用してアプリを再構築します。登録済みのデバイスを更新するためだけに再ビルドする場合は、ビルド番号やバージョンを更新しないでください。
- Firebase コンソールまたは CLI からアプリを再配布します。同じビルド番号とバージョンのビルドをすでに配布している場合、通知メールは新しく登録されたデバイスのユーザーのみに送信されます。
テストデバイスからリリースをダウンロードする
これで、リリースにテストデバイスの UDID が設定され、テストデバイスでアプリをダウンロードしてインストールできるようになりました。新しいリリースに UDID が追加されると、App Distribution からテスターにメールが送信されます。
- テストデバイスで、メール内のリンクまたはデバイスのホーム画面のアイコンを使用して、App Distribution テスター ウェブアプリに戻ります。
UDID Codelab アプリに移動すると、リリースをダウンロードする準備ができていることを確認できます。
- 実機を使用している場合は、[ダウンロード] をタップし、アプリをインストールして実行します。
- アプリが起動すると、新しいビルドアラートを有効にするよう求めるメッセージが表示されます。[オンにする] を選択します
- ログインを求められます。[続行] をクリックします。
- テスター アカウントでログインします。
- アプリに戻ります。次回アプリを実行したときに、ログインしたりアラートを受け取ったりする必要はありません。
テスターにアップデートを配布する
- ビルド番号を「2」に更新します。
- ビルドの宛先として [Any iOS Device (arm64)] を選択し、[Product] -> [Archive] を選択します。アーカイブが生成されたら、Development ディストリビューション プロファイルを使用して署名済みのディストリビューションを作成します。
- ビルドが完了すると、指定したフォルダに IPA ファイルといくつかのログファイルが保存されます。この新しい IPA を Firebase コンソールでアップロードし、メールアドレスをテスターとして再度追加して [配信] をクリックします。
テストビルドのアラート
- アプリが開いていた場合は、閉じたことを確認します。アプリを再起動します。
- アプリが再起動すると、「新しいバージョンが利用可能です」というアラートが表示されます。
- [更新] をクリックして最新バージョンを入手します。
- 次の画面で [インストール] をクリックします。
- これで完了です。組み込みのアラートでアプリを更新できました。
6. テスターのログインをカスタマイズする
signInTester/signOutTester メソッドと isTesterSignedIn メソッドを使用すると、テスターのログイン エクスペリエンスをより柔軟にカスタマイズできるため、アプリのデザインに合わせやすくなります。
次の例では、テスターが Firebase App Distribution のテスター アカウントにすでにログインしているかどうかをチェックしています。これにより、まだログインしていないテスターにのみログイン UI を表示するように選択できます。テスターがログインしたら、checkForUpdate を呼び出して、テスターが新しいビルドにアクセスできるかどうかを確認できます。
viewDidAppea での更新の自動確認を無効にするには、checkForUpdate() 呼び出しをコメントアウトします。
AppDistributionViewController.swift
override func viewDidAppear(_ animated: Bool) {
// checkForUpdate()
}
代わりに、checkForUpdateButtonClicked() で checkForUpdate() を呼び出します。
@objc func checkForUpdateButtonClicked() {
checkForUpdate()
}
次に、signInOutButtonClicked() メソッドを実装しましょう。ユーザーがログアウトしている場合はログインし、ログイン済みの場合はログアウトします。
AppDistributionViewController.swift
@objc func signInOutButtonClicked() {
if isTesterSignedIn() {
AppDistribution.appDistribution().signOutTester()
self.configureCheckForUpdateButton()
self.configureSignInSignOutButton()
self.configureSignInStatus()
} else {
AppDistribution.appDistribution().signInTester(completion: { error in
if error == nil {
self.configureCheckForUpdateButton()
self.configureSignInSignOutButton()
self.configureSignInStatus()
} else {
let uiAlert = UIAlertController(title: "Custom:Error", message: "Error during tester sign in! \(error?.localizedDescription ?? "")", preferredStyle: .alert)
uiAlert.addAction(UIAlertAction(title: "Ok", style: UIAlertAction.Style.default) {
_ in
})
self.present(uiAlert, animated: true, completion: nil)
}
})
}
}
最後に、isTesterSignedIn メソッドを実装します。
AppDistributionViewController.swift
private func isTesterSignedIn() -> Bool {
return AppDistribution.appDistribution().isTesterSignedIn
}
実装をビルドしてテストする
7. お疲れさまでした
Firebase App Distribution iOS SDK を使用して、「アプリ内アラート表示」機能をアプリに組み込みました。
学習した内容
- Firebase App Distribution
- Firebase App Distribution の新しいアラート iOS SDK
次のステップ
詳細
質問がある場合
問題を報告する