オープンソースの通知を含める

Google Play 開発者サービスには、オープンソース ライブラリが含まれていたり、オープンソース ライブラリに依存していたりすることがあります。オープンソース ライブラリのライセンス要件に準拠するため、デベロッパーはアプリで使用するオープンソース ライブラリに関する通知を適切に表示する責任があります。

Google Play 開発者サービスには、アプリで使用されているライブラリのオープンソース ソフトウェアに関する通知をデベロッパーが簡単に表示できるように設計された一連のツールが含まれています。これらのツールの 1 つは、POM ファイルで宣言されているように、含まれるライブラリからライセンス条項を収集し、これらの条項を表示するために使用できるアクティビティを作成する Gradle プラグインです。詳しくは、ツールがライセンス情報を検出してパッケージ化する方法をご覧ください。

Gradle プラグインを追加する

ルートレベルのビルドファイルで、次の操作を行います。

  1. Google Maven リポジトリを含めます。
  2. oss-licenses プラグインを依存関係に追加します。

次のコード スニペットは、これらの手順を示しています。

Kotlin DSL

build.gradle.kts

buildscript {
  repositories {
    ...
    google()  // maven { url("https://maven.google.com") } for Gradle <= 3
  }
  dependencies {
    ...
    classpath("com.google.android.gms:oss-licenses-plugin:0.10.6")
  }
}

Groovy DSL

build.gradle

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

app/build.gradle.kts

plugins {
    id("com.android.application")
    id("com.google.android.gms.oss-licenses-plugin")
}

Groovy DSL

app/build.gradle

plugins {
    id 'com.android.application'
    id 'com.google.android.gms.oss-licenses-plugin'
}

このプラグインのコードを表示するには、GitHub にアクセスしてください。

ライブラリをアプリに追加する

アプリレベルのビルドファイルの dependencies セクションに、oss-licenses ライブラリの依存関係を追加します。

Kotlin DSL

build.gradle.kts

implementation("com.google.android.gms:play-services-oss-licenses:17.1.0")

Groovy DSL

build.gradle

implementation 'com.google.android.gms:play-services-oss-licenses:17.1.0'

ライセンス情報を表示する

アプリのビルド時に、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 アセットに埋め込みます。