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

Stay organized with collections Save and categorize content based on your preferences.

Google Play 開発者サービスには、オープンソース ライブラリが含まれている場合があります。オープンソース ライブラリのライセンス要件を遵守するため、デベロッパーは、アプリで使用するオープンソース ライブラリの通知を適切に表示する必要があります。

Google Play 開発者サービスには、アプリで使用されるライブラリのオープンソース ソフトウェア通知をデベロッパーが簡単に表現できるように設計されたツールセットが用意されています。そうしたツールの一つが、含まれるライブラリから 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.0.0")

Groovy DSL

build.gradle

implementation 'com.google.android.gms:play-services-oss-licenses:17.0.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 アセットに各ライセンスのリンクとタイトルを埋め込みます。