App Center の配布 – iOS アプリ内更新プログラム

  • [アーティクル]

重要

Visual Studio App Center は、2025 年 3 月 31 日に廃止される予定です。 完全に廃止されるまで Visual Studio App Center を引き続き使用できますが、移行を検討できる推奨される代替手段がいくつかあります。

詳細については、サポートタイムラインと代替手段に関するページを参照してください。

App Center 配布を使用すると、App Center 経由で配布するときに、ユーザーは新しいバージョンのアプリをインストールできます。 利用可能な新しいバージョンのアプリでは、SDK によって、新しいバージョンをダウンロードまたは延期するための更新ダイアログがユーザーに表示されます。 更新を選択すると、SDK によってアプリケーションの更新が開始されます。

注意

アプリ内更新プログラムを使用する場合は、いくつかの点を考慮する必要があります。

  1. App Storeでアプリをリリースした場合、アプリ内更新プログラムは無効になります。
  2. 自動 UI テストを実行している場合、アプリ内更新を有効にすると、App Center バックエンドに対する認証が試行されるため、自動 UI テストはブロックされます。 UI テスト ターゲットに対して App Center Distribute を有効にしないことをお勧めします。

注意

App Center のバージョンでは、 4.0.0 破壊的変更が導入されました。 App Center SDK 4.0.0 以降への移行に関するセクションに従って、以前のバージョンから App Center を移行します。

重要

App Center SDK では、iOS 13 で導入された複数のウィンドウ アプリはサポートされていません。

アプリ内更新プログラムをアプリに追加する

アプリケーションで SDK を構成していない場合は、「 はじめ に」セクションに従います。

1. App Center の配布モジュールを追加する

App Center SDK はモジュール形式のアプローチで設計されています。必要なのは、関心のあるサービスのモジュールを統合することだけです。

Cocoapods による統合

Cocoapods を使用して App Center をアプリに統合する場合は、次の依存関係を podfile に追加し、 を実行 pod installします。

pod 'AppCenter/Distribute'

Carthage による統合

  1. 次の依存関係を に Cartfile 追加して、App Center Distribute を含めます。

    # Use the following line to get the latest version of App Center
github "microsoft/appcenter-sdk-apple"

    # Use the following line to get the specific version of App Center
github "microsoft/appcenter-sdk-apple" ~> X.X.X

  2. carthage update を実行します。

  3. アプリケーション ターゲットの [全般設定] タブ を 開きます。 AppCenterDistribute.framework ファイルを Carthage/Build/iOS フォルダーから XCode の [リンクされたフレームワークとライブラリ ] セクションにドラッグ アンド ドロップします。

  4. AppCenterDistributeResources.bundleを AppCenterDistribute.framework から XCode のプロジェクト ナビゲーターにドラッグ アンド ドロップします。

  5. ダイアログが表示され、アプリ ターゲットがオンになっていることを確認します。 [完了] をクリックします。

Swift パッケージ マネージャーを使用した統合

  1. [Xcode] メニューの [ ファイル] > [Swift パッケージ] > [パッケージの依存関係の追加] の順にクリックします。
  2. 表示されるダイアログで、リポジトリ URL を入力します。 https://github.com/microsoft/appcenter-sdk-apple.git
  3. [ バージョン] で、[ 次のメジャーまで ] を選択し、既定のオプションを選択します。
  4. [パッケージ製品] 列で [AppCenterDistribute] を選択します。

バイナリをプロジェクトにコピーすることによる統合

Cocoapods を使用しない場合は、バイナリをプロジェクトにコピーしてモジュールを統合できます。 次の手順に従います。

注意

App Center SDK では、 の使用 XCframeworkがサポートされています。 XCframeworks をプロジェクトに統合する場合は、リリース ページから AppCenter-SDK-Apple-XCFramework.zip をダウンロードして解凍します。 結果として得られるフォルダーの内容はプラットフォーム固有ではなく、モジュールごとに XCframeworks が含まれます。 これらは、次に説明するように、通常のフレームワークと同じ方法で統合できます。

  1. zip ファイルとして提供されている App Center SDK フレームワークをダウンロードします。

  2. ファイルを解凍すると、App Center サービスごとに異なるフレームワークを含む AppCenter-SDK-Apple/iOS というフォルダーが表示されます。 呼び出される AppCenter フレームワークは、異なるモジュール間で共有されるコードを含んでいるため、プロジェクトで必要です。

  3. [省略可能]サード パーティ製ライブラリのサブディレクトリを作成します。

    • ベスト プラクティスとして、サードパーティ製のライブラリは通常、サブディレクトリ内にあり、多くの場合、 Vendor と呼ばれます。 プロジェクトがライブラリのサブディレクトリで編成されていない場合は、ここで Vendor サブディレクトリを作成します。
    • Xcode プロジェクト内に Vendor というグループを作成して、ディスク上のファイル構造を模倣します。

  4. Finder を開き、解凍した AppCenter-SDK-Apple/iOS フォルダーを、目的の場所にあるプロジェクトのフォルダーにコピーします。

  5. Xcode のプロジェクトに SDK フレームワークを追加します。

    • [プロジェクト ナビゲーター] が表示されていることを確認します (⌘+1)。
    • ここで、 AppCenter.framework、 AppCenterDistribute.framework、 AppCenterDistributeResources.bundle を Finder ( Vendor フォルダー内のもの) から Xcode の Project Navigator にドラッグ アンド ドロップします。 SDK を起動するには、AppCenter.framework が必要です。 プロジェクトに追加されていることを確認します。そうでない場合は、他のモジュールが機能せず、プロジェクトが正常にコンパイルされません。
    • ダイアログが表示され、アプリ ターゲットがオンになっていることを確認します。 [完了] をクリックします。

2. App Center の配布を開始する

App Center では、アプリケーションで呼び出す特定のモジュールのみが使用されます。 SDK を起動するときは、それぞれを明示的に呼び出す必要があります。

2.1 App Center Distribute のインポートを追加する

Objective-C でプロジェクトの AppDelegate.m ファイルを開くか、Swift の AppDelegate.swift ファイルを開き、次の import ステートメントを追加します。

@import AppCenter;
@import AppCenterDistribute;

import AppCenter
import AppCenterDistribute

2.2 メソッドを追加するstart:withServices:

メソッドstart:withServices:に を追加Distributeして、App Center Distribute サービスを開始します。

次の行を挿入して、Objective-C の場合はプロジェクトの AppDelegate.m クラス、メソッドでは Swift の AppDelegate.swift クラスで SDK を didFinishLaunchingWithOptions 開始します。

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACDistribute class]]];

AppCenter.start(withAppSecret: "{Your App Secret}", services: [Distribute.self])

上記のコード サンプルで、アプリ シークレットに置き換えてください {Your App Secret} 。 また、アプリケーションで SDK を構成していない場合は、「はじめに」セクションをチェックします。

2.3 プロジェクトの Info.plist を変更する

  1. プロジェクトの Info.plist ファイルで、上部の [情報プロパティ リスト] の横にある [+] ボタンをクリックして、 の新しいキー URL types を追加します。 Xcode に Info.plist がソース コードとして表示される場合は、以下のヒントを参照してください。
  2. キーの種類を Array に変更します。
  3. 配列 (Item 0) に新しいエントリを追加し、型を Dictionary に変更します。
  4. の下 Item 0にキーを URL Schemes 追加し、型を Array に変更します。
  5. キーの下に URL Schemes 新しいエントリ (Item 0) を追加します。
  6. の値URL Schemes>Item 0を にappcenter-{APP_SECRET}変更し、アプリのアプリ シークレットに置き換えます。{APP_SECRET}

ヒント

Info.plist を正しく変更したことを確認する場合は、ソース コードとして開きます。 これには、 ではなく、アプリ シークレットを含む次の {APP_SECRET}エントリが含まれている必要があります。

<key>CFBundleURLTypes</key>
<array>
  <dict>
  	<key>CFBundleURLSchemes</key>
  	<array>
  		<string>appcenter-{APP_SECRET}</string>
  	</array>
  </dict>
</array>

プライベート配布グループを使用する

既定では、配布ではパブリック配布グループが使用されます。 プライベート配布グループを使用する場合は、プロパティを使用して updateTrack 明示的に設定する必要があります。

MSACDistribute.updateTrack = MSACUpdateTrackPrivate;

Distribute.updateTrack = .private

注意

既定値は UpdateTrack.public です。 このプロパティは、メソッド呼び出しの AppCenter.start 前にのみ更新できます。 更新トラックの変更は、アプリケーション プロセスの再起動時に保持されないため、呼び出しの前に プロパティが常に AppCenter.start 更新されない場合は、既定でパブリックになります。

この呼び出しの後、ブラウザー ウィンドウが開き、ユーザーを認証します。 以降のすべての更新チェックでは、プライベート トラックの最新リリースが取得されます。

ユーザーが プライベート トラックにいる場合は、認証が成功した後、メンバーになっているすべてのプライベート配布グループから最新のリリースが取得されることを意味します。 ユーザーが パブリック トラックにいる場合は、すべてのパブリック配布グループから最新のリリースを取得することを意味します。

自動更新の自動チェックを無効にする

既定では、SDK は新しいリリースを自動的にチェックします。

  • アプリケーションの起動時。
  • アプリケーションがバックグラウンドになると、フォアグラウンドで再び実行されます。
  • 以前に無効になっている場合は、配布モジュールを有効にする場合。

新しいリリースを手動でチェックする場合は、更新プログラムの自動チェックを無効にすることができます。 これを行うには、SDK の開始前に次のメソッドを呼び出します。

[MSACDistribute disableAutomaticCheckForUpdate];

Distribute.disableAutomaticCheckForUpdate()

注意

このメソッドは、メソッド呼び出しの前に呼び出す AppCenter.start 必要があります。

その後、次の checkForUpdate セクションで説明する API を使用できます。

手動で更新プログラムを確認する

[MSACDistribute checkForUpdate];

Distribute.checkForUpdate()

これにより、App Center に要求が送信され、新しいリリースが利用可能な場合に備えて更新ダイアログが表示されます。

注意

自動更新が有効になっている場合でも、更新呼び出しの手動チェックが機能します。 別のチェックが既に実行されている場合、更新の手動チェックは無視されます。 更新プログラムの手動チェックは、ユーザーが更新プログラムを延期した場合は処理されません (最新バージョンが必須の更新プログラムでない限り)。

アプリ内更新ダイアログをカスタマイズまたはローカライズする

1. テキストをカスタマイズまたはローカライズする

更新ダイアログに表示されるテキストをローカライズする場合は、独自のリソース文字列を簡単に指定できます。 この文字列ファイルを見てください。 同じ文字列名/キーを使用し、独自のアプリ文字列ファイルのダイアログに反映されるローカライズされた値を指定します。

2. 更新ダイアログをカスタマイズする

プロトコルを実装することで、既定の更新ダイアログの外観を DistributeDelegate カスタマイズできます。 次の例に示すように、SDK を開始する前にデリゲートを登録する必要があります。

[MSACDistribute setDelegate:self];

Distribute.delegate = self;

SDK ダイアログをカスタムのダイアログに置き換えるデリゲート実装の例を次に示します。

- (BOOL)distribute:(MSACDistribute *)distribute releaseAvailableWithDetails:(MSACReleaseDetails *)details {

  // Your code to present your UI to the user, e.g. an UIAlertController.
  UIAlertController *alertController = [UIAlertController
      alertControllerWithTitle:@"Update available."
                       message:@"Do you want to update?"
                preferredStyle:UIAlertControllerStyleAlert];

  [alertController
      addAction:[UIAlertAction actionWithTitle:@"Update"
                                         style:UIAlertActionStyleCancel
                                       handler:^(UIAlertAction *action) {
                                         [MSACDistribute notifyUpdateAction:MSACUpdateActionUpdate];
                                       }]];

  [alertController
      addAction:[UIAlertAction actionWithTitle:@"Postpone"
                                         style:UIAlertActionStyleDefault
                                       handler:^(UIAlertAction *action) {
                                         [MSACDistribute notifyUpdateAction:MSACUpdateActionPostpone];
                                       }]];

  // Show the alert controller.
  [self.window.rootViewController presentViewController:alertController animated:YES completion:nil];
  return YES;
}

func distribute(_ distribute: Distribute, releaseAvailableWith details: ReleaseDetails) -> Bool {

  // Your code to present your UI to the user, e.g. an UIAlertController.
  let alertController = UIAlertController(title: "Update available.",
                                        message: "Do you want to update?",
                                 preferredStyle:.alert)

  alertController.addAction(UIAlertAction(title: "Update", style: .cancel) {_ in
    Distribute.notify(.update)
  })

  alertController.addAction(UIAlertAction(title: "Postpone", style: .default) {_ in
    Distribute.notify(.postpone)
  })

  // Show the alert controller.
  self.window?.rootViewController?.present(alertController, animated: true)
  return true;
}

上記のメソッドで を返した YES/true 場合、アプリはユーザーの選択を取得し、次の API を使用して結果を SDK にメッセージする必要があります。

// Depending on the user's choice, call notifyUpdateAction: with the right value.
[MSACDistribute notifyUpdateAction:MSACUpdateActionUpdate];
[MSACDistribute notifyUpdateAction:MSACUpdateActionPostpone];

// Depending on the user's choice, call notify() with the right value.
Distribute.notify(.update);
Distribute.notify(.postpone);

上記のメソッドを呼び出さない場合、アプリがフォアグラウンドに releaseAvailableWithDetails:入るたびに -method が繰り返されます。

3. 更新プログラムが見つからない場合はコードを実行する

SDK が更新プログラムを確認し、現在使用されている更新プログラムよりも新しい更新プログラムが見つからない場合は、 distributeNoReleaseAvailable: デリゲートコールバックから MSACDistributeDelegate が呼び出されます。 これにより、このようなシナリオでカスタム コードを実行できます。

更新プログラムが見つからないときにアラート UI を表示する方法を示す例を次に示します。

- (void)distributeNoReleaseAvailable:(MSACDistribute *)distribute {
  UIAlertController *alert = [UIAlertController alertControllerWithTitle:nil
                                                                 message:NSLocalizedString(@"No updates available", nil)
                                                          preferredStyle:UIAlertControllerStyleAlert];
  [alert addAction:[UIAlertAction actionWithTitle:NSLocalizedString(@"OK", nil) style:UIAlertActionStyleDefault handler:nil]];
  [self.window.rootViewController presentViewController:alert animated:YES completion:nil];
}

  func distributeNoReleaseAvailable(_ distribute: Distribute) {
    let alert = UIAlertController(title: nil, message: "No updates available", preferredStyle: .alert)
    alert.addAction(UIAlertAction(title: "OK", style: .default, handler: nil))
    self.window?.rootViewController?.present(alert, animated: true)
  }

実行時に App Center の配布を有効または無効にする

実行時に App Center の配布を有効または無効にすることができます。 無効にした場合、SDK はアプリ内更新機能を提供しませんが、App Center ポータルで引き続き配布サービスを使用できます。

[MSACDistribute setEnabled:NO];

Distribute.enabled = false

App Center Distribute を再度有効にするには、同じ API を使用しますが、パラメーターとして を渡します YES/true 。

[MSACDistribute setEnabled:YES];

Distribute.enabled = true

状態は、アプリケーションの起動間でデバイスのストレージに保持されます。

注意

このメソッドは、開始後 Distribute にのみ使用する必要があります。

App Center の配布が有効になっているかどうかを確認する

App Center の配布が有効になっているかどうかをチェックすることもできます。

BOOL enabled = [MSACDistribute isEnabled];

var enabled = Distribute.enabled

注意

このメソッドは、開始後 Distribute にのみ使用する必要があり、常に開始前に戻ります false 。

開発中に App Center Distribute を初期化しない

プライベート モードの場合、アプリケーションの開始時に App Center Distribute によって UI/ブラウザーが開きます。 これはエンド ユーザーにとって想定される動作ですが、アプリケーションの開発段階では混乱を招く可能性があります。 構成の初期化DistributeDEBUGはお勧めしません。

#if DEBUG
    [MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class], [MSACCrashes class]]];
#else
    [MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class], [MSACCrashes class], [MSACDistribute class]]];
#endif

#if DEBUG
    AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self, Crashes.self])
#else
    AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self, Crashes.self, Distribute.self])
#endif

更新のためにアプリケーションを閉じる直前にクリーンを実行する

プロトコルを DistributeDelegate 実装し、次の例に示すようにデリゲートを登録します。

[MSACDistribute setDelegate:self];

Distribute.delegate = self;

distributeWillExitApp:デリゲート メソッドは、更新プログラムのインストールでアプリが終了する直前に呼び出されます。

- (void)distributeWillExitApp:(MSACDistribute *)distribute {
  // Perform the required clean up here.
}

func distributeWillExitApp(_ distribute: Distribute) {
  // Perform the required clean up here.
}

アプリ内更新はどのように機能しますか?

注意

アプリ内の更新プログラムを機能させるには、アプリ ビルドをリンクからダウンロードする必要があります。 IDE からインストールされている場合、または手動でインストールされている場合は機能しません。

アプリ内更新機能は次のように機能します。

  1. この機能は、 App Center Distribute サービスを使用して配布されるビルドでのみ機能します。 デバッガーがアタッチされている場合、または iOS ガイド付きアクセス機能が有効になっている場合は機能しません。

  2. SDK を統合し、アプリのリリース バージョンをビルドして App Center にアップロードすると、その配布グループ内のユーザーにメールで新しいリリースの通知が送信されます。

  3. 各ユーザーがメールでリンクを開くと、アプリケーションがデバイスにインストールされます。 電子メール リンクを使用してアプリをインストールすることが重要です。App Center Distribute では、他のソースからインストールされたアプリのアプリ内更新プログラム (電子メールの添付ファイルからアプリをダウンロードするなど) はサポートされていません。 アプリケーションがリンクからダウンロードされると、SDK は Cookie から更新のために重要な情報をチェックに保存します。それ以外の場合、SDK にはそのキー情報がありません。

  4. アプリケーションによってトラックがプライベートに設定されている場合、ブラウザーが開き、ユーザーを認証し、アプリ内更新を有効にします。 パブリック トラックに切り替えても認証情報が有効なままで、後でもう一度プライベートに戻る場合でも、ブラウザーは再び開きません。 ブラウザー認証が成功すると、ユーザーは自動的にアプリケーションにリダイレクトされます。 トラックがパブリック (既定値) の場合は、次の手順が直接実行されます。

    • iOS 9 と 10 では、 の SFSafariViewController インスタンスがアプリ内で開き、ユーザーを認証します。 認証が成功すると、自動的に閉じます。
    • iOS 11 では、ユーザー エクスペリエンスは iOS 9 と 10 に似ていますが、iOS 11 はログイン情報にアクセスするためのアクセス許可をユーザーに求めます。 これはシステム レベルのダイアログであり、カスタマイズすることはできません。 ユーザーがダイアログをキャンセルした場合、テストしているバージョンを引き続き使用できますが、アプリ内更新プログラムは取得されません。 次回アプリを起動すると、ログイン情報に再度アクセスするように求められます。

  5. アプリの新しいリリースでは、アプリ内更新ダイアログが表示され、次の場合にアプリケーションを更新するようユーザーに求められます。

    • または の値が CFBundleShortVersionString 大きい
    • の値 CFBundleShortVersionString が 等しいが、 の CFBundleVersion値が大きい。
    • バージョンは同じですが、ビルドの一意識別子は異なります。

ヒント

同じ ipa を 2 回目にアップロードした場合、バイナリが同一の場合、ダイアログは表示 されません 。 同じバージョン プロパティを持つ 新しい ビルドをアップロードすると、更新ダイアログが表示されます。 その理由は、 別 のバイナリであるためです。

操作方法アプリ内更新プログラムをテストしますか?

リリース ビルド (App Center SDK の配布モジュールを使用) を App Center Portal にアップロードしてアプリ内更新プログラムをテストし、毎回バージョン番号を増やす必要があります。

  1. まだ作成していない場合は、App Center ポータルでアプリを作成します。
  2. 新しい配布グループを作成し、アプリ内更新機能をテストするための配布グループを認識できるように名前を付けます。
  3. 自分自身 (またはアプリ内更新機能のテストに含めるすべてのユーザー) を追加します。 これには、App Center でそのアプリに使用されなかった新しいメール アドレスまたは捨てメール アドレスを使用します。 これにより、実際のテスト担当者のエクスペリエンスに近いエクスペリエンスが保証されます。
  4. App Center Distribute を含み、以下で説明するようにセットアップ ロジックを含むアプリの新しいビルドを作成します。 グループがプライベートの場合は、 updateTrack プロパティの使用を開始する前に、アプリ内のプライベート更新トラックを設定することを忘れないでください。
  5. ポータルで [ 新しいリリースの配布 ] ボタンをクリックし、アプリのビルドをアップロードします。
  6. アップロードが完了したら、[次へ] をクリックし、そのアプリ配布の [宛先] として作成した配布グループを選択します。
  7. [配布] を確認し、アプリ内テスト グループにビルドを配布します。
  8. そのグループのPeopleは、アプリのテスト担当者への招待を受け取ります。 招待を承諾すると、モバイル デバイスから App Center ポータルからアプリをダウンロードできます。 アプリ内更新プログラムがインストールされたら、アプリ内更新プログラムをテストする準備が整います。
  9. アプリのバージョン名 (CFBundleShortVersionString) を更新します。
  10. アプリのリリース バージョンをビルドし、前の手順で行ったようにアプリの新しいビルドをアップロードし、前に作成した 配布グループに配布 します。 配布グループのメンバーは、次回アプリを起動すると、新しいバージョンの入力を求められます。

ヒント

配布グループなどに関する詳細な情報については、App Center の配布を利用する方法に関する情報をご覧ください。App Center Distribute を使用して、コードを追加せずに新しいバージョンのアプリを配布することは可能ですが、アプリのコードに App Center Distribute を追加すると、テスト担当者とユーザーがアプリ内更新エクスペリエンスを取得する際によりシームレスなエクスペリエンスが得られます。

App Center サービスへのアプリケーション デリゲートのメソッド呼び出しの転送を無効にする

App Center SDK では、swizzling を使用して、アプリケーション デリゲートのメソッド呼び出しの一部を転送することで統合を改善します。 メソッド のスウィズリングは、実行時にメソッドの実装を変更する方法です。 何らかの理由で (たとえば、特定のポリシーのために) スウィズリングを使用しない場合は、次の手順に従って、すべての App Center サービスに対してこの転送を無効にすることができます。

  1. プロジェクトの Info.plist ファイルを開きます。
  2. キーを追加 AppCenterAppDelegateForwarderEnabled し、値を に 0設定します。 これにより、すべての App Center サービスのアプリケーション デリゲート転送が無効になります。
  3. プロジェクトAppDelegateのopenURLファイルにコールバックを追加します。
- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
  sourceApplication:(NSString *)sourceApplication
         annotation:(id)annotation {

  // Pass the url to MSACDistribute.
  return [MSACDistribute openURL:url];
}

func application(_ application: UIApplication, open url: URL, sourceApplication: String?, annotation: Any) -> Bool {

  // Pass the URL to App Center Distribute.
  return Distribute.open(url)
}