読者です 読者をやめる 読者になる 読者になる

古事連記帖

趣味のこと、技術的なこと、適当につらつら書きます。

Visual Studio Team Services からストアに自動申請する

C# Windows 10 プログラミング

Visual Studio Team Services (VSTS) には、プロジェクトの自動ビルドの他に、特定のサービスへのデプロイメントもすることができます。その中でも注目なのは Windows ストアへの自動申請ができることだと思います。ドキュメントを見ていたら、いつのまにか Submission API が用意されていたようです。

msdn.microsoft.com

この記事にあるように、エンドポイントが用意されていて、必ずしも VSTS を利用するということではなく、例えば Jenkins などのサービスを使っても同じことが出来るようになるわけです。
今すぐに利用可能というわけではなく、ちょっと準備が必要だったりします。

今回は UWP アプリケーションの申請をメインに話を進めます。

準備しておくもの

  • 開発者アカウントが必要です。
  • 一度デベロッパーセンターで申請するアプリを追加して下さい。そこで得られるアプリケーションの情報を使用します。
  • Package Flight を利用する場合、まず本申請を通して下さい。本申請したアプリは非公開にする手もあります。
  • Package Flight を利用する場合、ダッシュボード上でパッケージフライトを追加してください。フライト名を使用します。

API の利用申請をする

上記記事の「Important」にあるとおり、原則的には、Developer アカウントすべてで API が使える状態になっている訳では無いので、まず申請が必要です。

This API can only be used for Windows Dev Center accounts that have been given permission to use the API. This permission is being enabled to developer accounts in stages, and not all accounts have this permission enabled at this time. To request earlier access, log on to the Dev Center dashboard, click Feedback at the bottom of the dashboard, select Submission API for the feedback area, and submit your request. You'll receive an email when this permission is enabled for your account.


デベロッパーセンターの右下にちょこっとある「フィードバック」をクリックしてください。

f:id:ChiiAyano:20160925223254p:plain

種類は何でも良いと思います。「当てはまる領域をお選び下さい」の部分は「申請 API」にします。フィードバックの内容は「API使わせて下さい」的なノリの英語を気合いで書きました。
これでOKです。利用可能になった時点でメールが来るはずです*1

Azure AD を取得しておく

申請が通るまでに準備だけしておきましょう。API の使用には Azure Active Directory (Azure AD) を準備しておく必要があります。

https://msdn.microsoft.com/ja-jp/windows/uwp/publish/manage-account-usersmsdn.microsoft.com

登録の仕方はだいたいこの記事に載っています。すみません、ここでは割愛します。登録が完了したら、「Azure AD アプリケーションの追加」をします。

f:id:ChiiAyano:20160925224334p:plain

名前は何でも良いと思います。実際のアプリの名前を入れるのが適当かと思います。
「応答URL」「アプリ ID URI」はひとまず有効な URL を適当に入れておきます*2
「役割」はとりあえず「マネージャー」にでもしておくと良いと思います。

ここでできあがった「テナント ID」「クライアント ID」は VSTS 側で必要となります。
「キー」も必要になります。「新しいキーの追加」をクリックして得られたキーはどこかにメモしておいて下さい。一度しか表示されず、もう一度取得するためには一度削除するか、もう一回キーを追加する必要があります。

VSTS 側の準備をする

実際に申請をする拡張機能をインストールします。実は Microsoft 公式で申請用の拡張機能が用意されています。

marketplace.visualstudio.com

これを利用するのも手ですが、本申請しか現時点では出来ないので、Package Flight 向けに利用したい場合は、今のところサードパーティ拡張機能を利用することになります。

marketplace.visualstudio.com

ただ、2016年9月25日現在、公式側も Package Flight へ申請できるようにするアップデートを予定しているので、待ってみるのも手かもしれません。

github.com

今回は後者の Windows Store Automation を利用して進めます。

インストールしたら、VSTS のプロジェクトから設定を選び、「Services」を選びます。
「New Service Endpoint」を選んだら、「Windows Dev Center」を選択して下さい。

f:id:ChiiAyano:20160925225459p:plain

「Connection Name」はわかりやすい名前をつけます。
「Tenant Id」は先ほどの「テナント ID」を入力します。
「Client Id」は「クライアント ID」を入力します。
API Token」はメモしておいた「キー」を入力します。

ビルド環境を整える

ここで、あらかじめ Visual Studio 側でプロジェクトのストアとの関連づけを進めておき、生成した証明書をリポジトリに含めておいてください。申請パッケージを生成するために必要です。

UWP アプリのパッケージ化


設定から離れ、ビルドの準備が出来ていないようであれば「Build Definitions」に移動します。
「New」をクリックし、テンプレートは UWP であれば「Universal Windows Platform」を選んで下さい。
「Repository」は通常であれば既に選ばれているものを、「Default branch」はビルド対象にしたいブランチ名を選んで下さい。
「Default agent queue」は通常「Hosted」を選ぶと良いでしょう。自前で Agent を生成している場合はそちらを選択することが出来ます。

いろいろとビルドステップが準備されます。
僕の環境ではステップをこのようにしておきました。

f:id:ChiiAyano:20160925230528p:plain

まず「Delete files」でビルド生成物を一度全部削除します。ビルドが積み重なるごとに、前に生成したバイナリまで生成物として含まれてしまうので、このような形にしました。「Source Folder」は「$(Build.BinariesDirectory)」、「Contents」は「*」にしています。
「Update Appx Version」でビルド番号を自動インクリメントしています。「Manifest File」でアプリの appxmanifest を入れ、「Build Id」は「$(BuildId.BuildId)」にしておきます。こうすることで、「1.0.100.0」といったバージョン番号の「100」の部分が自動で置き換わるようになります。
「NuGet Installer」は「Path to solution or packages.config」をソリューションファイルに変更するだけでOKです。
Visual Studio Build」は、「MSBuild Arguments」が既定ではストア申請用のパッケージを生成しないので、「/p:UapAppxPackageBuildMode=StoreUpload」を追記してください。「Configuration」に「$(BuildConfiguration)」を追加しておけば、あとはOKです。必要に応じてパラメーターを設定して下さい。

https://msdn.microsoft.com/en-us/library/ms164311.aspxmsdn.microsoft.com

「Index Sources & Publish Symbols」はそのままでOKです。
「Publish Build Artifacts」は「Path to Publish」を「$(Build.BinariesDirectory)\AppxPackages」にしておけばOKです。

これでビルド環境は整いました。一度ビルドしておくと、この後が楽です。

リリースの準備をする

「Releases」に移動します。
「Create Release Definition」を選択し、テンプレートがいくつか表示されますが「Empty」を選択します。

「Add tasks」をクリックして、「Publish to Windows Store」を「Add」してください。「Close」してポップアップを閉じます。
「Service Endpoint」を、さきほど設定で準備したものにします。プルダウンを開くと、おそらくひとつだけ出てくると思うのでそれです。
「App Id」は申請するアプリケーションの ID です。デベロッパーセンターのダッシュボードから「アプリ管理」->「アプリ ID」に切り替え、「ストア ID」を入力します。
「Flight Name」は本申請の場合は不要です。Package Flight で使用する場合は、その名前を入力します。
「Appxupload」はビルド時に生成した「.appxupload」のパスを設定してください。パス名には「* (アスタリスク)」が使用できます。

これでリリース環境は整いました。

申請を投げてみる

とりあえず申請を投げてみましょう。「Releases」で生成した定義を選び、「Release」から「Create Release」を選びます。
表示されたポップアップで「Artifacts」にある赤いドロップダウンを選択して、申請したいビルドを選び、「Create」をクリックして下さい。これで申請が始まります。
申請中のタスクを開き、「Logs」を選ぶと、現在の進捗を見ることが出来ます。

こんな感じです。API 利用申請をしたばかりですとたぶん 「error: {"code":"Unauthorized","message":"Authorization: Account is not allowed to access this api"}」と言われて失敗すると思います。


これでうまくいけば、あとは良い感じにしていきましょう。ビルド完了後自動的に申請を投げることも出来るようになります。

*1:僕の場合メール来ませんでしたが、申請後10日ほどした時ふと試したら使えるようになっていました

*2:僕はひとまず自分のサイト URL にしました。たぶん大丈夫だと思います