Le SDK Google User Messaging Platform (UMP) est un outil permettant vous aider à gérer les paramètres de confidentialité. Pour en savoir plus, consultez À propos de l'outil Confidentialité et messagerie.
Créer un type de message
Créez des messages destinés aux utilisateurs avec l'une des Types de messages disponibles pour les utilisateurs dans la section Confidentialité l'onglet "Messages" de votre AdMob Google Cloud. Le SDK UMP tente d'afficher un message sur la confidentialité créé à partir de AdMob l'identifiant de l'application dans votre projet.
Pour en savoir plus, consultez À propos de la confidentialité et des messages
Ajouter l'ID application
Vous trouverez l'ID de votre application dans le Interface utilisateur d'AdMob. Ajoutez la pièce d'identité à votre à l'aide de l'extrait de code suivant:
Demande d'informations sur le consentement
Vous devez demander la mise à jour des informations sur le consentement de l'utilisateur pour chaque application
lancer, à l'aide de requestConsentInfoUpdate()
. Cette demande vérifie
les éléments suivants:
- Le consentement est-il requis ? Par exemple, le consentement est requis pour ou que la précédente décision de consentement a expiré.
- Indique si un point d'entrée pour les options de confidentialité est requis. Certains messages sur la confidentialité exiger que les applications autorisent les utilisateurs à modifier leurs options de confidentialité à tout moment.
Voici un exemple de vérification de l'état au démarrage de l'application:
@override
void initState() {
super.initState();
// Create a ConsentRequestParameters object.
final params = ConsentRequestParameters();
// Request an update for the consent information.
ConsentInformation.instance.requestConsentInfoUpdate(
params,
() async {
// TODO: Load and present the privacy message form.
},
(FormError error) {
// Handle the error.
},
);
}
Charger et présenter un formulaire de message sur la confidentialité si nécessaire
Une fois que vous avez reçu les toutes dernières informations concernant l'état de votre consentement, appelez
loadAndShowConsentFormIfRequired()
pour charger les formulaires nécessaires
recueillir le consentement des utilisateurs. Une fois le chargement terminé, les formulaires s'affichent immédiatement.
@override
void initState() {
super.initState();
// Create a ConsentRequestParameters object.
final params = ConsentRequestParameters();
// Request an update for the consent information.
ConsentInformation.instance.requestConsentInfoUpdate(
params,
() async {
ConsentForm.loadAndShowConsentFormIfRequired((loadAndShowError) {
if (loadAndShowError != null) {
// Consent gathering failed.
}
// Consent has been gathered.
});
},
(FormError error) {
// Handle the error.
},
);
}
Si vous devez effectuer des actions après que l'utilisateur a choisi ou ignoré dans le formulaire, placez cette logique dans callback pour votre formulaire.
Options de confidentialité
Certains formulaires de message sur la confidentialité sont présentés à partir d'une interface qui permet aux utilisateurs de gérer leurs options de confidentialité à tout moment. Pour en savoir plus sur le message que voient vos utilisateurs dans les options de confidentialité point d'entrée, consultez Types de messages disponibles pour les utilisateurs
Pour implémenter un point d'entrée pour les options de confidentialité, procédez comme suit:
- Vérifiez
getPrivacyOptionsRequirementStatus()
. - Si un point d'entrée des options de confidentialité est ajoutez un élément d'interface utilisateur visible et interactif à votre application.
- Déclenchez le formulaire des options de confidentialité à l'aide de
showPrivacyOptionsForm()
L'exemple de code suivant illustre ces étapes:
class AppExampleState extends State<AppExample> {
static const _privacySettingsText = 'Privacy Settings';
// Use a bool to initialize the Mobile Ads SDK and load ads once.
var _isMobileAdsInitializeCalled = false;
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'App Example',
home: Scaffold(
appBar: AppBar(
title: const Text('App Example'),
actions: _isMobileAdsSDKInitialized
// Regenerate the options menu to include a privacy setting.
? _privacySettingsAppBarAction()
: null
),
body: // ...
),
);
}
List<Widget> _privacySettingsAppBarAction() {
return <Widget>[
FutureBuilder(
future: ConsentInformation.instance.isPrivacyOptionsRequired(),
builder: (context, snapshot) {
final bool visibility = snapshot.data ?? false;
return Visibility(
visible: visibility,
child: PopupMenuButton<String>(
onSelected: (String result) {
if (result == _privacySettingsText) {
ConsentForm.showPrivacyOptionsForm((formError) {
if (formError != null) {
debugPrint(
"${formError.errorCode}: ${formError.message}");
}
});
}
},
itemBuilder: (BuildContext context) =>
<PopupMenuEntry<String>>[
const PopupMenuItem<String>(
value: _privacySettingsText,
child: Text(_privacySettingsText))
],
));
})
];
}
}
Demander des annonces
Avant de demander des annonces dans votre application, vérifiez si vous avez obtenu le consentement des utilisateurs
de l'utilisateur via canRequestAds()
. Il y a deux
endroits où vérifier le consentement des utilisateurs:
- Une fois que le consentement a été obtenu lors de la session en cours.
- Immédiatement après avoir appelé
requestConsentInfoUpdate()
. Il est possible que le consentement ait été obtenu lors de la session précédente. En tant que latence nous vous recommandons de ne pas attendre la fin du rappel commencer à charger des annonces dès que possible après le lancement de votre application.
Si une erreur se produit lors du processus de collecte du consentement, vous devez pour tenter de demander des annonces. Le SDK UMP utilise l'état de consentement de l'autorisation session.
class AppExampleState extends State<AppExample> {
// Use a bool to initialize the Mobile Ads SDK and load ads once.
var _isMobileAdsInitializeCalled = false;
@override
void initState() {
super.initState();
// Create a ConsentRequestParameters object.
final params = ConsentRequestParameters();
// Request an update for the consent information.
ConsentInformation.instance.requestConsentInfoUpdate(
params,
() async {
ConsentForm.loadAndShowConsentFormIfRequired((loadAndShowError) {
if (loadAndShowError != null) {
// Consent gathering failed.
}
// Consent has been gathered.
_initializeMobileAdsSDK();
});
},
(FormError error) {
// Handle the error.
},
);
// Check if you can initialize the Mobile Ads SDK in parallel while
// checking for new consent information. Consent obtained in the
// previous session can be used to request ads.
_initializeMobileAdsSDK();
}
void _initializeMobileAdsSDK() async {
if (_isMobileAdsInitializeCalled) {
return;
}
// Initialize the Mobile Ads SDK if the SDK has gathered consent aligned with
// the app's configured messages.
var canRequestAds = await ConsentInformation.instance.canRequestAds();
if (canRequestAds) {
setState(() {
_isMobileAdsInitializeCalled = true;
});
// Initialize the Mobile Ads SDK.
MobileAds.instance.initialize();
// TODO: Request an ad.
}
}
}
Tests
Si vous souhaitez tester l'intégration dans votre application pendant le développement, suivez suivez ces étapes pour enregistrer votre appareil de test de manière programmatique. Veillez à supprimer le qui définit ces ID d'appareils de test avant de publier votre application.
- Appelez le
requestConsentInfoUpdate()
. Recherchez dans la sortie du journal un message semblable à l'exemple suivant, affiche l'ID de votre appareil et explique comment l'ajouter en tant qu'appareil de test:
Android
Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231") to set this as a debug device.
iOS
<UMP SDK>To enable debug mode for this device, set: UMPDebugSettings.testDeviceIdentifiers = @[2077ef9a63d2b398840261c8221a0c9b]
Copiez l'ID de votre appareil de test dans votre presse-papiers.
Modifiez votre code pour appeler
ConsentDebugSettings.testIdentifiers
et transmettre la liste de vos ID d'appareils de test.ConsentDebugSettings debugSettings = ConsentDebugSettings( testIdentifiers: ["TEST-DEVICE-HASHED-ID"], ); ConsentRequestParameters params = ConsentRequestParameters(consentDebugSettings: debugSettings); ConsentInformation.instance.requestConsentInfoUpdate(params, () async { // ... };
Forcer une zone géographique
Le SDK UMP permet de tester le comportement de votre application comme si l'appareil était
situées dans l'EEE ou au Royaume-Uni par le biais de the DebugGeography
field on ConsentDebugSettings
. Notez que
Les paramètres de débogage ne fonctionnent que sur les appareils de test.
ConsentDebugSettings debugSettings = ConsentDebugSettings(
debugGeography: DebugGeography.debugGeographyEea,
testIdentifiers: ["TEST-DEVICE-HASHED-ID"],
);
ConsentRequestParameters params =
ConsentRequestParameters(consentDebugSettings: debugSettings);
ConsentInformation.instance.requestConsentInfoUpdate(params, () async {
// ...
};
Réinitialiser l'état du consentement
Lorsque vous testez votre application avec le SDK UMP, il peut être utile de réinitialiser le
l'état du SDK afin de simuler la première expérience d'installation d'un utilisateur.
Pour ce faire, le SDK fournit la méthode reset()
.
ConsentInformation.instance.reset();