Configuración del SDK de Android

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

Función Descripción
void init() Activa OMID, recupera el agente de usuario y AAID (ID de publicidad de Google) para dispositivos.

Consulte Inicializar la configuración de SDK a continuación para obtener más información.
void setPublisherUserId(String publisherUserId) Envía el identificador de origen del publicador y los identificadores de usuario de fuentes de terceros en solicitudes de anuncios.

Consulte Asignación de ID(s) de usuario a continuación para obtener más detalles.
void setUserIds(List<ANUserId> userIdList) Establece el identificador de usuario en la clase ANSDKSettings.

Consulte Asignación de ID(s) de usuario a continuación para obtener más detalles.
void setGeoOverrideCountryCode(String countryCode) Asigna un código de país.

Consulte Compatibilidad para invalidar 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 para invalidar 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.

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

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

Consulte Conversaciones en segundo plano más abajo para obtener más detalles.
void setDoNotTrack(Boolean dnt) Habilita la característica de no participación del usuario del lado del editor.

Consulte Opción de no participar del usuario del lado del editor a continuación para obtener más detalles.
void disableAAIDUsage(Boolean disable) Habilita o deshabilita el disableAAIDUsage.

Consulte Establecer el uso de AAID a continuación para obtener más detalles.
void setAuctionTimeout(long auctionTimeout) Establece el periodo 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 verdadero o falso para las AdRequests que se ejecutarán 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 del idioma del contenido.

Consulte Establecer el idioma del contenido a continuación para obtener más detalles.
void setOMIDOptimizationEnabled(boolean enabled) Habilita o deshabilita la optimización del ciclo de vida de la sesión de OMID para anuncios nativos.

Consulte Optimización OMID a continuación para obtener más detalles.
boolean isOMIDOptimizationEnabled() Devuelve si la optimización del ciclo de vida de la sesión OMID está habilitada.

Inicializar la configuración de 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)		 Método que activa OMID, captura el agente de usuario, AAID (Google Advertising ID), habilita WarmUpAdCall y precaptura WebView para dispositivos.

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

Ejemplo

Método de inicio regular
SDKSettings.init(this, new SDKSettings.InitListener() {
    @Override
    public void onInitFinished() {
        // Initialisation finished
    }
});
Método Init sobrecargado con flexibilidad para habilitar / deshabilitar la recuperación de User Agent, AAID, WarmUpAdCall y 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

Asignación de id. de usuario

Importante

  • Esta oferta se encuentra actualmente en Alfa y está sujeta a cambios o a desuso sin previo aviso.
  • Los setExternalUid métodos y getExternalUid disponibles en NativeAdRequest, VideoAd, BannerAdView, y InterstitialAdView las clases están en desuso. En su lugar, puede usar setPublisherUserId y getPublisherUserId descrito a continuación en SDKSettings clase. Los métodos en desuso se quitarán en SDK v8.0.
  • Los setExternalUserIds métodos and getExternalUserIds disponibles en SDKSettings class y ANExternalUserIdSource class ahora están en desuso y se quitarán en SDK v8.0. En su lugar, puede usar setUserIds y métodos en getUserIds la clase y ANUserId clase descritos a SDKSettings continuación como reemplazo.
Función Descripción
void setPublisherUserId(String publisherUserId) Método que establece el ID de usuario del publicador (propio) en SDKSettings la clase en la API de MobileSDK.
void setUserIds(List<ANUserId> userIdList) Método que establece el ID de usuario en la clase en ANSDKSettings la API MobileSDK.

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

Xandr admite ID de usuario de las siguientes fuentes:
- Criteo
- La mesa de comercio
- Identificación neta
- Rampa en vivo
- UID 2.0
- Identificación proporcionada por el editor / PPID (los editores pueden registrar su propia fuente a través de la API y pueden pasar la identificación del usuario).

Nota:

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

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 para invalidar 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) para la creación de informes. Sin embargo, estos valores deben sobrescribirse a partir de datos de latitud y longitud geocodificados del inversor para mantener intacta la cordura de los datos. Si esos valores no se sobrescriben, los datos a 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. Unos mejores datos de ubicación pueden conducir 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 ventana emergente de ubicación de la creatividad.

Las creatividades renderizadas 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 una creatividad solicita la ubicación, se muestra una ventana emergente a los usuarios que solicitan permiso explícito para usar la ubicación.
- Cuando el acceso de ubicación está inhabilitado, no se mostrarán ventanas emergentes a los usuarios y la creatividad recibirá un error 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 ha aprobado la resolución completa

Ejemplo

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

Subprocesos en segundo plano

Importante

Esta oferta se encuentra actualmente en alfa y está sujeta a cambios.

Función Descripción
void enableBackgroundThreading(boolean enable) Método utilizado para habilitar o deshabilitar la marca de característica Subprocesos en segundo plano. Habilitar esta función permite a MobileSDK ejecutar las solicitudes de anuncios para diferentes AdUnits como banner, intersticial, nativo y videos como un hilo de fondo en lugar de un hilo 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 de subprocesos en segundo plano, el valor debe establecerse como verdadero en el método.

Nota: Este método debe llamarse antes que el init() método.

Ejemplo

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

Rechazo del usuario del lado del publicador

Para cualquier AdRequest, Xandr Mobile SDK comprueba 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 opta por no realizar el seguimiento en la configuración del dispositivo o del sistema operativo. Sin embargo, los editores conservan la información sobre la opción de realizar o no el seguimiento por parte de sus usuarios y, por tanto, deben transmitir esa información si su usuario ha optado por no cumplir con las normas de privacidad. Para facilitar el mismo, la función de exclusión voluntaria del lado del editor se introduce en Mobile SDK.

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

Ejemplo

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

Establecer el uso de AAID

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

Función Descripción
void disableAAIDUsage(boolean disable) Método para habilitar o deshabilitar el 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 licitante responda a una solicitud de oferta.

Si el licitante no responde dentro del valor establecido para el período de tiempo de espera (por ejemplo, 500 milisegundos), la solicitud de oferta resultará en un error.

Ejemplo

SDKSettings.setAuctionTimeout(500)

Establecer el modo de prueba

Función Descripción
void enableTestMode(Boolean enabled) Establece verdadero o falso para los AdRequests que se ejecutarán en el modo de prueba para su depuración o prueba. El valor predeterminado es false.

Nota: El alcance de establecer el modo de prueba para la ejecución de AdRequest como verdadero se limita solo a la depuración/desarrollo o a las pruebas, y no debe usarse en un entorno de producción. Habilitar el modo de prueba en un entorno de producción tiene consecuencias no deseadas e impactos en la monetización de la aplicación.

Ejemplo

SDKSettings.enableTestMode(true);

Establecer idioma del 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")

Optimización OMID

Utilice los métodos siguientes en SDKSettings:

Método Descripción
public static void setOMIDOptimizationEnabled(boolean enabled) Habilita o deshabilita la optimización del ciclo de vida de la sesión de OMID para anuncios nativos. El valor predeterminado es false.
public static boolean isOMIDOptimizationEnabled() Devuelve si la optimización del ciclo de vida de la sesión OMID está habilitada.

Para obtener información sobre el comportamiento, el ámbito y los ejemplos, consulte Habilitar la optimización de OMID.

  • Last updated on