Compartir a través de

Configuración del SDK de Android

  • Artículo

El SDK de Xandr Mobile proporciona varias configuraciones que puede usar para ayudarle en el desarrollo de la aplicación. En este artículo, encontrará detalles sobre los métodos, parámetros de entrada, valores devueltos, restricciones, directrices y ejemplos de la configuración del SDK de Android.

Función Descripción
void init() Activa OMID y captura el Agente de usuario y AAID (Id. de publicidad de Google) para los dispositivos.

Consulte Inicializar la configuración del SDK a continuación para obtener más detalles.
void setPublisherUserId(String publisherUserId) Envía los identificadores de primer fabricante del publicador y los identificadores de usuario de orígenes de terceros en las solicitudes de anuncios.

Para obtener más información, consulte Asignación de identificadores de usuario a continuación.
void setUserIds(List<ANUserId> userIdList) Establece el identificador de usuario en la clase ANSDKSettings.

Para obtener más información, consulte Asignación de identificadores de usuario a continuación.
void setGeoOverrideCountryCode(String countryCode) Asigna un código de país.

Consulte Compatibilidad con la invalidación de códigos de país y códigos postales a continuación para obtener más detalles.
void setGeoOverrideZipCode(String zipCode) Asigna un código postal.

Consulte Compatibilidad con la invalidación de códigos de país y códigos postales a continuación para obtener más detalles.
void setLocationDecimalDigits(int digitsAfterDecimal) Controla la precisión de los datos de ubicación que se pasan al servidor de anuncios.

Consulte Controles de ubicación a continuación para obtener más detalles.
void setLocationEnabledForCreative(Boolean enabled) Controla el acceso a la ubicación de los creativos.

Consulte Controles de ubicación a continuación para obtener más detalles.
void enableBackgroundThreading(Boolean enable) Habilita o deshabilita la marca de característica Subproceso en segundo plano.

Consulte Subprocesamiento en segundo plano a continuación para obtener más detalles.
void setDoNotTrack(Boolean dnt) Habilita la característica de exclusión del usuario del lado del publicador.

Para obtener más información, consulte La exclusión del usuario del lado del publicador a continuación.
void disableAAIDUsage(Boolean disable) Habilita o deshabilita disableAAIDUsage.

Consulte Establecer el uso de AAID a continuación para obtener más detalles.
void setAuctionTimeout(long auctionTimeout) Establece el período de tiempo de espera en milisegundos.

Consulte Establecer el tiempo de espera de la subasta a continuación para obtener más detalles.
void enableTestMode(Boolean enabled) Establece true o false para que AdRequests se ejecute en el modo de prueba.

Consulte Establecer modo de prueba a continuación para obtener más detalles.
void setContentLanguage(String contentLanguage) Establece el código para el idioma del contenido.

Consulte Establecer el idioma de contenido a continuación para obtener más detalles.

Inicializar la configuración del SDK

Función Descripción
void init(Context context, final InitListener listener)

Método sobrecargado:
void init(final Context context, final InitListener listener, final boolean fetchUserAgent, final boolean fetchAAID, final boolean enableWarmUpAdCall, final boolean preFetchWebView)		 El método que activa OMID, captura el Agente de usuario, AAID (id. de Google Advertising), habilita WarmUpAdCall y captura previa WebView para dispositivos.

Además, el método sobrecargado init() deshabilita opcionalmente la captura de AAID, UserAgent, enableWarmUpAdCally preFetchWebView. Requiere habilitar o deshabilitar valores booleanos para fetchUserAgent, fetchAAID, enableWarmUpAdCally preFetchWebView como argumentos.

Ejemplo

Método Init normal
SDKSettings.init(this, new SDKSettings.InitListener() {
    @Override
    public void onInitFinished() {
        // Initialisation finished
    }
});
Método Init sobrecargado con flexibilidad para habilitar o deshabilitar la captura del Agente de usuario, AAID, WarmUpAdCall y WebView de captura previa
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

Asignación de identificadores de usuario

Importante

  • Esta oferta está actualmente en Alfa y está sujeta a cambios o desuso sin previo aviso.
  • Los setExternalUid métodos y getExternalUid disponibles en las clases , VideoAd, BannerAdViewy InterstitialAdView están en NativeAdRequestdesuso. En su lugar, puede usar setPublisherUserId y getPublisherUserId describir a continuación en SDKSettings la clase . Los métodos en desuso se quitarán en SDK v8.0.
  • Los setExternalUserIds métodos y getExternalUserIds disponibles en la clase y ANExternalUserIdSource ahora están en SDKSettings desuso y se quitarán en SDK v8.0. Puede usar setUserIds métodos y getUserIds en la SDKSettings clase y ANUserId que se describen a continuación en su lugar como reemplazo.
Función Descripción
void setPublisherUserId(String publisherUserId) Método que establece el identificador de usuario de Publisher (First Party) en SDKSettings la clase en MobileSDK API.
void setUserIds(List<ANUserId> userIdList) Método que establece el identificador de usuario en la ANSDKSettings clase en mobileSDK API.

Puede establecer el identificador de usuario mediante :
- crear una lista de ANUserId objetos y
: se asigna la lista al setUserIds() método en ANSDKSettings.

Xandr admite los identificadores de usuario de los orígenes siguientes:
- Criteo
- El departamento de comercio
- NetID
- LiveRamp
- UID 2.0
- Id. proporcionado por el publicador/PPID (los editores pueden registrar su propio origen a través de la API y pueden pasar el identificador de usuario).

Nota:

  • El id. de publicador y el id. de usuario son configuraciones globales.
  • Basta con establecer los identificadores de usuario una vez por sesión de aplicación, ya que estos valores se usarían en todas las solicitudes de anuncios consecutivas de la misma sesión.
  • Xandr no almacena estos valores en diferentes sesiones de aplicaciones.

Ejemplo

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

Compatibilidad con la invalidación de códigos de país y códigos postales

El SDK usa información de ciudad,DMA/país de la fuente estándar (datos de nivel de registro) con fines de generación de informes. Sin embargo, estos valores deben sobrescribirse a partir de datos de latitud y longitud geocodificadas inversas para mantener intacta la cordura de los datos. Si esos valores no se sobrescriben, los datos de nivel de registro apuntarán a las ubicaciones basadas en direcciones IP y, finalmente, proyectarán un conjunto de datos incorrecto, especialmente con datos móviles.

Función Descripción
void setGeoOverrideCountryCode(String countryCode) Método que asigna un código de país. Pasará la cadena de código de país como argumento en el método .
void setGeoOverrideZipCode(String zipCode) Método que asigna un código postal. Pasará la cadena de código postal como argumento en el método .

Ejemplo

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

Controles de ubicación

Función Descripción
void setLocationDecimalDigits(int digitsAfterDecimal) Método para controlar la precisión de los datos de ubicación que se pasan al servidor de anuncios. Los mejores datos de ubicación pueden dar lugar a una mejor monetización de los anuncios.
void setLocationEnabledForCreative(boolean enabled) Método para controlar el acceso a la ubicación de los creativos. El valor predeterminado es "true". False deshabilita la ubicación emergente de la creatividad.

Las creatividades representadas en un WebView pueden acceder a la ubicación de un usuario a través de las API de ubicación HTML5.

Nota:
- De forma predeterminada, cuando un creativo solicita ubicación, se muestra un elemento emergente a los usuarios que solicitan permiso explícito para usar la ubicación.
- Cuando el acceso a la ubicación está deshabilitado, los elementos emergentes no se mostrarán a los usuarios y la creatividad recibirá un error de PERMISSION_DENIED para las llamadas a la API de ubicación HTML5.

El digitsAfterDecimal argumento hará que toda la información de ubicación se redondee internamente al número especificado de dígitos después del decimal antes de pasarse al servidor de anuncios. La correlación entre el valor de y la distancia de precisión de digitsAfterDecimal ubicación es la siguiente:

Dígitos después de Decimal Precisión de la resolución
2 Aprox. 1 kilómetro
3 Aprox. 100 metros
4 Aprox. 10 metros
-1 Se pasa la resolución completa

Ejemplo

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

Subprocesamiento en segundo plano

Importante

Esta oferta está actualmente en Alfa y está sujeta a cambios.

Función Descripción
void enableBackgroundThreading(boolean enable) Método usado para habilitar o deshabilitar la marca de característica Subproceso en segundo plano. Al habilitar esta característica, MobileSDK puede ejecutar las solicitudes de anuncios para diferentes AdUnits, como banner, intersticiales, nativos y vídeos como subproceso en segundo plano en lugar de un subproceso de interfaz de usuario.

De forma predeterminada, el valor booleano del método se establece en false (que usa AsyncTask de Android).

Para habilitar la característica del subproceso en segundo plano, el valor debe establecerse como true en el método .

Nota: Se debe llamar a este método antes del init() método .

Ejemplo

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

Exclusión del usuario del lado del publicador

Para cualquier AdRequest, el SDK de Xandr Mobile comprueba en el nivel de entorno del dispositivo o del sistema operativo y rellena automáticamente el valor de limitAdTracking (LMT) en segundo plano. Si LMT=true, indica que el usuario no puede realizar el seguimiento en la configuración del dispositivo o del sistema operativo. Sin embargo, los publicadores conservan información sobre la participación o no de seguimiento de sus usuarios y, por lo tanto, deben pasar esa información si su usuario ha optado por no cumplir con sus regulaciones de privacidad. Para facilitar la misma, se incluye la característica de exclusión de usuarios del lado del publicador en Mobile SDK.

Función Descripción
void setDoNotTrack(boolean dnt) Método que habilita la característica de exclusión del usuario del lado del publicador.

Ejemplo

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

Establecer el uso de AAID

El Id. de publicidad de Google (AAID) para dispositivos es un identificador proporcionado por Android para realizar un seguimiento de los usuarios con su consentimiento para fines publicitarios por parte de los editores que tienen una aplicación en Google Play Store. Se introduce una API en el SDK móvil de Xandr para habilitar o deshabilitar el uso de AAID mediante la inclusión o exclusión del campo AAID en la solicitud de anuncio.

Función Descripción
void disableAAIDUsage(boolean disable) Método para habilitar o deshabilitar disableAAIDUsage. El valor predeterminado es false.

Ejemplo

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

Establecer el tiempo de espera de la subasta

Función Descripción
void setAuctionTimeout(long auctionTimeout) Define el período de tiempo de espera, en milisegundos, para esperar a que un licitador responda a una solicitud de puja.

Si el licitador no responde dentro del valor establecido para el período de tiempo de espera (por ejemplo, 500 milisegundos), la solicitud de puja produciría un error.

Ejemplo

SDKSettings.setAuctionTimeout(500)

Establecer el modo de prueba

Función Descripción
void enableTestMode(Boolean enabled) Establece true o false para que AdRequests se ejecute en el modo de prueba para la depuración o las pruebas. El valor predeterminado es false.

Nota: El ámbito de establecer el modo de prueba para la ejecución de AdRequest como true se limita solo a fines de depuración o desarrollo o pruebas, y no se va a usar en un entorno de producción. La habilitación del modo de prueba en un entorno de producción provoca consecuencias no deseadas y afecta a la monetización de la aplicación.

Ejemplo

SDKSettings.enableTestMode(true);

Establecer el idioma de contenido

Función Descripción
void setContentLanguage(String contentLanguage) Establece el código ANSI de dos letras para el idioma del contenido; por ejemplo, EN.

Ejemplo

SDKSettings.setContentLanguage("EN")