diff --git a/_docs/_developer_guide/platform_integration_guides/android/initial_sdk_setup/android_sdk_integration.md b/_docs/_developer_guide/platform_integration_guides/android/initial_sdk_setup/android_sdk_integration.md index a971629c0b2..df175f2a1d3 100644 --- a/_docs/_developer_guide/platform_integration_guides/android/initial_sdk_setup/android_sdk_integration.md +++ b/_docs/_developer_guide/platform_integration_guides/android/initial_sdk_setup/android_sdk_integration.md @@ -140,3 +140,7 @@ Braze will now be able to collect [specified data from your application]({{site. Visit the following articles in order to enable [custom event tracking]({{site.baseurl}}/developer_guide/platform_integration_guides/android/analytics/tracking_custom_events/), [push messaging]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/integration/standard_integration/), [Content Cards]({{site.baseurl}}/developer_guide/platform_integration_guides/android/content_cards/integration/) and the complete suite of Braze features. +{% alert warning %} +If your app requires additional setup before SDK initialization—such as fetching configuration data from a server or waiting for user consent—see [Delayed Initialization]({{site.baseurl}}/developer_guide/platform_integration_guides/android/initialization/delayed_initialization/). +{% endalert %} + diff --git a/_docs/_developer_guide/platform_integration_guides/android/initialization.md b/_docs/_developer_guide/platform_integration_guides/android/initialization.md new file mode 100644 index 00000000000..a07b9225a4f --- /dev/null +++ b/_docs/_developer_guide/platform_integration_guides/android/initialization.md @@ -0,0 +1,7 @@ +--- +nav_title: Initialization +page_order: 0.2 +config_only: true +noindex: true +layout: blank_config +--- diff --git a/_docs/_developer_guide/platform_integration_guides/android/initialization/delayed_initialization.md b/_docs/_developer_guide/platform_integration_guides/android/initialization/delayed_initialization.md new file mode 100644 index 00000000000..0a5bc40f6ad --- /dev/null +++ b/_docs/_developer_guide/platform_integration_guides/android/initialization/delayed_initialization.md @@ -0,0 +1,152 @@ +--- +nav_title: Delayed Initialization +article_title: Delayed Initialization for Android and FireOS +platform: + - Android + - FireOS +page_order: 0 +description: "This article covers how to implement delayed initialization on the Android SDK and optionally preserve push notification analytics when delayed initialization is enabled." + +--- + +# Delayed initialization for the Braze Android SDK + +> Learn how to enable delayed initialization and opt in to preserve push notification analytics when it is enabled. This can be useful when you need to set up other services before initializing the SDK, such as fetching configuration data from a server or waiting for user consent. + +{% alert note %} +While delayed initialization is enabled, all network connections will be canceled, and the Braze SDK will not pass any data to Braze servers. +{% endalert %} + +## Prerequisites + +To use this feature, you'll need to Braze Android SDK version XXXX or later. + +## Enabling delayed initialization + +Delayed initialization is disabled by default. To enable, use one of the following options: + +{% tabs %} +{% tab Braze XML file %} +In your project's `braze.xml` file, set `com_braze_enable_delayed_initialization` to `true`. + +```xml +true +``` +{% endtab %} + +{% tab At runtime %} +To enable delayed initialization at runtime, use the following method. + +{% subtabs %} +{% subtab JAVA %} + +```java +Braze.enableDelayedInitialization(context); +``` + +{% endsubtab %} +{% subtab KOTLIN %} + +```kotlin +Braze.enableDelayedInitialization(context) +``` + +{% endsubtab %} +{% endsubtabs %} +{% endtab %} +{% endtabs %} + +## Configuring push analytics + +When delayed initialization is enabled, push analytics are queued by default. However, you can choose to explicitly queue or drop push analytics instead. + +### Explicitly queue + +To explicitly queue push analytics, choose one of the following options: + +{% tabs %} +{% tab Braze XML file %} +In your `braze.xml` file, set `com_braze_delayed_initialization_analytics_behavior` to `QUEUE`: + +```xml +QUEUE +``` +{% endtab %} + +{% tab At runtime %} +Add `QUEUE` to your [`Braze.enableDelayedInitialization()`](LINK) method: + +{% subtabs %} +{% subtab JAVA %} + +```java +Braze.enableDelayedInitialization(context, DelayedInitializationAnalyticsBehavior.QUEUE); +``` + +{% endsubtab %} +{% subtab KOTLIN %} + +```kotlin +Braze.enableDelayedInitialization(context, DelayedInitializationAnalyticsBehavior.QUEUE) +``` + +{% endsubtab %} +{% endsubtabs %} +{% endtab %} +{% endtabs %} + +### Drop + +To drop push analytics, choose one of the following options: + +{% tabs %} +{% tab Braze XML file %} +In your `braze.xml` file, set `com_braze_delayed_initialization_analytics_behavior` to `DROP`: + +```xml +DROP +``` +{% endtab %} + +{% tab At runtime %} +Add `DROP` to [`Braze.enableDelayedInitialization()`](LINK) method: + +{% subtabs %} +{% subtab JAVA %} + +```java +Braze.enableDelayedInitialization(context, DelayedInitializationAnalyticsBehavior.DROP); +``` + +{% endsubtab %} +{% subtab KOTLIN %} + +```kotlin +Braze.enableDelayedInitialization(context, DelayedInitializationAnalyticsBehavior.DROP) +``` + +{% endsubtab %} +{% endsubtabs %} +{% endtab %} +{% endtabs %} + +## Initializing after the delay + +To initialize the SDK after your chosen delay period, use the [`Braze.disableDelayedInitialization()`](LINK) method: + +{% tabs local %} +{% tab JAVA %} + +```java +Braze.disableDelayedInitialization(context); +``` + +{% endtab %} +{% tab KOTLIN %} + +```kotlin +Braze.disableDelayedInitialization(context) +``` + +{% endtab %} +{% endtabs %} diff --git a/_docs/_developer_guide/platform_integration_guides/android/advanced_use_cases/android_google_tag_manager.md b/_docs/_developer_guide/platform_integration_guides/android/initialization/google_tag_manager.md similarity index 99% rename from _docs/_developer_guide/platform_integration_guides/android/advanced_use_cases/android_google_tag_manager.md rename to _docs/_developer_guide/platform_integration_guides/android/initialization/google_tag_manager.md index cd9fac5af79..6853dcd28d4 100644 --- a/_docs/_developer_guide/platform_integration_guides/android/advanced_use_cases/android_google_tag_manager.md +++ b/_docs/_developer_guide/platform_integration_guides/android/initialization/google_tag_manager.md @@ -4,7 +4,7 @@ article_title: Google Tag Manager for Android for Android and FireOS platform: - Android - FireOS -page_order: 8 +page_order: 1 description: "This reference article covers how to initialize, configure, and implement the Google Tag manager into your Android or FireOS app." --- diff --git a/_docs/_developer_guide/platform_integration_guides/android/advanced_use_cases/runtime_configuration.md b/_docs/_developer_guide/platform_integration_guides/android/initialization/runtime_configuration.md similarity index 99% rename from _docs/_developer_guide/platform_integration_guides/android/advanced_use_cases/runtime_configuration.md rename to _docs/_developer_guide/platform_integration_guides/android/initialization/runtime_configuration.md index 771f3136109..17f17baa8c4 100644 --- a/_docs/_developer_guide/platform_integration_guides/android/advanced_use_cases/runtime_configuration.md +++ b/_docs/_developer_guide/platform_integration_guides/android/initialization/runtime_configuration.md @@ -4,7 +4,7 @@ article_title: Runtime Configuration for Android and FireOS platform: - Android - FireOS -page_order: 4 +page_order: 10 description: "This reference article covers how to set up runtime configuration for your Android or FireOS application." --- diff --git a/assets/js/broken_redirect_list.js b/assets/js/broken_redirect_list.js index 2a715c786e9..0d6680c0e35 100644 --- a/assets/js/broken_redirect_list.js +++ b/assets/js/broken_redirect_list.js @@ -1255,4 +1255,7 @@ validurls['/docs/pt-br/'] = '/docs/'; validurls['/docs/es/'] = '/docs/'; validurls['/docs/user_guide/engagement_tools/canvas/create_a_canvas/preview_user_paths/'] = '/docs/user_guide/engagement_tools/canvas/testing_canvases/preview_user_paths/'; +validurls['/docs/developer_guide/platform_integration_guides/android/advanced_use_cases/google_tag_manager'] = '/docs/developer_guide/platform_integration_guides/android/initialization/google_tag_manager'; +validurls['/docs/developer_guide/platform_integration_guides/android/advanced_use_cases/runtime_configuration'] = '/docs/developer_guide/platform_integration_guides/android/initialization/runtime_configuration'; + // validurls['OLD'] = 'NEW';