Android SDK Integration Guide - EngageLab

Guía de integración del SDK de canal de fabricantes

Este documento tiene como objetivo guiar a los clientes en la integración de los SDK de diversos canales de fabricantes mediante un método de integración automatizada, para lograr notificaciones push sin conexión.

Para descargar el SDK, consulte Descarga de recursos.
Para conocer el número de la versión más reciente del SDK, consulte el Registro de cambios.

Requisitos previos

1. Ya se ha integrado el canal Engagelab.
2. Antes de integrar el SDK del fabricante, se deben solicitar los parámetros correspondientes del canal del fabricante. Para más detalles, consulte la Guía de solicitud de parámetros del canal del fabricante.

Archivos de recursos

• Colocar el icono de notificación denominado mtpush_notification_icon.png en res/drawable/. Si no se configura, el SDK utilizará el icono de la aplicación y, en versiones superiores de Android, pueden producirse problemas de visualización.

Guía de integración del canal Xiaomi

Configurar compatibilidad con mavenCentral

Configurar la compatibilidad con mavenCentral en el archivo gradle principal del directorio raíz del proyecto. (Por lo general, los proyectos nuevos vienen configurados con esta compatibilidad de forma predeterminada).

              
              buildscript {  
    repositories {  
        mavenCentral()  
    }  
}  

allprojects {
    repositories {  
        mavenCentral()  
    } 
}

            

Configurar dependencias

En la sección dependencies del archivo gradle del módulo de la aplicación, añadir el siguiente código:

              
              dependencies {
    // La versión del fabricante debe coincidir con la versión del SDK de Engagelab
    implementation 'com.engagelab.plugin:mi:5.x.x'
}

            

Configurar parámetros

En la sección defaultConfig del archivo gradle del módulo de la aplicación, añadir el siguiente código:

              
              manifestPlaceholders = [
    // Establecer variables en el archivo manifest.xml
    XIAOMI_APPKEY : "MI-Your Xiaomi app's APPID", // appkey registrada en la plataforma Xiaomi
    XIAOMI_APPID : "MI-Your Xiaomi app's APPKEY", // appid registrada en la plataforma Xiaomi
]

            

Configurar ofuscación de código

Si se utiliza proguard, añadir el siguiente contenido al archivo de configuración para evitar que informes de advertencias falsas impidan una compilación correcta:

              
              -dontwarn com.xiaomi.push.**
-keep class com.xiaomi.push.** { *; }

            

Validación de integración correcta

Si la integración es correcta, el registro mostrará lo siguiente:

              
              D  [MTMiBusiness] support xiaomi push
D  [MTMiBusiness] onTokenSuccess:get token is Tv3KBknVcnEaXnLe89MGEH3SWVgUYdLDYzJaST30IoIGATl2tv5eu6iuT/PTO0Mj
D  [MTPlatformBusiness] onPlatformTokenSuccess, rid:5, platformToken:
{
    platform=1,
    token=Tv3KBknVcnEaXnLe89MGEH3SWVgUYdLDYzJaST30IoIGATl2tv5eu6iuT/PTO0Mj
    region=NULL
    isUserSettings=false
}

            

Método de prueba del canal Xiaomi

1. Ir a [EngageLab Console] -> [AppPush] -> [Basic Settings] -> [Integration Settings], introducir los parámetros AppKey, AppID, AppSecret y hacer clic en "Save".
2. Tras finalizar el proceso de la app, realizar un push. Si se recibe el push, la integración del canal del fabricante se ha realizado correctamente.

Guía de integración del canal Huawei

Configurar compatibilidad con mavenCentral

Configurar la compatibilidad con mavenCentral y la dependencia de agconnect en el archivo gradle principal del directorio raíz del proyecto.

(El resto del contenido del canal Huawei se mantiene sin cambios, excepto esta corrección terminológica).

Guía de integración del canal Meizu

Configurar compatibilidad con mavenCentral

En el archivo gradle principal del directorio raíz del proyecto, configurar la compatibilidad con mavenCentral. (Por lo general, los proyectos nuevos vienen configurados con esta compatibilidad de forma predeterminada).

Configurar dependencias

              
              dependencies {
  // La versión del fabricante debe coincidir con la versión del SDK de AppPush
  implementation 'com.engagelab.plugin:meizu:5.x.x'
  // Para el fabricante Meizu, a partir de la versión 5.2.0 del SDK, es necesario integrar "com.engagelab.plugin:meizu_th_push"; esta línea no es necesaria antes de la versión 5.2.0.
  // La versión del fabricante debe coincidir con la versión del SDK de AppPush.
  implementation 'com.engagelab.plugin:meizu_th_push:5.2.0'
}

            

(El resto del contenido del canal Meizu se mantiene sin cambios).

Guía de integración del canal Vivo

Configurar compatibilidad con mavenCentral

En el archivo gradle principal del directorio raíz del proyecto, configurar la compatibilidad con mavenCentral. (Por lo general, los proyectos nuevos vienen configurados con esta compatibilidad de forma predeterminada).

(Resto del contenido sin cambios).

Guía de integración del canal OPPO

Configurar compatibilidad con mavenCentral

En el archivo gradle principal del directorio raíz del proyecto, configurar la compatibilidad con mavenCentral. (Por lo general, los proyectos nuevos vienen configurados con esta compatibilidad de forma predeterminada).

Método de prueba del canal OPPO

1. Ir a [EngageLab Console] -> [AppPush] -> [Basic Settings] -> [Integration Settings], introducir los parámetros AppKey, AppID, AppSecret, MasterSecret y hacer clic en "Save".
2. Tras finalizar el proceso de la app, realizar un push. Si se recibe el push, la integración del canal del fabricante se ha realizado correctamente.

Guía de integración del canal FCM

Configurar compatibilidad con mavenCentral

En el archivo gradle principal del directorio raíz del proyecto, configurar la compatibilidad con mavenCentral y la dependencia de google-services.

Método de prueba del canal FCM

1. Requisitos previos para las pruebas:
   • El sistema del teléfono debe tener Google Play services, versión 17.3.4 o superior.
   • Para las pruebas es necesario conectarse a una VPN en el extranjero y asegurarse de que la red del teléfono puede acceder a Google.
   • Si se utiliza un dispositivo de la región para las pruebas, la app debe permanecer en segundo plano; la prueba fallará si la app se cierra, ya que los fabricantes nacionales pueden finalizar el proceso en segundo plano.

(Resto del contenido sin cambios).

Guía de integración del canal Honor

Configurar compatibilidad con mavenCentral

En el archivo gradle principal del directorio raíz del proyecto, configurar la compatibilidad con mavenCentral. (Por lo general, los proyectos nuevos vienen configurados con esta compatibilidad de forma predeterminada.)

(Resto del contenido sin cambios).