Prise en main d’Android

Le Kit de développement logiciel (SDK) App Center utilise une architecture modulaire pour vous permettre d’utiliser n’importe quel ou tous les services.

Vous trouverez des informations sur les données collectées par App Center sur les données collectées par les kits SDK App Center, le règlement général sur la protection des donnéeset les pages FAQ.

Nous allons commencer par configurer l'App Center SDK Android dans votre application pour utiliser App Center Analytics et App Center Crashs. Pour ajouter App Center Distribute à votre application, consultez la documentation relative à App Center Distribute.

1. Prérequis

Avant de commencer, vérifiez que les conditions préalables suivantes sont remplies :

• Votre projet Android est configuré dans Android Studio.
• Vous ciblez des appareils exécutant Android Version 5.0 (niveau d’API 21) ou version ultérieure.

2. Créez votre application dans le portail App Center pour obtenir le secret d’application

Si vous avez déjà créé votre application dans le portail App Center, vous pouvez ignorer cette étape.

1. Passez à appcenter.ms.
2. Inscrivez-vous ou connectez-vous, puis cliquez sur le bouton Ajouter un nouveau dans le coin supérieur droit de la page, puis sélectionnez Ajouter une nouvelle application dans le menu déroulant.
3. Entrez un nom et une description facultative pour votre application.
4. Sélectionnez Android comme système d’exploitation et Java en tant que plateforme.
5. Cliquez sur le bouton Ajouter une nouvelle application .

Une fois que vous avez créé une application, vous pouvez obtenir son secret d’application sur la page Prise en main sous 2. Démarrez le Kit de développement logiciel (SDK). Vous pouvez également cliquer sur Paramètres et, en haut à droite, cliquez sur les points verticaux triples , puis sélectionnez Copier le secret de l’application pour obtenir votre secret d’application.

3. Ajouter les modules du Kit de développement logiciel (SDK) App Center

1. Ouvrez le fichier build.gradle au niveau de l’application du projet (app/build.gradle) et ajoutez les lignes suivantes après apply plugin. Incluez les dépendances souhaitées dans votre projet. Chaque module sdk doit être ajouté en tant que dépendance distincte dans cette section. Si vous souhaitez utiliser App Center Analytics et App Center Crashes, ajoutez les lignes suivantes :

dependencies {
    def appCenterSdkVersion = '5.0.6'
    implementation "com.microsoft.appcenter:appcenter-analytics:${appCenterSdkVersion}"
    implementation "com.microsoft.appcenter:appcenter-crashes:${appCenterSdkVersion}"
}

2. Veillez à déclencher une synchronisation Gradle dans Android Studio.

Maintenant que vous avez intégré le Kit de développement logiciel (SDK) dans votre application, il est temps de démarrer le Kit de développement logiciel (SDK) et d’utiliser App Center.

4. Démarrez le Kit de développement logiciel (SDK)

4.1 Ajouter la méthode start()

Pour utiliser App Center, vous devez choisir le ou les modules que vous souhaitez utiliser. Par défaut, aucun module n’est démarré et vous devez appeler explicitement chacun d’eux lors du démarrage du Kit de développement logiciel (SDK).
Insérez la ligne suivante dans la classe d’activité principale de votre application dans le onCreate-callback pour utiliser App Center Analytics et App Center Crashes :

AppCenter.start(getApplication(), "{Your App Secret}", Analytics.class, Crashes.class);

AppCenter.start(application, "{Your App Secret}", Analytics::class.java, Crashes::class.java)

Si vous devez démarrer les services App Center séparément, vous devez :

1. Configurez ou démarrez-le avec le secret de l’application.
2. Si le code peut être appelé plusieurs fois, vérifiez si l’App Center est déjà configuré.
3. Démarrez le ou les services requis sans secret d’application.

AppCenter.configure(application, "{Your App Secret}");
if (AppCenter.isConfigured()) {
    AppCenter.start(Analytics.class);
    AppCenter.start(Crashes.class);
}

AppCenter.configure(application, "{Your App Secret}");
if (AppCenter.isConfigured()) {
    AppCenter.start(Analytics::class.java);
    AppCenter.start(Crashes::class.java);
}

Si vous avez plusieurs points d’entrée pour votre application (par exemple, une activité de lien profond, un service ou un récepteur de diffusion), appelez start dans la classe personnalisée de l'application ou à chaque point d’entrée. Dans ce dernier cas, vérifiez si App Center est déjà configuré avant l’appel start :

if (!AppCenter.isConfigured())) {
  AppCenter.start(getApplication(), "{Your App Secret}", Analytics.class, Crashes.class);
}

if (!AppCenter.isConfigured()) {
  AppCenter.start(application, "{Your App Secret}", Analytics::class.java, Crashes::class.java)
}

4.2 Remplacer l’espace réservé par votre secret d’application

Veillez à remplacer {Your App Secret} le texte par la valeur réelle de votre application. La clé secrète de l’application se trouve dans la page Prise en main ou la page Paramètres du portail App Center.

La page Prise en main contient l’exemple de code ci-dessus avec votre secret d’application, vous pouvez simplement copier-coller l’exemple entier.

L’exemple ci-dessus montre comment utiliser la start() méthode et inclure app Center Analytics et App Center Crashs.

Si vous ne souhaitez pas utiliser l’un des deux services, supprimez le paramètre correspondant de l’appel de méthode ci-dessus.

Sauf si vous spécifiez explicitement chaque module comme paramètres dans la méthode de démarrage, vous ne pouvez pas utiliser ce service App Center. En outre, l’API start() ne peut être utilisée qu’une seule fois dans le cycle de vie de votre application . tous les autres appels consignent un avertissement à la console et seuls les modules inclus dans le premier appel seront disponibles.

Par exemple : si vous souhaitez simplement intégrer App Center Analytics, vous devez modifier l’appel d’API start() comme suit :

AppCenter.start(getApplication(), "{Your App Secret}", Analytics.class);

AppCenter.start(application, "{Your App Secret}", Analytics::class.java)

Android Studio suggère automatiquement les instructions d’importation requises une fois que vous insérez la start() méthode, mais si vous voyez une erreur indiquant que les noms de classes ne sont pas reconnus, ajoutez les lignes suivantes aux instructions d’importation dans votre classe d’activité :

import com.microsoft.appcenter.AppCenter;
import com.microsoft.appcenter.analytics.Analytics;
import com.microsoft.appcenter.crashes.Crashes;

import com.microsoft.appcenter.AppCenter
import com.microsoft.appcenter.analytics.Analytics
import com.microsoft.appcenter.crashes.Crashes

Vous êtes prêts à visualiser les données d'analyses et d'incidents sur le portail que le SDK collecte automatiquement.

Consultez la documentation relative aux incidents App Center Analytics et App Center Pour savoir comment personnaliser et utiliser des fonctionnalités plus avancées des deux services.

Pour savoir comment bien démarrer avec les mises à jour dans l’application, lisez la documentation de App Center Distribute.

5. Règles de sauvegarde (Android uniquement)

Si vous utilisez la sauvegarde automatique pour éviter d’obtenir des informations incorrectes sur les appareils, suivez les étapes suivantes :

5.1. Pour Android 11 (niveau d’API 30) ou inférieur.

1. Créez appcenter_backup_rule.xml fichier dans le dossier res/xml .

2. Ouvrez le fichier AndroidManifest.xml du projet. Ajoutez l’attribut android:fullBackupContent à l’élément <application> . Il doit pointer vers le fichier de ressources appcenter_backup_rule.xml .

android:fullBackupContent="@xml/appcenter_backup_rule"

3. Ajoutez les règles de sauvegarde suivantes au fichier appcenter_backup_rule.xml :

<full-backup-content xmlns:tools="http://schemas.android.com/tools">
      <exclude domain="sharedpref" path="AppCenter.xml"/>
      <exclude domain="database" path="com.microsoft.appcenter.persistence"/>
      <exclude domain="database" path="com.microsoft.appcenter.persistence-journal"/>
      <exclude domain="file" path="error" tools:ignore="FullBackupContent"/>
      <exclude domain="file" path="appcenter" tools:ignore="FullBackupContent"/>
  </full-backup-content>

5.2. Pour Android 12 (niveau d’API 31) ou version ultérieure.

1. Créez appcenter_backup_rule.xml fichier dans le dossier res/xml .

2. Ouvrez le fichier AndroidManifest.xml du projet. Ajoutez l’attribut android:dataExtractionRules à l’élément <application> . Il doit pointer vers le fichier de ressources appcenter_backup_rule.xml .

android:dataExtractionRules="@xml/appcenter_backup_rule"

3. Ajoutez les règles de sauvegarde suivantes au fichier appcenter_backup_rule.xml :

<data-extraction-rules xmlns:tools="http://schemas.android.com/tools">
    <cloud-backup>
        <exclude domain="sharedpref" path="AppCenter.xml"/>
        <exclude domain="database" path="com.microsoft.appcenter.persistence"/>
        <exclude domain="database" path="com.microsoft.appcenter.persistence-journal"/>
        <exclude domain="file" path="error" tools:ignore="FullBackupContent"/>
        <exclude domain="file" path="appcenter" tools:ignore="FullBackupContent"/>
    </cloud-backup>
    <device-transfer>
        <exclude domain="sharedpref" path="AppCenter.xml"/>
        <exclude domain="database" path="com.microsoft.appcenter.persistence"/>
        <exclude domain="database" path="com.microsoft.appcenter.persistence-journal"/>
        <exclude domain="file" path="error" tools:ignore="FullBackupContent"/>
        <exclude domain="file" path="appcenter" tools:ignore="FullBackupContent"/>
    </device-transfer>
</data-extraction-rules>