Includi notifiche open source

A volte Google Play Services include o dipende da librerie open source. Per rispettare i requisiti di licenza delle librerie open source, in qualità di sviluppatore, hai la responsabilità di visualizzare correttamente gli avvisi per le librerie open source utilizzate dalla tua app.

Google Play Services include una serie di strumenti progettati per offrire agli sviluppatori un modo più semplice per esprimere le notifiche relative al software open source relative alle librerie utilizzate nelle loro app. Uno di questi strumenti è un plug-in Gradle che raccoglie i termini di licenza dalle librerie incluse, come dichiarato nei file POM, e crea un'attività utilizzabile per visualizzare questi termini. Scopri di più su come lo strumento trova e pacchettizza le informazioni sulle licenze.

Aggiungi il plug-in Gradle

Nel file di build di livello principale, segui questi passaggi:

1. Includi il repository Google Maven.
2. Aggiungi il plug-in oss-licenses alle tue dipendenze.

Il seguente snippet di codice illustra questa procedura:

DSL Kotlin

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")
  }
}

DSL alla moda

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

Nel file di build a livello di app, applica il plug-in aggiungendo la seguente riga sotto la dichiarazione esistente del plug-in com.android.application nella parte superiore del file:

DSL Kotlin

app/build.gradle.kts

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

DSL alla moda

app/build.gradle

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

Puoi visualizzare il codice per questo plug-in su GitHub.

Aggiungi la raccolta all'app

Nella sezione dependencies del file di build a livello di app, aggiungi una dipendenza nella libreria oss-licenses:

DSL Kotlin

build.gradle.kts

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

DSL alla moda

build.gradle

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

Mostra informazioni sulla licenza

Quando la tua app crea, il plug-in Gradle elabora le licenze e le aggiunge alle risorse dell'app. Per visualizzare facilmente la licenza, puoi avviare un'attività fornita dalla libreria play-services-oss-licenses in un punto appropriato della tua app, come mostrato nel seguente snippet di codice:

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

Una volta avviata, questa attività mostra un elenco di librerie open source compilate nella tua app, incluse le librerie che fanno parte di Google Play services, come mostrato nella figura 1. Gli utenti possono toccare il nome di una libreria per visualizzare ulteriori informazioni sulla licenza per quella libreria.

Figura 1. L'attività del menu Licenze mostra un elenco selezionabile di librerie open source utilizzate da un'app.

Imposta il titolo dell'attività

Per impostazione predefinita, l'attività visualizzata è denominata "Licenze open source". Puoi personalizzare il titolo dell'attività chiamando setActivityTitle(), come mostrato nello snippet di codice seguente:

Kotlin

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

Java

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

Applicare un tema all'attività

Puoi applicare un tema all'attività in modo che corrisponda al tema utilizzato nelle altre attività della tua app. Per farlo, includi l'attività di licenza open source in un elemento <activity> all'interno del file manifest della tua app, come mostrato nel seguente snippet di codice:

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

Come viene determinato l'elenco delle licenze

Al momento della compilazione, il plug-in Gradle analizza le dipendenze POM del progetto dell'app. Quando esiste un POM Maven per una dipendenza diretta dell'app, il plug-in elabora ogni elemento <licenses> e incorpora il link e il titolo di ogni licenza in una risorsa Android inclusa nella tua app.

Nota: l'elenco delle licenze include anche il testo completo della licenza di qualsiasi libreria dipendente dalla chiusura transitiva delle librerie di Google Play Services utilizzate dall'app. Ciò significa che l'elenco include tutte le librerie open source utilizzate per creare le librerie di Google Play Services compilate nella tua app.