tvOS の概要
重要
Visual Studio App Center は、2025 年 3 月 31 日に廃止される予定です。 完全に廃止されるまで Visual Studio App Center を引き続き使用できますが、移行を検討できる推奨される代替手段がいくつかあります。
App Center SDK ではモジュールアーキテクチャが使用されるため、サービスの一部またはすべてを使用できます。
App Center Analytics と App Center のクラッシュを使用するようにアプリで App Center tvOS SDK を設定し始めましょう。
1.前提条件
App Center SDK を使用するには、次の要件を満たす必要があります。
- tvOS は、tvOS バージョン 11 以降の Xcode 13 以降で設定されています。
- クラッシュ レポート機能を提供する他のライブラリは使用していません。
2. App Center ポータルでアプリを作成してアプリ シークレットを取得する
App Center ポータルでアプリを既に作成している場合は、この手順をスキップできます。
- appcenter.ms に向かいます。
- サインアップまたはログインし、ポータルの右上隅にある [ 新規 追加] という青いボタンをクリックし、ドロップダウン メニューから [ 新しいアプリの追加 ] を選択します。
- アプリの名前と説明 (省略可能) を入力します。
- OS として tvOS を選択し、プラットフォームとして Objective-C/Swift を選択します。
- 右下にある [ 新しいアプリの追加] というボタンをクリックします。
アプリを作成したら、App Center ポータルの [設定] ページでアプリ シークレットを取得できます。 [設定] ページの右上隅にある 3 つの垂直ドットをクリックし、[アプリ シークレット] を選択Copy app secret
して取得します。
3. App Center SDK モジュールを追加する
App Center SDK for tvOS は、 Cocoapods、 Carthage、 Swift Package Manager を使用するか、バイナリをプロジェクトに手動で追加してアプリに統合できます。
注意
App Center の 4.0.0
バージョンでは、破壊的変更が導入されました。 App Center SDK 4.0.0 以降への移行に関するセクションに従って、App Center を以前のバージョンから移行します。
3.1 Cocoapods による統合
次の依存関係を に追加して
podfile
、App Center Analytics と App Center のクラッシュをアプリに含めます。 これにより、AppCenter、AppCenterAnalytics、AppCenterCrashes のフレームワークが取り込まれます。 代わりに、アプリで使用するサービスを指定できます。 各サービスには独自の subspec があり、それらはすべて に依存しますAppCenter
。 自動的にプルされます。# Use the following line to use App Center Analytics and Crashes. pod 'AppCenter' # Use the following lines if you want to specify which service you want to use. pod 'AppCenter/Analytics' pod 'AppCenter/Crashes'
を実行
pod install
して新しく定義したポッドをインストールし、プロジェクトの.xcworkspace
を開きます。
アプリケーションにフレームワークを統合したので、次は SDK を開始し、App Center サービスを利用します。
3.2 カルタゴ経由の統合
依存関係を構築し、バイナリ フレームワークを提供する分散型依存関係マネージャーである Carthage バージョン 0.30 以降を使用して、Xcode プロジェクトに App Center SDK を統合する手順を次に示します。
次の依存関係を に追加して
Cartfile
、App Center Analytics と App Center のクラッシュをアプリに含めます。# 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
carthage update --platform tvOS
を実行します。 これにより、 Carthage/Checkouts フォルダーに依存関係がフェッチされ、各フレームワークがビルドされます。アプリケーション ターゲットの [全般設定] タブ を 開きます。 AppCenter.framework、 AppCenterAnalytics.framework、 AppCenterCrashes.framework ファイルを Carthage/Build/tvOS フォルダーから Xcode の Project Navigator にドラッグ アンド ドロップします。 SDK を起動するには、 AppCenter.framework が必要です。 プロジェクトに追加されていない場合、他のモジュールは機能せず、アプリはコンパイルされません。
ダイアログが表示され、アプリターゲットがオンになっていることを確認します。 [完了] をクリックします。
Note
ビルド フェーズで を使用
carthage copy-frameworks
する場合は、静的フレームワークとして出荷されるため、そこに App Center SDK を追加しないでください。
アプリケーションにフレームワークを統合したので、次は SDK を開始し、App Center サービスを利用します。
3.3 Swift パッケージ マネージャーによる統合
- [Xcode] メニューの [ ファイル] > [Swift Packages] [パッケージ > の依存関係の追加] の順にクリックします。
- 表示されるダイアログで、リポジトリの URL を入力します。 https://github.com/microsoft/appcenter-sdk-apple.git
- [ バージョン] で、[ 次のメジャーまで ] を選択し、既定のオプションを選択します。
- [ パッケージ製品 ] 列で必要なモジュールを選択します。
アプリケーションにフレームワークを統合したので、次は SDK を開始し、App Center サービスを利用します。
注意
SwiftPM 経由で App Center を統合していて、アプリの拡張機能ターゲットでもそれを使用する場合は、必ず構成で指定 DISABLE_DIAMOND_PROBLEM_DIAGNOSTIC=YES
してください。 これは、モジュールを複数のターゲットにリンクする際の SwiftPM 制限を回避するために必要です。
3.4 バイナリをプロジェクトにコピーして統合する
コンパイル済みのバイナリを Xcode プロジェクトに統合して、tvOS アプリの App Center Analytics と App Center のクラッシュを設定する手順を次に示します。
注意
App Center SDK では、 の使用 XCframework
がサポートされています。 XCframeworks をプロジェクトに統合する場合は、リリース ページから AppCenter-SDK-Apple-XCFramework.zip をダウンロードして解凍します。 結果のフォルダーの内容はプラットフォーム固有ではなく、モジュールごとに XCframeworks が含まれます。 これらは、以下に説明するように、通常のフレームワークと同じ方法で統合できます。
zip ファイルとして提供されている App Center SDK フレームワークをダウンロードします。
ファイルを解凍すると、 AppCenter-SDK-Apple という名前のフォルダーが表示されます。このフォルダーには、各プラットフォーム フォルダーの App Center サービスごとに異なるフレームワークが含まれています。 呼び出される
AppCenter
フレームワークは、異なるモジュール間で共有されるコードが含まれているので、プロジェクトで必要です。[省略可能]サード パーティ製ライブラリのサブディレクトリを作成します。
- ベスト プラクティスとして、サード パーティ製ライブラリは通常、サブディレクトリ内に存在するため (多くの場合、 Vendor と呼ばれます)、プロジェクトをライブラリのサブディレクトリで整理していない場合は、ここで Vendor サブディレクトリを作成します。
- Xcode プロジェクト内に Vendor というグループを作成して、ディスク上のファイル構造を模倣します。
Finder で解凍した AppCenter-SDK-Apple フォルダーを開き、目的の場所にあるプロジェクトのフォルダーにフォルダーをコピーします。 フォルダーには、App Center SDK でサポートされている他のプラットフォームのサブフォルダーにフレームワークが含まれているため、不要なサブフォルダーを削除する必要がある場合があります。
Xcode のプロジェクトに SDK フレームワークを追加します。
- [プロジェクト ナビゲーター] が表示されていることを確認します (⌘+1)。
- ここで、 AppCenter.framework、 AppCenterAnalytics.framework、 AppCenterCrashes.framework を Finder ( Vendor フォルダー内のもの) から Xcode のプロジェクト ナビゲーターにドラッグ アンド ドロップします。 SDK を起動するには AppCenter.framework が必要です。プロジェクトに追加されていることを確認してください。そうしないと、他のモジュールは機能せず、アプリはコンパイルされません。
- ダイアログが表示され、アプリターゲットがオンになっていることを確認します。 [完了] をクリックします。
Note
SDK バイナリは、tvOS フレームワーク規則に従ってパッケージ化されません。 その理由は、App Center SDK for tvOS は従来のフレームワークではなく、静的なフレームワークであるためです。 静的フレームワークとしてリンクする必要があります。バイナリを埋め込まず、"バンドル リソースのコピー" ビルド フェーズに含めないでください。
アプリケーションにフレームワークを統合したので、次は SDK を開始し、App Center サービスを利用します。
4. SDK を起動する
App Center を使用するには、使用するモジュールをオプトインする必要があります。 既定では、モジュールは開始されません。SDK の起動時に各モジュールを明示的に呼び出す必要があります。
4.1 import ステートメントを追加する
プロジェクトの AppDelegate ファイルを開き、次の import ステートメントを追加します。
@import AppCenter;
@import AppCenterAnalytics;
@import AppCenterCrashes;
import AppCenter
import AppCenterAnalytics
import AppCenterCrashes
4.2 メソッドを追加するstart:withServices:
アプリのデリゲート メソッドに次の行を didFinishLaunchingWithOptions
挿入します。
[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class], [MSACCrashes class]]];
AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self, Crashes.self])
警告
ソース コードにアプリ シークレットを埋め込むことはお勧めしません。
App Center サービスを個別に開始する必要がある場合は、次の手順を実行する必要があります。
- アプリ シークレットを構成または開始します。
- コードを複数回呼び出すことができる場合は、App Center が既に構成されているかどうかをチェックします。
- アプリ シークレットを使用せずに、必要なサービスを開始します。
[MSACAppCenter configureWithAppSecret:@"{Your App Secret}"];
if ([MSACAppCenter isConfigured]) {
[MSACAppCenter startService:[MSACAnalytics class]];
[MSACAppCenter startService:[MSACCrashes class]];
}
AppCenter.configure(withAppSecret: "{Your App Secret}")
if AppCenter.isConfigured {
AppCenter.startService(Analytics.self)
AppCenter.startService(Crashes.self)
}
4.3 プレースホルダーをアプリ シークレットに置き換える
テキストは、必ずアプリケーションの実際の値に置き換えてください {Your App Secret}
。 アプリ シークレットは、App Center ポータルの [はじめに] ページまたは [設定] ページにあります。
[はじめに] ページには、上記のコード サンプルとアプリ シークレットが含まれています。サンプル全体をコピーして貼り付けることができます。
上記の例では、 (start(withAppSecret:services:)
Swift の場合) メソッドをstart:withServices
使用し、App Center Analytics と App Center のクラッシュの両方を含める方法を示しています。
2 つのサービスのいずれかを使用しない場合は、上記のメソッド呼び出しから対応するパラメーターを削除します。
start メソッドで各モジュールをパラメーターとして指定しない限り、その App Center サービスを使用することはできません。 また、 start:withServices
(start(withAppSecret:services:)
Swift の場合) API は、アプリのライフサイクルで 1 回だけ使用できます。他のすべての呼び出しでは、コンソールに警告が記録され、最初の呼び出しに含まれるモジュールのみが使用できるようになります。
たとえば、 - App Center Analytics にオンボードする場合は、次のように (start(withAppSecret:services:)
swift の場合) API 呼び出しを変更start:withServices
する必要があります。
[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class]]];
AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self])
これで、SDK によって自動的に収集される分析データとクラッシュ データをポータルで視覚化するように設定されています。
両方のサービスのより高度な機能をカスタマイズして使用する方法については、 App Center Analytics と App Center のクラッシュ に関するドキュメントを参照してください。