Google Play 開発者サービスには、オープンソース ライブラリが含まれるか、オープンソース ライブラリに依存することがあります。オープンソース ライブラリのライセンス要件を遵守するため、デベロッパーは、アプリが使用するオープンソース ライブラリの通知を適切に表示する必要があります。
Google Play 開発者サービスには、アプリで使用されているライブラリについて、オープンソース ソフトウェアの通知を簡単に表現できるツールセットが用意されています。これらのツールの 1 つが Gradle プラグインです。このプラグインは、POM ファイルで宣言されているように、含まれるライブラリからライセンス条項を収集し、それらの条項の表示に使用できるアクティビティを作成します。詳しくは、ツールがライセンス情報を検出してパッケージ化する仕組みをご覧ください。
Gradle プラグインを追加する
ルートレベルのビルドファイルで、次の操作を行います。
- Google の Maven リポジトリを含めます。
oss-licenses
プラグインを依存関係に追加します。
次のコード スニペットはこの手順を示しています。
Kotlin DSL
buildscript { repositories { ... google() // maven { url("https://maven.google.com") } for Gradle <= 3 } dependencies { ... classpath("com.google.android.gms:oss-licenses-plugin:0.10.6") } }
グルーヴィー DSL
buildscript { repositories { ... google() // maven { url "https://maven.google.com" } for Gradle <= 3 } dependencies { ... classpath 'com.google.android.gms:oss-licenses-plugin:0.10.6' } }
アプリレベルのビルドファイルで、ファイルの先頭にある com.android.application
プラグインの既存の宣言の下に次の行を追加して、プラグインを適用します。
Kotlin DSL
plugins { id("com.android.application") id("com.google.android.gms.oss-licenses-plugin") }
グルーヴィー DSL
plugins { id 'com.android.application' id 'com.google.android.gms.oss-licenses-plugin' }
GitHub でこのプラグインのコードを表示できます。
ライブラリをアプリに追加する
アプリレベルのビルドファイルの dependencies
セクションに、oss-licenses
ライブラリへの依存関係を追加します。
Kotlin DSL
implementation("com.google.android.gms:play-services-oss-licenses:17.0.1")
グルーヴィー DSL
implementation 'com.google.android.gms:play-services-oss-licenses:17.0.1'
ライセンス情報を表示する
アプリのビルド時に、Gradle プラグインによってライセンスが処理され、ライセンスがアプリのリソースに追加されます。ライセンスを簡単に表示するには、次のコード スニペットに示すように、play-services-oss-licenses
ライブラリが提供するアクティビティをアプリ内の適切な場所で起動できます。
Kotlin
import com.google.android.gms.oss.licenses.OssLicensesMenuActivity ... // When the user selects an option to see the licenses: startActivity(Intent(this, OssLicensesMenuActivity::class.java))
Java
import com.google.android.gms.oss.licenses.OssLicensesMenuActivity; ... // When the user selects an option to see the licenses: startActivity(new Intent(this, OssLicensesMenuActivity.class));
このアクティビティが起動すると、アプリにコンパイルされるオープンソース ライブラリのリストが表示されます(図 1 に示すように、Google Play 開発者サービスに含まれるライブラリも含まれます)。ユーザーはライブラリの名前をタップすると、そのライブラリの追加ライセンス情報を表示できます。
図 1. ライセンス メニュー アクティビティには、アプリが使用するオープンソース ライブラリの選択可能なリストが表示されます。
アクティビティのタイトルを設定する
デフォルトでは、アクティビティには「オープンソース ライセンス」というタイトルが付いています。アクティビティのタイトルをカスタマイズするには、次のコード スニペットに示すように、setActivityTitle()
を呼び出します。
Kotlin
OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title))
Java
OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title));
アクティビティにテーマを適用する
アクティビティには、アプリの他のアクティビティで使用されているテーマに合わせてテーマを適用できます。そのためには、次のコード スニペットに示すように、アプリのマニフェスト ファイル内の <activity>
要素にオープンソース ライセンス アクティビティを含めます。
<application android:theme="@style/AppTheme" ...> <activity android:name="com.google.android.gms.oss.licenses.OssLicensesMenuActivity" android:theme="@style/AppTheme" /> <activity android:name="com.google.android.gms.oss.licenses.OssLicensesActivity" android:theme="@style/AppTheme" /> </application>
ライセンス リストの決定方法
Gradle プラグインはコンパイル時に、アプリのプロジェクトの POM 依存関係をスキャンします。アプリの直接的な依存関係に Maven POM が存在する場合、プラグインは各 <licenses>
要素を処理し、各ライセンスのリンクとタイトルをアプリに含まれる Android アセットに埋め込みます。