> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gameball.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation Guide (SDK v4)

> Step-by-step instructions to integrate Gameball SDK v4 with your application across supported platforms.

> [!NOTE]
>
> This guide is for **SDK v4**, which adds in-app messaging and purchase logging to the mobile SDKs. Every v3 call keeps its signature and behavior. For SDK v3 or v2 documentation, switch versions using the dropdown above.

> [card] [Web](https://docs.gameball.co/installation-guides/v4/web.md)
>
> Integrate Gameball with your website or web application using the JavaScript SDK

> [card] [Android](https://docs.gameball.co/installation-guides/v4/android.md)
>
> Integrate Gameball with your Android application using SDK v4.0.0

> [card] [Flutter](https://docs.gameball.co/installation-guides/v4/flutter.md)
>
> Integrate Gameball with your Flutter application using SDK v4.0.0

> [card] [React Native](https://docs.gameball.co/installation-guides/v4/react-native.md)
>
> Integrate Gameball with your React Native application using SDK v4.0.0

> [card] [iOS](https://docs.gameball.co/installation-guides/v4/ios.md)
>
> Integrate Gameball with your iOS application using SDK v4.0.0

> [card] [POS](https://docs.gameball.co/installation-guides/v4/pos.md)
>
> Integrate Gameball with your point-of-sale system using the REST API

## What's New in SDK v4

> [card] In-App Messaging
>
> Display the slide-up, modal, and full-screen campaigns you create in the Gameball dashboard

> [card] Purchase Logging
>
> Send purchases with `logPurchase` so campaigns can target and filter on them

> [card] New Platform Minimums
>
> iOS 15.0 and Android API 24 (Android 7.0) are now the minimum supported versions

> [card] Compatible with v3
>
> Every v3 call works unchanged, so upgrading needs no code changes

## What You'll Learn

Each platform guide covers the essential integration steps:

* **Getting Started** - Install the SDK and set up dependencies
* **Initialize SDK** - Configure the SDK with the builder pattern
* **Initialize Customer Profile** - Register customers and show the profile widget
* **Track Customer Events** - Send customer actions and behaviors to Gameball
* **Track Referrals** - Implement referral tracking
* **In-App Messaging** - Display dashboard in-app campaigns in your app
* **Go-Live Checklist** - Ensure everything is ready for production
* **Migration Notes** - Upgrade from v3 to v4, or migrate from v2

## Prerequisites

Before starting your integration, make sure you have:

* A Gameball account with API credentials
* Your application's development environment set up
* Basic understanding of your chosen platform's development workflow

> [!TIP]
>
> SDK v4.0.0 is available for **Android**, **Flutter**, **React Native**, and **iOS**. The Web SDK with in-app messaging is not released yet.

## Upgrading from v3

If you're currently using SDK v3, see the migration notes for your platform:

* [iOS v3 to v4 Migration Guide](https://docs.gameball.co/installation-guides/v4/ios/migration-notes.md)
* [Android v3 to v4 Migration Guide](https://docs.gameball.co/installation-guides/v4/android/migration-notes.md)
* [Flutter v3 to v4 Migration Guide](https://docs.gameball.co/installation-guides/v4/flutter/migration-notes.md)
* [React Native v3 to v4 Migration Guide](https://docs.gameball.co/installation-guides/v4/react-native/migration-notes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.