Skip to main content

​
Overview

CloudX Mobile SDK provides a comprehensive API for integrating mobile advertising into your applications. The SDK is available for both Android and iOS platforms with consistent functionality and naming conventions.

​
Platform-Specific Documentation

Android API Reference

Complete Android SDK API documentationPackage: io.cloudx.sdkVersion: 0.6.1Language: Kotlin / Java

iOS API Reference

Complete iOS SDK API documentationFramework: CloudXCoreVersion: 1.1.57Language: Swift / Objective-C

​
SDK Versions

​
Current Releases

PlatformVersionRelease DateMin Version
Android0.6.1LatestAndroid 5.0 (API 21)
iOS1.1.57LatestiOS 14.0

​
Installation

  • Android (Gradle)
  • iOS (CocoaPods)
  • iOS (SPM)
build.gradle.kts
dependencies {
    implementation("io.cloudx:sdk:0.6.1")
    implementation("io.cloudx:adapter-cloudx:0.6.1")
    implementation("io.cloudx:adapter-meta:0.6.1")
}

​
Supported Ad Formats

Both platforms support the same ad formats with consistent behavior:
Ad FormatDescriptionSize
BannerStandard banner ads320x50
MRECMedium Rectangle300x250
InterstitialFull-screen adsFullscreen
RewardedRewarded video adsFullscreen
Native SmallNative ad small320x90
Native MediumNative ad medium320x250

​
Core Features

​
Initialization

Both SDKs require initialization with an App Key from the CloudX dashboard before loading ads.

​
Ad Lifecycle

  • Load - Request ad from network
  • Show - Display ad to user (fullscreen only)
  • Callbacks - Receive events (loaded, failed, clicked, etc.)
  • Destroy - Clean up resources

​
Privacy & Compliance

  • GDPR - IAB TCF 2.0 support
  • CCPA - US Privacy String support
  • COPPA - Age-restricted user support
  • GPP - Global Privacy Platform support

​
Targeting

  • Custom key-value pairs
  • User-level targeting
  • App-level targeting
  • Hashed user IDs

​
Network Adapters

  • CloudX - Native CloudX network
  • Meta - Facebook Audience Network
  • Vungle - Vungle/Liftoff (iOS only)
  • InMobi - InMobi network (iOS only)

​
Platform Requirements

​
Android

  • Min SDK: 21 (Android 5.0)
  • Target SDK: 35
  • Compile SDK: 35
  • Kotlin: 1.9.0+
  • Java: 8+
  • Gradle: 8.0+

​
iOS

  • Min iOS: 14.0
  • Xcode: 12.0+
  • Swift: 5.0+
  • Objective-C: Fully supported
  • CocoaPods: 1.10+
  • Swift Package Manager: Supported

​
API Design Philosophy

​
Consistency

Both SDKs follow similar patterns:
  • Singleton initialization
  • Delegate/Listener callbacks
  • Similar method names
  • Consistent error codes

​
Type Safety

  • Strong typing in both Kotlin and Swift
  • Enums for error codes and log levels
  • Data classes for configuration

​
Error Handling

  • Standardized error codes (100-799 range)
  • Detailed error messages
  • Callback-based error reporting

​
Common Error Codes

Both platforms use the same error code ranges:
Code RangeCategoryDescription
100-199InitializationSDK initialization errors
200-299NetworkNetwork connectivity issues
300-399Ad LoadingAd request and loading errors
400-499Ad DisplayAd display and presentation errors
500-599ConfigurationSDK configuration errors
600-699AdapterNetwork adapter errors
700-799GeneralGeneral/unexpected errors

Android Quickstart

Get started with Android SDK in 5 minutes

iOS Quickstart

Get started with iOS SDK in 5 minutes

Android Configuration

Privacy, targeting, and advanced settings

iOS Configuration

Privacy, targeting, and advanced settings

​
Migration Guides

​
Version Updates

Check the changelog for version-specific updates and breaking changes.
Check the changelog for version-specific updates and breaking changes.

​
Support & Resources

Support

Contact our support team

Dashboard

Manage your apps and placements

GitHub

View source and report issues