App Store Connect APIを利用した開発プロセスの自動化

こんにちは App Store Connectチームの エンジニア Dajinsol Jeonです 本日は App Store Connect APIの アップデートについて紹介します では始めましょう

App Store Connectは 開発プロセスを 自動化するAPIを 多数提供しています 自動化によって開発チームは より重要なタスクに注力でき 結果として 素晴らしい新機能を ユーザーに提供できます 今年 App Store ConnectのAPIは アプリの管理やTestFlightなど 重要な分野に 大々的に拡張されました さらに App Store Connectは現在 登場が待たれていたWebhooks APIや Apple-Hosted Background Assets API などの新しいAPIセットに対応しています 本日は Webhooks、BuildUpload、 Feedback APIなど 長いこと待ち望まれていた 重要なアップデートを紹介します まずは 一般的なアプリ開発 プロセスを 簡単におさらいします アプリ開発とは 繰り返しの多い作業です 新機能やバグの修正でも 新しいビルドの App Store Connectへの アップロードでも その点は同じです 新しいビルドの配布後は ベータ版の テスターがフィードバックを提出して 次の開発フェーズでは 前回のビルドからのフィードバックが 反映されることになります このサイクルを できる限り 速やかに行うことが肝心です たとえば ユーザーから クラッシュの報告があった場合 ユーザー体験を向上させるためにも できるだけ迅速に修正したいでしょう 本日ご紹介するのは まさに この点に役立つアップデートです 新しいApp Store Connect APIは このループを自動化して 反復作業を 大幅にスピードアップさせます その仕組みを説明します 今年 App Store Connectは 自動化への対応強化に向け Build upload APIと Feedback APIを導入しました さらに App Store Connectは Webhookによる通知に対応します アプリで何かイベントが発生すると システムに通知があるので 漏れなく対応できます たとえば App Store Connectは ビルドのアップロード処理が完了すると Build Upload State イベントを Webhookリスナーに送信します 次のステップに進んでよいという 信号を送ります Webhookによる通知は 他にも Feedbackイベントや Build Beta Stateイベント などにも対応しており アプリに関する重要なイベントを デベロッパに通知します サポート対象が追加されたことで 開発サイクルを さらに加速できます 今回の機能強化について 詳しくご紹介します 最初は Webhookによる通知です 従来型のAPIは 「ニュースはないか」と 常に聞きまわるような 挙動をしていました システムはApp Store Connectの 更新情報を 要求し続ける必要がありました Webhookは状況を一変させます Webhookとは基本的に サーバ間のプッシュ通信です システムに常に状況確認させる代わりに App Store Connectが イベントに関する通知を送信します 技術的に言うと App Store Connectからサーバに宛てた HTTPコールバックであり アプリに関連する特定のイベントが 発生したときに実行されます

これにより イベント駆動型の ワークフローを構築できます 常時App Store Connectに アップデートについてポーリング させるよりも はるかに効率的です どんな仕組みなのでしょう？

HTTPサーバがあると仮定すると これがWebhookリスナーになります まず App Store Connectに WebhookリスナーのURLを提供します つまりApp Store Connectに 更新情報の送信先を指示します 次に App Store Connect内で 関連する変更が発生するたびに 登録したURLに POSTリクエストを送信します リクエストペイロードには イベントに関する情報が含まれます システムはペイロードに基づいて App Store Connect APIにクエリして 追加情報を求めたり 必要なアクションを実行できます 今年 App Store Connectは 新しいTestFlightフィードバックの提出、 アプリのバージョンステータス変更、 Build Upload Stateの変更、 Build Beta Stateの変更、 AppleがホストするBackground Asset State変更など 重要なイベントに関する Webhook通知機能を導入しました App Store Connectから これらの通知を受信するには まずWebhookリスナーを 登録する必要があります App Store Connectの WebサイトでWebhookリスナーを 登録する方法を紹介します まず セクションを表示します 次に を選択します セクションのサイドバーに セクションがあります ボタンをクリックします これで Webhookの 詳細設定用パネルが開きます まず Webhookに わかりやすい名前を付けます 次に Webhookリスナーの URLを入力します これが App Store Connectの 通知送信先である エンドポイントになります 「Secret」という重要なフィールドに 注目しましょう App Store Connectは この秘密鍵で 各Webhook通知に署名します 任意の文字列を使用できます App Store Connectと自分以外には 知られないようにしましょう システムはこの署名により 通知の発信元が実際に Appleであるか確認できます

最後に 登録するイベントを 選択する必要があります 本日のセッションでは Build Upload、Build Beta State、 TestFlightフィードバックの イベントを有効にします をクリックします 完了です これで 登録したイベントの発生時は サーバがいつでもWebhook通知を 受信できるようになりました APIを使用して Webhookを 設定することもできます アプリを多数管理している場合や 新しいアプリ用に Webhookリスナーを 自動で登録したい場合に この方法はとても便利です APIを使ったWebhookリスナーの 登録方法を紹介します APIを使ってWebhookリスナーを 登録するには POSTリクエストを Webhookエンドポイントに送信します 属性はUIで見たものと 非常によく似ています 購読にあたって 送信が必要になるのは イベントのタイプと イベントペイロード署名時にApp Store Connectが使用する秘密鍵と WebhookリスナーのURLです Webhookがうまく作成できると 「201 CREATED」という応答があります ペイロードには 後でWebhookの 管理に必要となる Webhook IDが含まれます 以上が Webhook通知の紹介と App Store Connectを使用した Webhookリスナーの 登録方法です ここからは APIを使用して App Store Connectへの 新しいビルドのアップロードを 自動化します 本日紹介する 主な機能強化の一つが App Store Connect APIによる BuildUploadsの自動化です Build upload APIの利点は何か？ この新しいAPIは 標準化された App Store Connect APIの一部で 既存の自動化パートに ビルドアップロードを追加できます つまり お好みの言語や プラットフォームを使用して ビルドをアップロードできます アップロード時に問題が発生しても 新しいAPIが エラー処理に役立つ 定型メッセージを提供します ビルドアップロードプロセスを自動化する より柔軟な新しい方法です その仕組みをご紹介しましょう ビルドアップロードは新しいAPIで BuildUploadを最初に作成します BuildUploadsに格納されるのは バージョンなどのビルド情報です

次に ビルドファイルの詳細を BuildUploadFilesを使用して App Store Connectに提供します App Store Connectは ビルドアップロード手順を提供します

次に 手順に従って ビルドバイナリをアップロードします 最後のステップでアップロードの完了を App Store Connectに通知すれは 新しいビルドの処理を開始できます APIの詳細について ひと通り説明します BuildUploadを作成するには POSTリクエストを行います このリクエストには ビルドの バンドルバージョンと ターゲットプラットフォームが必要です リクエストが成功すると App Store Connectは 「201 CREATED」ステータスに 新しいBuildUploadの 一意のIDを添えて応答します 次のステップでは ファイルの詳細を App Store Connectに伝える BuildUploadFileを作成します ファイル名、バイト単位のサイズ、 アセットタイプを含める必要があります BuildUploadFileが正常に 作成できると 「201 CREATED」という応答があります 応答本文内にはアップロード操作が 記載してあります バイナリの正確なアップロード方法が 書かれています ビルドの送信先URLや PUTメソッドを使用して 必要なヘッダをリストするよう ここで指示されます ファイルアップロード用の 他の App Store Connect APIと同様に ビルドが大きい場合は 複数のチャンクでアップロードするよう 複数の指示が届くことがあります その場合は 分割したバイナリの数だけ HTTP呼び出しを 行う必要があります 先に受け取った応答に 記載されていた指示に従って ビルドをアップロードした後は アップロードが実際に完了したことを App Store Connectに伝えます このステップで 新しいビルドの処理開始を App Store Connectに指示します このとき uploadedプロパティ「true」で PATCHリクエストを送信します

成功すると 「COMPLETE」状態の 「200 OK」応答を受け取ります App Store Connect Webサイトを開いて 新しいビルドを見てみましょう App Store Connect Webサイトは 新しいビルドの処理開始を示しています ここで気になる点があります 終了時間はいつなのか？ それを知る方法は？ ここで 先ほど構成しておいた Webhook通知が 登場することになります 処理が完了した瞬間に 通知を送ります ビルドの処理が正常に終了した時点で App Store Connectから サーバが受信する 通知内容の例を紹介します 主な変化は「PROCESSING」から 「COMPLETE」への 状態遷移です 「COMPLETE」ステータスが表示されたら ビルドが処理されたという 確認が得られ 次のステップに進む 準備が整います X-Apple-SIGNATUREヘッダには メッセージの署名が表示されます これは HMAC-SHA256アルゴリズムを 使用していることを示しています 署名は 設定しておいた秘密鍵と 受信したペイロード本文を使用して 計算することができます 計算した値と ヘッダの値を比較して App Store Connectからの 通知であることを確認します

これが 新しいAPIでビルドアップロード プロセスを自動化する仕組みです TestFlightを使用した ベータ版テストに移りましょう App Store Connectでの ビルドの処理が完了したら TestFlightを使用して アプリを ベータ版テスターに配布できます 特定のベータ版テスターグループに ビルドを直接割り当てることができます 外部テスターの場合は 先に Beta App Reviewに ビルドを提出する必要があります 最後に 新しいビルドが利用可能であると テスターに通知します ここで吉報です これらのステップは TestFlight APIを使って すべて自動化できます これらは App Store Connectが提供する TestFlight APIの機能の一部です より包括的な情報を知りたい方は App Store Connect APIの ドキュメントをご覧ください ここでお伝えしたい重要なポイントは ご紹介したAPIによって テスターへのビルド配布を 完全に自動化できるという点です これらのAPIは十分よく出来ていますが 今年は便利な新機能 Build Beta State Webhookイベントを 紹介したいと思います この新しいWebhookは TestFlightベータ版レビューの完了後 すぐに通知するよう設計されています Build Beta State通知の ペイロードの例を紹介します ペイロードは更新された状態を示し 特定のビルドIDが含まれています この通知を受け取ると ビルドが審査を通過し 外部テストの準備が 整ったことがわかります 以上が TestFlightを使用して 新しいビルドを配布する方法です 次は テスターからTestFlight フィードバックを得る方法を紹介します フィードバックは TestFlightを使用する上で 肝となる部分です テスターは スクリーンショットを 提出して 提案やUI問題の報告や アプリクラッシュ発生時の クラッシュフィードバックを実行できます フィードバックは アプリの進化を促す インサイトの発見に役立ちます ユーザー体験を向上させるには フィードバックへの迅速な対応が重要です そのため 新しいフィードバック到着を すぐに把握できなくてはなりません テスターからのフィードバックを 見逃さないようにするには 開発ツールのフィードバック トラッキング機能が非常に便利です そのためApp Store Connectは 新しいFeedback APIを 対応するWebhookイベントと併せて 導入します 多くのデベロッパが この機能の登場を 待ち望んでいました 詳しく紹介します 新しいフィードバックがあると このようなペイロードを使用して Webhook通知が届きます Webhook通知には 最小限の情報が含まれています まずフィードバックタイプ この例ではスクリーンショットです そして関連インスタンスです インスタンスを見ると ベータ版フィードバックであることと IDが分かります このIDを使用して フィードバックの詳細を取得できます Feedback APIを呼び出して フィードバックを取得すると 送られてくる応答には デバイス情報や スクリーンショットURLなど さまざまな詳細が含まれています 取得したURLを使用して スクリーンショット画像を個別に呼び出し ダウンロードできます

クラッシュのフィードバック取得も スクリーンショットの場合とほぼ同じです ただし クラッシュログが利用可能なら crashLogエンドポイントを呼び出して プログラムでダウンロードできます 以上が APIを使ってTestFlight フィードバックを取得する方法です そして App Store Connect APIを使用して このアプリ開発プロセスを完了させ 完了させる方法と Webhook APIで イベント通知を取得し 新しいビルドをBuild upload APIで アップロードし Feedback APIで フィードバックを取得する方法を 紹介しました これだけではありません たとえば Appleがホストする バックグラウンドアセットを使用する場合 アセット管理を自動化するための 新しいAPIが利用可能になりました また App Store Connectは Webhookイベントを送信して App Storeでのアプリステータスの 変化について通知を行い 開発からテスト、リリースまでに至る プロセスを完了させます さらにApp Store Connectは 開発プロセスのさまざまなステージを 自動化するための 既存のAPIも多数提供します 繰り返しになりますが 日常のタスクを自動化することは よりよいユーザー体験に 注力するためにも 極めて重要です セッションを締めくくるにあたり お勧めの情報をお伝えします 1. Webhookリスナーを構築して App Store Connectから Webhook通知を 受け取れるようにすること 2. Webhookイベントに基づく リアクティブな動作を実装して プロセスを自動化します 3. App Store Connect APIが 提供する 他の機能もチェックして 自動化でAPIを駆使し 開発サイクルをさらに短縮します

「Discover Apple-Hosted Background Assets」と 「What’s new in App Store Connect」 セッションで App Store Connectの 最新エディションの詳細を 是非ご覧ください 今日の内容はここまでです このセッションがお役に立てば幸いです ご視聴ありがとうございました