Obtener onboardings en Flutter SDK

Después de diseñar la parte visual de tu onboarding con el builder en el Adapty Dashboard, puedes mostrarlo en tu app Flutter. El primer paso es obtener el onboarding asociado al placement y su configuración de vista, como se describe a continuación.

Antes de empezar, asegúrate de que:

Tienes instalado el SDK de Adapty para Flutter en la versión 3.8.0 o superior.
Has creado un onboarding.
Has añadido el onboarding a un placement.

Obtener el onboarding

Cuando creas un onboarding con nuestro builder sin código, se almacena como un contenedor con la configuración que tu app necesita obtener y mostrar. Este contenedor gestiona toda la experiencia: qué contenido aparece, cómo se presenta y cómo se procesan las interacciones del usuario (como respuestas a cuestionarios o entradas de formularios). El contenedor también registra automáticamente los eventos de analíticas, por lo que no necesitas implementar un seguimiento de vistas por separado.

Para un mejor rendimiento, obtén la configuración del onboarding con antelación para dar tiempo suficiente a que las imágenes se descarguen antes de mostrárselas a los usuarios.

Para obtener un onboarding, utiliza el método getOnboarding:

try {
  final onboarding = await Adapty().getOnboarding(placementId: "YOUR_PLACEMENT_ID");
} on AdaptyError catch (e) {
    //handle error
} catch (e) { 
    //handle error
}

A continuación, llama al método createOnboardingView para obtener la vista que vas a mostrar.

El resultado del método createOnboardingView solo se puede usar una vez. Si necesitas usarlo de nuevo, vuelve a llamar al método createOnboardingView. Llamarlo dos veces sin recrearlo puede producir el error AdaptyUIError.viewAlreadyPresented.


try {
    final onboardingView = await Adapty().createOnboardingView(onboarding: onboarding);
} on AdaptyError catch (e) { 
    //handle error
} catch (e) { 
    //handle error
}

Parámetros:

Parámetro	Presencia	Descripción
placementId	obligatorio	El identificador del Placement deseado. Es el valor que especificaste al crear un placement en el Adapty Dashboard.
locale	opcional por defecto: `en`	El identificador de la localización del onboarding. Se espera que este parámetro sea un código de idioma compuesto por uno o dos subetiquetas separadas por el carácter menos (-). La primera subetiqueta corresponde al idioma y la segunda a la región. Ejemplo: `en` significa inglés, `pt-br` representa el portugués de Brasil.
fetchPolicy	por defecto: `.reloadRevalidatingCacheData`	Por defecto, el SDK intentará cargar los datos desde el servidor y devolverá los datos en caché en caso de fallo. Recomendamos esta opción porque garantiza que tus usuarios siempre reciban los datos más actualizados. Sin embargo, si crees que tus usuarios tienen conexiones inestables a internet, considera usar `.returnCacheDataElseLoad` para devolver los datos en caché si existen. En este caso, puede que los usuarios no reciban los últimos datos, pero experimentarán tiempos de carga más rápidos independientemente de lo inestable que sea su conexión. La caché se actualiza regularmente, por lo que es seguro usarla durante la sesión para evitar solicitudes de red. Ten en cuenta que la caché permanece intacta al reiniciar la app y solo se borra cuando se reinstala la app o mediante una limpieza manual. El SDK de Adapty almacena los onboardings localmente en dos capas: la caché de actualización regular descrita anteriormente y los onboardings de respaldo. También usamos CDN para obtener los onboardings más rápido y un servidor de respaldo independiente en caso de que el CDN no sea accesible. Este sistema está diseñado para garantizar que siempre obtengas la última versión de tus onboardings y asegurar la fiabilidad incluso cuando la conexión a internet es escasa.
loadTimeout	por defecto: 5 seg	Este valor limita el tiempo de espera de este método. Si se alcanza el tiempo límite, se devolverán los datos en caché o el respaldo local. Ten en cuenta que en casos excepcionales este método puede agotar el tiempo de espera ligeramente después de lo especificado en `loadTimeout`, ya que la operación puede consistir en diferentes solicitudes internamente.

Parámetros de respuesta:

Parámetro	Descripción
Onboarding	Un objeto `AdaptyOnboarding` con: el identificador y la configuración del onboarding, el Remote Config y otras propiedades.

Acelerar la obtención del onboarding con el onboarding de audiencia predeterminada

Por lo general, los onboardings se obtienen casi de forma instantánea, por lo que no es necesario preocuparse por acelerar este proceso. Sin embargo, en casos donde tienes muchas audiencias y onboardings, y tus usuarios tienen una conexión a internet débil, obtener un onboarding puede tardar más de lo deseable. En esas situaciones, puede que quieras mostrar un onboarding predeterminado para garantizar una experiencia fluida en lugar de no mostrar ninguno.

Para esto, puedes usar el método getOnboardingForDefaultAudience, que obtiene el onboarding del placement especificado para la audiencia All Users. Sin embargo, es fundamental entender que el enfoque recomendado es obtener el onboarding con el método getOnboarding, como se detalla en la sección Obtener el onboarding anterior.

Considera usar getOnboarding en lugar de getOnboardingForDefaultAudience, ya que este último tiene limitaciones importantes:

Problemas de compatibilidad: Puede crear problemas al admitir varias versiones de la app, lo que requiere diseños compatibles hacia atrás o aceptar que las versiones más antiguas puedan mostrarse incorrectamente.
Sin personalización: Solo muestra contenido para la audiencia “All Users”, eliminando la segmentación basada en país, atribución o atributos personalizados.

Si una obtención más rápida supera estos inconvenientes para tu caso de uso, utiliza getOnboardingForDefaultAudience como se muestra a continuación. De lo contrario, usa getOnboarding como se describe arriba.

try {
    final onboarding = await Adapty().getOnboardingForDefaultAudience(placementId: 'YOUR_PLACEMENT_ID');
} on AdaptyError catch (adaptyError) {
    // handle error
} catch (e) {
    // handle unknown error
}

Parámetros:

Parámetro Presencia Descripción

placementId obligatorio El identificador del Placement deseado. Es el valor que especificaste al crear un placement en el Adapty Dashboard.

locale

opcional

por defecto: en

El identificador de la localización del onboarding. Se espera que este parámetro sea un código de idioma compuesto por uno o dos subetiquetas separadas por el carácter menos (-). La primera subetiqueta corresponde al idioma y la segunda a la región.

Ejemplo: en significa inglés, pt-br representa el portugués de Brasil.

fetchPolicy

por defecto: .reloadRevalidatingCacheData

Por defecto, el SDK intentará cargar los datos desde el servidor y devolverá los datos en caché en caso de fallo. Recomendamos esta opción porque garantiza que tus usuarios siempre reciban los datos más actualizados.

Sin embargo, si crees que tus usuarios tienen conexiones inestables a internet, considera usar .returnCacheDataElseLoad para devolver los datos en caché si existen. En este caso, puede que los usuarios no reciban los últimos datos, pero experimentarán tiempos de carga más rápidos independientemente de lo inestable que sea su conexión. La caché se actualiza regularmente, por lo que es seguro usarla durante la sesión para evitar solicitudes de red.

Ten en cuenta que la caché permanece intacta al reiniciar la app y solo se borra cuando se reinstala la app o mediante una limpieza manual.

El SDK de Adapty almacena los onboardings localmente en dos capas: la caché de actualización regular descrita anteriormente y los onboardings de respaldo. También usamos CDN para obtener los onboardings más rápido y un servidor de respaldo independiente en caso de que el CDN no sea accesible. Este sistema está diseñado para garantizar que siempre obtengas la última versión de tus onboardings y asegurar la fiabilidad incluso cuando la conexión a internet es escasa.