Partager via

Paramètres du Kit de développement logiciel (SDK) Android

Xandr Mobile SDK fournit différents paramètres que vous pouvez utiliser pour vous aider dans le développement de votre application. Dans cet article, vous trouverez des détails sur les méthodes, les paramètres d’entrée, les valeurs retournées, les restrictions, les instructions et les exemples pour les paramètres du Kit de développement logiciel (SDK) Android.

Fonction Description
void init() Active OMID, récupère l’agent utilisateur et AAID (Google Advertising ID) pour les appareils.

Pour plus d’informations, consultez Initialiser les paramètres du KIT de développement logiciel (SDK) ci-dessous.
void setPublisherUserId(String publisherUserId) Envoie l’ID interne et les ID utilisateur du serveur de publication à partir de sources tierces dans les demandes publicitaires.

Pour plus d’informations, consultez Mappage d’ID utilisateur ci-dessous.
void setUserIds(List<ANUserId> userIdList) Définit l’ID utilisateur dans la classe ANSDKSettings.

Pour plus d’informations, consultez Mappage d’ID utilisateur ci-dessous.
void setGeoOverrideCountryCode(String countryCode) Affecte un code de pays.

Pour plus d’informations, consultez Prise en charge de la substitution des codes pays et des codes postaux ci-dessous.
void setGeoOverrideZipCode(String zipCode) Attribue un code postal.

Pour plus d’informations, consultez Prise en charge de la substitution des codes pays et des codes postaux ci-dessous.
void setLocationDecimalDigits(int digitsAfterDecimal) Contrôle la précision des données d’emplacement que vous transmettez au serveur publicitaire.

Pour plus d’informations, consultez Contrôles d’emplacement ci-dessous.
void setLocationEnabledForCreative(Boolean enabled) Contrôle l’accès à l’emplacement pour les créations.

Pour plus d’informations, consultez Contrôles d’emplacement ci-dessous.
void enableBackgroundThreading(Boolean enable) Active ou désactive l’indicateur de fonctionnalité Threading en arrière-plan.

Pour plus d’informations, consultez Threading d’arrière-plan ci-dessous.
void setDoNotTrack(Boolean dnt) Active la fonctionnalité de désactivation de l’utilisateur côté éditeur.

Pour plus d’informations, consultez Refus de l’utilisateur côté éditeur ci-dessous .
void disableAAIDUsage(Boolean disable) Active ou désactive disableAAIDUsage.

Pour plus d’informations, consultez Définir l’utilisation d’AAID ci-dessous.
void setAuctionTimeout(long auctionTimeout) Définit le délai d’expiration en millisecondes.

Pour plus d’informations, consultez Définir le délai d’expiration des enchères ci-dessous.
void enableTestMode(Boolean enabled) Définit true ou false pour les AdRequests à exécuter en mode test.

Pour plus d’informations, consultez Définir le mode test ci-dessous.
void setContentLanguage(String contentLanguage) Définit le code de la langue du contenu.

Pour plus d’informations, consultez Définir la langue de contenu ci-dessous.

Initialiser les paramètres du Kit de développement logiciel (SDK)

Fonction Description
void init(Context context, final InitListener listener)

Méthode surchargée :
void init(final Context context, final InitListener listener, final boolean fetchUserAgent, final boolean fetchAAID, final boolean enableWarmUpAdCall, final boolean preFetchWebView)		 Méthode qui active OMID, fetch User Agent, AAID (Google Advertising ID), active WarmUpAdCall et prérécupère WebView pour les appareils.

En outre, la méthode surchargée init() désactive éventuellement l’extraction d’AAID, UserAgent, enableWarmUpAdCallet preFetchWebView. Elle nécessite l’activation/la désactivation des valeurs booléennes pour fetchUserAgent, fetchAAID, enableWarmUpAdCallet preFetchWebView en tant qu’arguments.

Exemple

Méthode d’initialité régulière
SDKSettings.init(this, new SDKSettings.InitListener() {
    @Override
    public void onInitFinished() {
        // Initialisation finished
    }
});
Méthode Init surchargée avec flexibilité pour activer/désactiver l’extraction de l’agent utilisateur, AAID, WarmUpAdCall et Prefetch WebView
SDKSettings.init(this, new SDKSettings.InitListener() {
    @Override
    public void onInitFinished() {
        // Initialisation finished
    }
}, false, true, false, false);
//Boolean values false/true are optional and as per usage

Mappage d’ID utilisateur

Importante

  • Cette offre est actuellement en alpha et peut être modifiée ou déconseillée sans préavis.
  • Les setExternalUid méthodes et getExternalUid disponibles dans NativeAdRequestles classes , VideoAd, BannerAdViewet InterstitialAdView sont déconseillées. Vous pouvez utiliser setPublisherUserId et getPublisherUserId décrits ci-dessous dans SDKSettings la classe à la place. Les méthodes déconseillées seront supprimées dans le SDK v8.0.
  • Les setExternalUserIds méthodes et getExternalUserIds disponibles dans SDKSettings la classe et ANExternalUserIdSource la classe sont désormais déconseillées et seront supprimées dans le Kit de développement logiciel (SDK) v8.0. Vous pouvez utiliser setUserIds les méthodes et getUserIds dans la SDKSettings classe ANUserId décrites ci-dessous comme remplacement.
Fonction Description
void setPublisherUserId(String publisherUserId) Méthode qui définit l’ID utilisateur de publisher (first party) dans SDKSettings la classe dans l’API MobileSDK.
void setUserIds(List<ANUserId> userIdList) Méthode qui définit l’ID utilisateur dans ANSDKSettings la classe dans l’API MobileSDK.

Vous pouvez définir l’ID utilisateur en :
- création d’une liste d’objets ANUserId , et
- affectation de la liste à la setUserIds() méthode dans ANSDKSettings.

Xandr prend en charge les ID d’utilisateur des sources ci-dessous :
-Criteo
- Le Trade Desk
-Netid
- LiveRamp
- UID 2.0
- ID fourni par l’éditeur /PPID (les éditeurs peuvent inscrire leur propre source via l’API et passer l’ID utilisateur).

Remarque

  • L’ID de l’éditeur et l’ID d’utilisateur sont des paramètres globaux.
  • Il suffit de définir le ou les ID utilisateur une seule fois par session d’application, car ces valeurs sont utilisées dans toutes les demandes publicitaires consécutives dans la même session.
  • Xandr ne stocke pas ces valeurs dans différentes sessions d’application.

Exemple

List<ANUserId> userIds = new ArrayList<>();
ANUserId tradeDeskUserID = new ANUserId(ANUserId.Source.THE_TRADE_DESK, "userid-ttd-foobar");
userIds.add(tradeDeskUserID);
ANUserId criteoUserId = new ANUserId(ANUserId.Source.CRITEO, "userid-Criteo-foobar");
userIds.add(criteoUserId);
ANUserId netIdUserID = new ANUserId(ANUserId.Source.NETID, "userid-netid-foobar");
userIds.add(netIdUserID);
ANUserId liveRampUserID = new ANUserId(ANUserId.Source.LIVERAMP, "userid-liveramp-foobar");
userIds.add(liveRampUserID);
ANUserId UID2UserId = new ANUserId(ANUserId.Source.UID2, "userid-uid2-foobar");
userIds.add(UID2UserId);
ANUserId genericUserID = new ANUserId("Generic Source", "userid-generic-foobar");
userIds.add(genericUserID);
 
// Set User Id from External Sources
SDKSettings.setUserIds(userIds);
 
// Setting Publisher First Party Id
SDKSettings.setPublisherUserId("PublisherUserId-foobar");

Prise en charge de la substitution des codes pays et des codes postaux

Le Kit de développement logiciel (SDK) utilise les informations de ville/DMA/pays du flux standard (données au niveau du journal) à des fins de création de rapports. Toutefois, ces valeurs doivent être remplacées à partir des données de latitude et de longitude géocodées de l’inverseur pour conserver l’intégrité des données intactes. Si ces valeurs ne sont pas remplacées, les données au niveau du journal pointent vers les emplacements basés sur les adresses IP et projettent un jeu de données incorrect, en particulier avec des données mobiles.

Fonction Description
void setGeoOverrideCountryCode(String countryCode) Méthode qui affecte un code de pays. Il transmet la chaîne de code de pays comme argument dans la méthode .
void setGeoOverrideZipCode(String zipCode) Méthode qui affecte un code postal. Il transmet la chaîne de code postal comme argument dans la méthode .

Exemple

//Setter
SDKSettings.setGeoOverrideCountryCode("US");
SDKSettings.setGeoOverrideZipCode("10010");
  
//Getter
SDKSettings.getGeoOverrideCountryCode();
SDKSettings.getGeoOverrideZipCode();

Contrôles d’emplacement

Fonction Description
void setLocationDecimalDigits(int digitsAfterDecimal) Méthode permettant de contrôler la précision des données d’emplacement que vous transmettez au serveur publicitaire. Une meilleure localisation des données peut entraîner une meilleure monétisation de vos annonces.
void setLocationEnabledForCreative(boolean enabled) Méthode permettant de contrôler l’accès à l’emplacement pour les créatifs. La valeur par défaut est true. False désactive la fenêtre contextuelle d’emplacement du créatif.

Les créations rendues dans un WebView peuvent accéder à l’emplacement d’un utilisateur via les API d’emplacement HTML5.

Remarque :
- Par défaut, lorsqu’un créateur demande l’emplacement, une fenêtre contextuelle s’affiche pour les utilisateurs qui demandent l’autorisation explicite d’utiliser l’emplacement.
- Lorsque l’accès à l’emplacement est désactivé, les fenêtres contextuelles ne s’affichent pas aux utilisateurs et le créatif reçoit une erreur PERMISSION_DENIED pour les appels d’API d’emplacement HTML5.

L’argument digitsAfterDecimal entraîne l’arrondi interne de toutes les informations d’emplacement au nombre de chiffres spécifié après la décimale avant d’être passées au serveur publicitaire. La corrélation entre la valeur de et la distance de précision d’emplacement digitsAfterDecimal est la suivante :

Chiffres après décimal Précision de la résolution
2 Environ 1 kilomètre
3 Environ 100 mètres
4 Environ 10 mètres
-1 La résolution complète est passée

Exemple

SDKSettings.setLocationDecimalDigits(2);
SDKSettings.setLocationEnabledForCreative(false);

Threading d’arrière-plan

Importante

Cette offre est actuellement en alpha et est susceptible d’être modifiée.

Fonction Description
void enableBackgroundThreading(boolean enable) Méthode utilisée pour activer ou désactiver l’indicateur de fonctionnalité Threading en arrière-plan. L’activation de cette fonctionnalité permet à MobileSDK d’exécuter les demandes d’annonces pour différentes adunits telles que la bannière, l’interstitielle, le natif et les vidéos en tant que thread d’arrière-plan au lieu d’un thread d’interface utilisateur.

Par défaut, la valeur booléenne de la méthode est définie sur false (qui utilise AsyncTask d’Android).

Pour activer la fonctionnalité de thread d’arrière-plan, la valeur doit être définie sur true dans la méthode .

Remarque : cette méthode doit être appelée avant la init() méthode .

Exemple

// enable the Background threading
SDKSettings.enableBackgroundThreading(true);

Refus de l’utilisateur côté serveur de publication

Pour toute demande AdRequest, le SDK Xandr Mobile vérifie le niveau de l’appareil ou de l’environnement du système d’exploitation et remplit automatiquement la valeur de limitAdTracking (LMT) en arrière-plan. Si LMT=true, cela indique que l’utilisateur refuse le suivi sur les paramètres de l’appareil ou du système d’exploitation. Toutefois, les éditeurs conservent des informations sur l’opt-in/out du suivi de leurs utilisateurs et sont donc tenus de transmettre ces informations si leur utilisateur a choisi de se conformer à leurs réglementations en matière de confidentialité. Pour faciliter la même opération, la fonctionnalité de refus de l’utilisateur côté éditeur est introduite dans le Kit de développement logiciel (SDK) mobile.

Fonction Description
void setDoNotTrack(boolean dnt) Méthode qui active la fonctionnalité de désactivation de l’utilisateur côté éditeur.

Exemple

//Setter
SDKSettings.setDoNotTrack(true);
//Getter
SDKSettings.getDoNotTrack();

Définir l’utilisation d’AAID

L’IDENTIFIANT Google Advertising (AAID) pour les appareils est un ID fourni par Android pour suivre les utilisateurs avec leur consentement à des fins publicitaires par les éditeurs qui ont une application sur le Google Play Store. Une API est introduite dans le SDK mobile Xandr pour activer ou désactiver l’utilisation d’AAID en incluant ou en excluant le champ AAID dans la demande d’annonce.

Fonction Description
void disableAAIDUsage(boolean disable) Méthode permettant d’activer/désactiver l’objet disableAAIDUsage. La valeur par défaut est false.

Exemple

// To Set the disableAAIDUsage
SDKSettings.disableAAIDUsage(false);
// To Get the disableAAIDUsage status
SDKSettings.isAAIDUsageDisabled()

Définir le délai d’expiration de la vente aux enchères

Fonction Description
void setAuctionTimeout(long auctionTimeout) Définit le délai d’expiration, en millisecondes, pour attendre qu’un soumissionnaire réponde à une demande d’offre.

Si le soumissionnaire ne répond pas dans la valeur définie pour le délai d’expiration (par exemple, 500 millisecondes), la demande d’offre entraîne un échec.

Exemple

SDKSettings.setAuctionTimeout(500)

Définir le mode de test

Fonction Description
void enableTestMode(Boolean enabled) Définit true ou false pour les AdRequests à exécuter en mode test pour le débogage ou le test. La valeur par défaut est false.

Remarque : L’étendue de la définition du mode de test pour l’exécution d’AdRequest sur true est limitée à un objectif de débogage/développement ou de test uniquement, et ne doit pas être utilisée dans un environnement de production. L’activation du mode test dans un environnement de production entraîne des conséquences inattendues et a un impact sur la monétisation de votre application.

Exemple

SDKSettings.enableTestMode(true);

Définir la langue du contenu

Fonction Description
void setContentLanguage(String contentLanguage) Définit le code ANSI à deux lettres pour la langue du contenu ; par exemple, EN.

Exemple

SDKSettings.setContentLanguage("EN")
  • Last updated on