Bien démarrer avec Android

Article
03/15/2024

Important

Visual Studio App Center doit être mis hors service le 31 mars 2025. Bien que vous puissiez continuer à utiliser Visual Studio App Center jusqu’à ce qu’il soit entièrement mis hors service, il existe plusieurs alternatives recommandées vers lesquelles vous pouvez envisager de migrer.

En savoir plus sur les chronologies et les alternatives de support.

Le Kit de développement logiciel (SDK) App Center utilise une architecture modulaire pour vous permettre d’utiliser tous les services 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 SDK App Center, le Règlement général sur la protection des données et les pages FAQ .

Commençons à configurer app Center Android SDK 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 les appareils exécutant Android version 5.0 (niveau 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.

Dirigez-vous vers appcenter.ms.
Inscrivez-vous ou connectez-vous, cliquez sur le bouton Ajouter une nouvelle dans le coin supérieur droit de la page, puis sélectionnez Ajouter une nouvelle application dans le menu déroulant.
Entrez un nom et une description facultative pour votre application.
Sélectionnez Android comme système d’exploitation et Java comme plateforme.
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, dans le coin supérieur droit, cliquez sur les points verticaux triples et 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

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 and Crashes, ajoutez les lignes suivantes :

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

Notes

Si la version de votre plug-in Android Gradle est inférieure à 3.0.0, vous devez remplacer l’implémentation du mot par compiler.

Notes

En raison de l’arrêt de la prise en charge de jCenter , tous nos assemblys ont été déplacés vers le référentiel Maven Central. Suivez ce guide sur la migration de jCenter vers Maven Central. Notez que Maven Central ne contient pas de modules déconseillés. Assurez-vous que votre projet n’a pas de dépendances de modules du KIT de développement logiciel (SDK) App Center dépréciés.

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 le démarrer et d’utiliser App Center.

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

4.1 Ajouter la méthode start()

Pour utiliser App Center, vous devez choisir 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 SDK.
Insérez la ligne suivante à l’intérieur de la classe d’activité main de votre application ' onCreate-callback pour utiliser App Center Analytics et les incidents d’App Center :

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

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

Avertissement

Il n’est pas recommandé d’incorporer votre secret d’application dans le code source.

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

Configurez ou démarrez-le avec le secret d’application.
Si le code peut être appelé plusieurs fois, case activée si app Center est déjà configuré.
Démarrez le ou les services requis sans le 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 à votre application (par exemple, une activité de liaison approfondie, un service ou un récepteur de diffusion), appelez start la classe personnalisée de l’application ou dans chaque point d’entrée. Dans ce dernier cas, case activée 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 Remplacez l’espace réservé par votre secret d’application

Veillez à remplacer {Your App Secret} le texte par la valeur réelle de votre application. Le secret d’application se trouve dans la page Prise en main ou dans 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’ensemble de l’exemple.

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 en tant que 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 dans 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 avez inséré la start() méthode, mais si vous voyez une erreur indiquant que les noms de classe 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 tous configuré pour visualiser les données d’analyse et de blocage sur le portail que le SDK collecte automatiquement.

Consultez la documentation relative aux incidents d’App Center Analytics et d’App Center pour découvrir comment personnaliser et utiliser des fonctionnalités plus avancées des deux services.

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

5. Règles de sauvegarde (Android uniquement)

Notes

La sauvegarde automatique est automatiquement activée pour les applications qui ciblent Android 6.0 (niveau d’API 23) ou une version ultérieure.

Notes

Si vous avez déjà un fichier personnalisé avec une règle de sauvegarde, passez à la troisième étape.

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 API 30) ou version ultérieure.

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

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

android:fullBackupContent="@xml/appcenter_backup_rule"

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 API 31) ou version ultérieure.

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

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

android:dataExtractionRules="@xml/appcenter_backup_rule"

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>

Bien démarrer avec Android

1. Prérequis

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

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

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

4.1 Ajouter la méthode start()

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

5. Règles de sauvegarde (Android uniquement)

5.1. Pour Android 11 (niveau API 30) ou version ultérieure.

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

Ressources supplémentaires