6 月 3 日の「#Android11: The Beta Launch Show」にぜひご参加ください。

ライセンス機能追加のためのセットアップ

アプリにライセンス確認機能を追加するには、Google Play パブリッシャー アカウント、開発環境、(実装を検証するための)テスト アカウントを事前にセットアップしておく必要があります。

パブリッシャー アカウントのセットアップ

まだ Google Play のパブリッシャー アカウントがない場合は、Google アカウントを使用して登録し、Google Play の利用規約に同意する必要があります。

詳細については、公開のスタートガイドをご覧ください。

すでに Google Play のパブリッシャー アカウントがある場合は、Play Console を使用してライセンスのセットアップを行います。

Google Play Console を使用すると、次のことを行えます。

  • アプリ固有のライセンス用公開鍵の取得
  • アプリ公開前の、ライセンス機能実装のデバッグおよびテスト
  • ライセンス サポートを追加したアプリの公開

ライセンスの管理設定

Play Console では、Google Play ライセンスの管理機能のいくつかを管理できます。この機能を使用すると、次のことを行えます。

  • 複数の「テスト アカウント」(メールアドレスで識別される)のセットアップ。ライセンス サーバーを使用することで、ユーザーはデバイスやエミュレータのテスト アカウントにログインし、ライセンス チェックを送信して静的テスト応答を受信できます。アカウントのセットアップは、Play Console の [アカウントの詳細] ページで行えます。
  • サーバーから送られる静的テスト応答の設定。パブリッシャー アカウントやテスト アカウントにログインしたユーザーから、パブリッシャー アカウントにアップロードされたアプリのライセンス チェックを受信したときに、サーバーから送信される静的テスト応答を設定できます。テスト応答の設定は、Play Console の [アカウントの詳細] ページで行えます。
  • アプリのライセンス用公開鍵の取得。アプリにライセンス機能を実装する際には、アプリに公開鍵文字列をコピーする必要があります。アプリのライセンス用公開鍵は、[すべてのアプリ] の下の [サービスと API] ページで取得できます。

図 1. アプリのライセンス用鍵は Play Console の [サービスと API] ページで取得可能

テスト アカウントと静的テスト応答の使用方法の詳細については、下記のテスト環境のセットアップをご覧ください。

開発環境のセットアップ

ライセンス機能追加のための環境のセットアップでは、次の作業を行います。

  1. 開発用のランタイム環境のセットアップ
  2. SDK への LVL のダウンロード
  3. License Verification Library のセットアップ
  4. アプリへの LVL ライブラリ プロジェクトの追加

下記のセクションでは、これらのタスクについて説明します。セットアップが完了したら、アプリへのライセンス機能の追加を開始できます。

最初に、アプリに実装するライセンス チェックとライセンス適用の機能について実行、デバッグ、テストを行うための、適切なランタイム環境をセットアップする必要があります。

ランタイム環境のセットアップ

前述のとおり、アプリでのライセンス ステータスのチェックは、ライセンス サーバーに直接問い合わせるのではなく、Google Play アプリのサービスにバインドしてライセンス チェック リクエストを行うことから始まります。その後、Google Play 開発者サービスがライセンス サーバーと直接通信を行い、最終的に応答をアプリに返送します。アプリのライセンス機能のデバッグとテストを行うには、それに必要な Google Play サービスを含むランタイム環境をセットアップして、アプリからライセンス サーバーにライセンス チェック リクエストを送信できるようにする必要があります。

使用できるランタイム環境には、次の 2 種類があります。

  • Google Play アプリを備えた Android デバイス
  • Google API アドオン、API レベル 8(リリース 2)以上を実行する Android エミュレータ

デバイスを使用する場合

Android デバイスでライセンス機能のデバッグとテストを行うには、デバイスは次の条件を満たす必要があります。

  • Android 1.5 以降(API レベル 3 以上)プラットフォームと互換性のあるバージョンを搭載している。
  • Google Play クライアント アプリがプリインストールされたシステム イメージが実行されている。

Google Play がシステム イメージにプリインストールされていないと、アプリと Google Play ライセンス サーバーとの通信はできません。

Android アプリの開発に使用するデバイスのセットアップ方法については、ハードウェア デバイスの使用をご覧ください。

Android エミュレータを使用する場合

利用できるデバイスがない場合は、Android エミュレータを使用して、ライセンス機能のデバッグとテストを行えます。

Android SDK で提供される Android プラットフォームには Google Play が含まれていないため、SDK リポジトリから Google API アドオン プラットフォーム(API レベル 8 以上)をダウンロードする必要があります。Google API アドオンをダウンロードしたら、そのシステム イメージを使用する AVD 設定を作成する必要があります。

Google API アドオンには、完全な Google Play クライアントは含まれていません。ただし、次のものが提供されます。

  • ILicensingService リモート インターフェースを実装する Google Play バックグラウンド サービス。これにより、アプリからライセンス チェックをネットワーク経由でライセンス サーバーに送信することが可能になります。
  • 基本的なアカウント サービスのセット。これにより、AVD に Google アカウントを追加し、パブリッシャー アカウントまたはテスト アカウントの認証情報を使用してログインすることが可能になります。

    パブリッシャー アカウントまたはテスト アカウントを使用してログインすると、アプリを公開せずにデバッグとテストを行えます。詳細については、下記の承認済みアカウントへのログインをご覧ください。

SDK Manager から入手できる Google API アドオンのバージョンにはいくつかありますが、必要な Google Play サービスが含まれているのは Android 2.2 以降用のバージョンのみです。

アプリにライセンス機能を追加するためのエミュレータのセットアップ方法は次のとおりです。

  1. Android Studio の [Tools] メニュー([Tools] > [Android] > [SDK Manager])から、または <sdk>/tools/android sdk を実行して、Android SDK Manager を起動します。
  2. ターゲットにする Android バージョン(Android 2.2 以降にする必要あり)の Google API を選択してダウンロードします。
  3. ダウンロードが完了したら、Android Studio の [Tools] メニュー([Tools] > [Android] > [AVD Manager])から、または <sdk>/tools/android avd を実行して、AVD Manager を開きます。
  4. [Android Virtual Device Manager] ウィンドウで [+ Create Virtual Device] を選択して、新しい AVD の詳細構成を設定します。
  5. [Virtual Device Configuration] ウィンドウでデバイスのハードウェアを選択し、[Next] を選択します。
  6. 新しい AVD で実行するシステム イメージとして [Google API] を選択し、[Next] を選択します。
  7. AVD にわかりやすい名前を付け、必要に応じてその他の詳細構成を設定します。
  8. [Finish] を選択すると、新しい AVD 設定が作成され、利用可能な Android Virtual Device のリストに表示されます。

AVD やその使い方について詳しくは、仮想デバイスの管理をご覧ください。

プロジェクト設定の更新

上記の要件を満たすランタイム環境を(実際のデバイスまたはエミュレータで)セットアップしたら、ライセンス機能を使用するコンパイル済みの .apk ファイルがその環境に確実にデプロイされるよう、必要に応じてアプリ プロジェクトまたはビルド スクリプトを更新します。特に、Android Studio で開発している場合は、適切なデバイスまたは AVD をターゲットとする実行 / デバッグ構成をセットアップしてください。

すでにプロジェクトが標準の Android 1.5(API レベル 3)以上のライブラリでコンパイルされるように設定されている場合は、アプリのビルド構成を変更する必要はありません。アプリにライセンス機能を追加しても、アプリのビルド構成に影響はありません。

LVL のダウンロード

License Verification Library(LVL)は、アプリにライセンス機能を追加するために必要な作業を大幅に簡素化するヘルパークラスのコレクションです。どのような場合でも、LVL をダウンロードして、アプリへのライセンス機能実装の基盤として使用することをおすすめします。

License Verification Library(LVL)は GitHub で開発されています。LVL リポジトリをクローンして、ライブラリ プロジェクトとして設定できます。リポジトリをクローンするには、コマンドラインで次のように入力します。

    git clone https://github.com/google/play-licensing
    

このリポジトリには次のものが含まれます。

  • LVL のソース。Android ライブラリ プロジェクト内に保存されます。
  • LVL ライブラリ プロジェクトに依存する「sample」というサンプルアプリ。このサンプルには、アプリでライブラリ ヘルパークラスを使用してライセンスを確認、適用する方法が示されています。

License Verification Library のセットアップ

LVL をパソコンにダウンロードしたら、Android ライブラリ プロジェクトとして、またはライブラリ ソースを既存のアプリ パッケージに直接コピー(またはインポート)して、開発環境にセットアップする必要があります。通常は、LVL をライブラリ プロジェクトとして使用することをおすすめします。これにより、ライセンス コードを複数のアプリで再利用でき、長期間にわたってより簡単に保守できるようになるためです。LVL は、個別にコンパイルしたり、静的 .jar ファイルとしてアプリに追加したりするようには設計されていません。

LVL は、新しい Android ライブラリ プロジェクトとしてセットアップすることをおすすめします。ライブラリ プロジェクトとは、開発プロジェクトの一種で、共有の Android ソースコードとリソースを含むものです。他の Android アプリ プロジェクトでは、ライブラリ プロジェクトを参照して、ビルド時にそのコンパイル済みソースを .apk ファイルに含めることができます。つまり、ライセンス機能に関して言えば、いったんライブラリ プロジェクトでライセンス機能の大部分を開発しておけば、その後さまざまなアプリ プロジェクトでそのライブラリ ソースを利用できることになります。このようにすれば、すべてのプロジェクトにわたり一貫したライセンス機能を実装でき、管理も一元化できます。ライブラリ プロジェクトやその使い方について詳しくは、プロジェクトの管理をご覧ください。

LVL は、設定済みのライブラリ プロジェクトとして用意されています。ダウンロードすれば、すぐに使用を開始できます。

Android Studio で作業している場合は、プロジェクトに新しいモジュールとして LVL を追加する必要があります。

  1. [File] > [New] > [Import Module] を選択し、[Import Module from Source] ウィンドウを使用してライブラリ モジュールをインポートします。
  2. [Import Module from Source] ウィンドウの [Source directory] に LVL の library ディレクトリ(ライブラリの AndroidManifest.xml ファイルが格納されているディレクトリ)をプロジェクト ルート(<sdk>/extras/google/play_licensing/library/AndroidManifest.xml)として入力し、[Next] を選択します。
  3. [Finish] を選択して、ライブラリ モジュールをインポートします。

Android Studio でライブラリ モジュールを使用する方法の詳細については、Android ライブラリの作成をご覧ください。

アプリへの LVL ライブラリ プロジェクトの追加

ライブラリ プロジェクトとして LVL ソースを使用する場合は、アプリのプロジェクト プロパティに LVL ライブラリ プロジェクトへの参照を追加する必要があります。これにより、コンパイル時にはアプリに LVL ライブラリ プロジェクト ソースを含めるようビルドツールが設定されます。ライブラリ プロジェクトへの参照を追加するプロセスは、下記で説明するように、開発環境によって異なります。

Android Studio で開発している場合は、プロジェクトへのライブラリ モジュールの追加は、前のセクションで説明したとおりすでに行われているはずです。まだ行っていない場合は、先に進む前に済ませてください。

SDK コマンドライン ツールで開発している場合は、アプリ プロジェクトを含むディレクトリに移動して project.properties ファイルを開きます。このファイルに、android.library.reference.<n> キーとライブラリへのパスを指定する行を追加します。次に例を示します。

android.library.reference.1=path/to/library_project

または、次のコマンドを使用して、ライブラリ プロジェクトへの参照などのプロジェクト プロパティを更新するという方法もあります。

android update lib-project
    --target <target_ID> \
    --path path/to/my/app_project \
    --library path/to/my/library_project
    

ライブラリ プロジェクトの使用方法の詳細については、ライブラリ プロジェクトのセットアップをご覧ください。

テスト環境のセットアップ

Google Play Console には、公開する前にアプリのライセンス機能をテストできる設定ツールが用意されています。ライセンス機能を実装する際には、この Play Console ツールを使用して、アプリのポリシーをテストしたり、さまざまなライセンス応答とエラー状態の処理をテストしたりできます。

ライセンス機能のテスト環境の主なコンポーネントは次のとおりです。

  • パブリッシャー アカウントの「テスト応答」設定。この設定により、パブリッシャー アカウントにアップロードされたアプリのライセンス チェックをサーバーで処理する際に、パブリッシャー アカウントまたはテスト アカウントにログインしたユーザーから返される静的ライセンス応答を設定できます。
  • テスト アカウントのセット(必要な場合)。これらのアカウントで、パブリッシャーがアップロードしたアプリのライセンス チェックを送信して、静的テスト応答を受信します(アプリが公開済みかどうかは関係ありません)。
  • Google Play アプリまたは Google API アドオンを含むアプリのランタイム環境。ユーザーは、この環境でパブリッシャー アカウントやテスト アカウントにログインします。

テスト環境を適切にセットアップするには、次のことを行います。

  1. ライセンス サーバーから返される静的テスト応答を設定すること。
  2. 必要に応じて、テスト アカウントをセットアップすること。
  3. ライセンス チェックのテストを開始する前に、エミュレータまたはデバイスに適切にログインすること。

下記のセクションで、さらに詳しく説明します。

ライセンス チェックのテスト応答の設定

Google Play のパブリッシャー アカウントでは、ライセンス チェックの通常の処理をオーバーライドして、指定した静的応答コードを返すように設定できます。この設定はテスト専用であり、アップロードしたアプリに対するライセンス チェックを、パブリッシャー アカウントまたは登録済みテスト アカウントの認証情報でエミュレータまたはデバイスにログインしたユーザーが行った場合にのみ適用されます。他のユーザーが行ったライセンス チェックは、すべて通常のルールに従って処理されます。

アカウントのテスト応答を設定するには、パブリッシャー アカウントにログインし、[プロフィールの編集] をクリックします。[プロフィールの編集] ページで、以下に示す [ライセンス テスト] パネルの [ライセンス テスト応答] メニューを見つけます。有効なすべてのサーバー応答コードの中から、アプリでテストする応答または条件の制御に適したものを選択できます。

通常は、[ライセンス テスト応答] メニューで使用可能な応答コードをすべて使用して、アプリへのライセンス機能の実装をテストします。コードの説明については、ライセンス リファレンスサーバー応答コードをご覧ください。

図 2. [アカウントの詳細] ページの [ライセンス テスト] パネルでテスト アカウントのセットアップとテスト応答の管理が可能

ここで設定するテスト応答は、アカウントワイドに適用されることに注意してください。つまり、単一のアプリではなく、そのパブリッシャー アカウントに関連付けられているすべてのアプリに適用されます。一度に複数のアプリをテストしている場合、テスト応答を変更すると、次のライセンス チェックでそれらすべてのアプリに影響します(ライセンス チェックを行うユーザーがパブリッシャー アカウントまたはテスト アカウントでエミュレータまたはデバイスにログインしている場合)。

ライセンス チェックのテスト応答を正常に受信するには、サーバーにクエリを行うアプリがインストールされているデバイスまたはエミュレータにログインしておく必要があります。特に、ログインにはパブリッシャー アカウントまたはセットアップしたテスト アカウントのいずれかを使用する必要があります。テスト アカウントの詳細については、次のセクションをご覧ください。

使用可能なテスト応答とその意味の一覧については、サーバー応答コードをご覧ください。

テスト アカウントのセットアップ

複数のデベロッパー チームでアプリのライセンス機能をテストする場合、そのアプリを最終的に公開するパブリッシャー アカウントのログイン認証情報を使用させたくない場合があります。そのようなニーズを満たすため、Google Play Console では、必要に応じてテスト アカウントをセットアップできます。このアカウントでは、ライセンス サーバーにクエリを送信したり、パブリッシャー アカウントから静的テスト応答を受信したりできます。

テスト アカウントは、パブリッシャー アカウント上で登録する標準の Google アカウントであり、パブリッシャーがアップロードしたアプリのテスト応答を受信できます。デベロッパーは、このテスト アカウントの認証情報を使用してデバイスまたはエミュレータにログインし、インストール済みのアプリからのライセンス チェックを開始できます。テスト アカウントのユーザーからライセンス チェックを受信したライセンス サーバーからは、パブリッシャー アカウント用に設定した静的テスト応答が返されます。

必然的に、テスト アカウントでログインしたユーザーのアクセス権と権限には、次のような制限があります。

  • テスト アカウントのユーザーがライセンス サーバーにクエリを行えるのは、すでにパブリッシャー アカウントにアップロードされているアプリについてのみです。
  • テスト アカウントのユーザーには、パブリッシャー アカウントにアプリをアップロードする権限がありません。
  • テスト アカウントのユーザーには、パブリッシャー アカウント用の静的テスト応答を設定する権限がありません。

次の表は、パブリッシャー アカウント、テスト アカウント、その他のアカウントの機能の違いをまとめたものです。

表 1. ライセンス機能のテストに使用するアカウントの種類の違い

アカウントの種類 アップロード前のライセンス チェック可否 テスト応答の受信可否 テスト応答の設定可否
パブリッシャー アカウント
テスト アカウント × ×
その他 × × ×

パブリッシャー アカウント上でのテスト アカウントの登録

まず、パブリッシャー アカウント上で各テスト アカウントを登録する必要があります。図 2 に示すように、パブリッシャー アカウントの [プロフィールの編集] ページにある [ライセンス テスト] パネルでテスト アカウントを登録します。アカウントをカンマ区切りのリストとして入力し、[保存] をクリックして変更したプロフィールを保存します。

テスト アカウントには、任意の Google アカウントを使用できます。テスト アカウントを所有して管理する場合は、自分でアカウントを作成し、開発者またはテスターに認証情報を配布します。

テスト アカウント ユーザーのためのアプリのアップロードと配布

前述のとおり、テスト アカウントのユーザーは、パブリッシャー アカウントにアップロードされたアプリに関して静的テスト応答の受信のみ行えます。パブリッシャーとしては、アップロードする権限がないこれらのユーザーと協力して、アップロードするアプリを収集したり、テストのためにアップロードしたアプリを配布したりする必要があります。収集と配布の方法は、適宜選択できます。

いったんアプリをアップロードして、それがライセンス サーバーに認識されると、デベロッパーとテスターは、ローカルの開発環境のアプリを引き続き変更できます。新しいバージョンのアップロードは不要です。新しいバージョンをアップロードする必要があるのは、ローカルのアプリでマニフェスト ファイルの versionCode 属性値をインクリメントした場合のみです。

テスト アカウント ユーザーへの公開鍵の配布

ライセンス サーバーによる静的テスト応答の処理は、通常と同じ方法(ライセンス応答データへの署名、付加情報パラメータの追加など)で行われます。パブリッシャー アカウントではなくテスト アカウントを使用してライセンス機能を実装しているデベロッパーには、アプリのライセンス用公開鍵を配布する必要があります。Play Console にアクセスできないデベロッパーはアプリの公開鍵を入手できず、鍵がなければライセンス応答を確認できないためです。

なんらかの理由でアプリのライセンス用鍵ペアを新たに生成し直した場合は、すべてのテスト アカウント ユーザーに通知する必要があります。テスターに対しては、新しい鍵をアプリ パッケージに埋め込んで配布できます。デベロッパーに対しては、新しい鍵をそのまま配布する必要があります。

ランタイム環境での承認済みアカウントへのログイン

ライセンス サービスは、特定のユーザーが特定のアプリを使用するライセンスを持っているかどうかを判定するためのものです。ライセンス チェック中、Google Play アプリによってシステムのメイン アカウントからユーザー ID が取得され、アプリのパッケージ名などの情報とともにサーバーに送られます。しかし、利用できるユーザー情報がない場合は、ライセンス チェックを行えないため、Google Play アプリによってリクエストの処理は終了し、アプリにはエラーが返されます。

テスト中に、アプリからライセンス サーバーへ確実にクエリできるようにするには、次のいずれかを使用してデバイスまたはエミュレータのアカウントにログインしている必要があります。

  • パブリッシャー アカウントの認証情報
  • パブリッシャー アカウントに登録されたテスト アカウントの認証情報

パブリッシャー アカウントを使用してログインすると、Play Console にアップロードする前のアプリであっても、静的テスト応答を受信できるという利点があります。

大規模な組織に所属している場合や、自サイト経由で公開するアプリを外部のグループと開発している場合は、代わりにテスト アカウントを配布し、テスト時のログインにはそれを使用するようにします。

デバイスまたはエミュレータにログインする手順を下記に示します。ログインは、メイン アカウントで行うことをおすすめします。ただし、デバイスまたはエミュレータですでに他のアカウントを使用している場合は、追加アカウントを作成し、パブリッシャー アカウントまたはテスト アカウントの認証情報を使用してそれにログインすることもできます。

  1. [設定] > [アカウントと同期] を開きます。
  2. [アカウントを追加] を選択し、Google アカウントの追加を選択します。
  3. [次へ] を選択した後、[ログイン] を選択します。
  4. パブリッシャー アカウント、またはパブリッシャー アカウント上で登録されたテスト アカウントのユーザー名とパスワードを入力します。
  5. [ログイン] を選択します。これで、新しいアカウントにログインできます。

ログインしたら、アプリのライセンス機能のテストを開始できます(上記の LVL との統合手順を完了している場合)。ライセンス チェックが開始されると、アプリはパブリッシャー アカウント用に設定された静的テスト応答を含む応答を受信します。

エミュレータを使用している場合は、エミュレータの再起動時にデータを消去するたびに、パブリッシャー アカウントまたはテスト アカウントにログインし直す必要があります。

セットアップ手順を完了したら、アプリへのライセンス機能の追加に進みます。