Open-Source-Hinweise hinzufügen

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Die Google Play-Dienste umfassen mitunter Open-Source-Bibliotheken oder sind von diesen abhängig. Zur Einhaltung der Lizenzanforderungen von Open-Source-Bibliotheken sind Sie als Entwickler dafür verantwortlich, die Hinweise für die von Ihrer Anwendung verwendeten Open-Source-Bibliotheken entsprechend anzuzeigen.

Die Google Play-Dienste umfassen eine Reihe von Tools, mit denen Entwickler die Open-Source-Softwarehinweise für Bibliotheken, die in ihren Apps verwendet werden, einfacher ausdrücken können. Eines dieser Tools ist ein Gradle-Plug-in, das die in den POM-Dateien deklarierten Lizenzbedingungen aus den enthaltenen Bibliotheken erfasst und eine Aktivität erstellt, mit der diese Bedingungen aufgerufen werden können. Weitere Informationen dazu, wie das Tool Lizenzinformationen findet und verpackt

Gradle-Plug-in hinzufügen

Führen Sie in Ihrer Build-Datei auf Stammebene die folgenden Schritte aus:

  1. Schließen Sie das Google Maven-Repository ein.
  2. Fügen Sie Ihren Abhängigkeiten das Plug-in oss-licenses hinzu.

Das folgende Code-Snippet zeigt diese Schritte:

Kotlin-DSL

build.gradle.de

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'
  }
}

Wenden Sie in Ihrer Build-Datei auf App-Ebene das Plug-in an. Fügen Sie dazu in der vorhandenen Deklaration des com.android.application-Plug-ins oben in der Datei die folgende Zeile hinzu:

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'
}

Sie können den Code für dieses Plug-in auf GitHub ansehen.

Bibliothek der App hinzufügen

Fügen Sie im Abschnitt dependencies der Build-Datei auf App-Ebene eine Abhängigkeit von der oss-licenses-Bibliothek hinzu:

Kotlin-DSL

build.gradle.de

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'

Lizenzinformationen anzeigen

Wenn Ihre Anwendung erstellt wird, verarbeitet das Gradle-Plug-in die Lizenzen und fügt sie den Ressourcen Ihrer Anwendung hinzu. Zum einfachen Anzeigen der Lizenz können Sie eine Aktivität starten, die von der Bibliothek play-services-oss-licenses an einer entsprechenden Stelle in Ihrer App bereitgestellt wird, wie im folgenden Code-Snippet gezeigt:

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));

Nach dem Start wird mit dieser Aktivität eine Liste von Open-Source-Bibliotheken angezeigt, die in Ihrer App kompiliert sind, einschließlich der Bibliotheken, die zu Google Play-Diensten gehören (siehe Abbildung 1). Nutzer können auf den Namen einer Bibliothek tippen, um zusätzliche Lizenzinformationen für diese Bibliothek aufzurufen.

Listenansicht mit jedem Element, das den Namen einer Open-Source-Bibliothek enthält

Abbildung 1. Die Lizenzmenüaktivität zeigt eine auswählbare Liste von Open-Source-Bibliotheken, die eine Anwendung verwendet.

Aktivitätstitel festlegen

Die angezeigte Aktivität hat standardmäßig den Titel „Open-Source-Lizenzen“. Sie können den Titel der Aktivität anpassen. Rufen Sie dazu setActivityTitle() auf, wie im folgenden Code-Snippet gezeigt:

Kotlin

OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title))

Java

OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title));

Design auf die Aktivität anwenden

Sie können ein Design auf die Aktivität anwenden, das dem in Ihren anderen Aktivitäten verwendeten Design entspricht. Fügen Sie dazu die Aktivität der Open-Source-Lizenz in ein <activity>-Element in der Manifestdatei Ihrer App ein, wie im folgenden Code-Snippet gezeigt:

<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>

So wird die Liste der Lizenzen ermittelt

Zum Zeitpunkt der Kompilierung scannt das Gradle-Plug-in die POM-Abhängigkeiten des Projekts Ihrer Anwendung. Wenn ein Maven POM für eine direkte Abhängigkeit der App vorhanden ist, verarbeitet das Plug-in jedes <licenses>-Element und bettet den Link und den Titel jeder Lizenz in ein Android-Asset ein, das in deiner App enthalten ist.