An open API service indexing awesome lists of open source software.

https://github.com/chartboost/chartboost-core-android-sdk


https://github.com/chartboost/chartboost-core-android-sdk

Last synced: 7 months ago
JSON representation

Awesome Lists containing this project

README

          

# Android Chartboost Core & Mediation SDKs

![badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fchartboost.s3.amazonaws.com%2Fchartboost-mediation%2Fsdk%2Fandroid%2Fcode-coverage%2Fcoverage-percent.json)
![badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fchartboost.s3.amazonaws.com%2Fchartboost-core%2Fsdk%2Fandroid%2Fcode-coverage%2Fcoverage-percent.json)

The Android Chartboost Mediation SDK, by Chartboost, is a Unified-Auction & Mediated solution which helps developers increase their mobile apps' revenue with the inclusion of other supported Programmatic & Mediated SDKs.

Chartboost Core Android SDK is designed as an entry point to manage and facilitate different modules for your Android application/game. Each module can be individually initialized with metrics collected and reported to offer detailed insights into the module’s performance and potential issues.

The main functionalities provided by the SDK are:

1. Initialization of individual or a set of modules.
2. Performance metrics collection during the module initialization process.
3. Detailed error tracking and reporting with categorized error codes.
4. Centralized logging system with multiple log levels and output options.

## Get Started on Android

See [Developer Docs](https://developers.chartboost.com) for detailed instructions.

----

## Before You Begin

- Have you signed up for a Chartboost Mediation Account?
- Did you [add an app](https://developers.chartboost.com/docs/import-apps-into-helium) to the Chartboost Mediation Dashboard?
- Have you [set up Ad Placements](https://developers.chartboost.com/docs/manage-placements) in the Chartboost Mediation Dashboard?

## Minimum Supported Development Tools

| Software | Version |
| :------------- | :------------------ |
| Android Studio | 2020.3.1+ |
| Android OS | 5.0+ (API level 21) |

## Add the Chartboost Core SDK and the Chartboost Mediation SDK to your project

For `build.gradle`

```gradle
repositories {
maven {
name "Chartboost Mediation's maven repo"
url "https://cboost.jfrog.io/artifactory/chartboost-mediation"
}
maven {
name "Chartboost Core's maven repo"
url "https://cboost.jfrog.io/artifactory/chartboost-core"
}
}

dependencies {
implementation("com.chartboost:chartboost-core-sdk:1.0.0")
implementation("com.chartboost:chartboost-mediation-sdk:5.0.0")
}
```

## Add 3rd-Party Dependencies

```gradle
implementation("androidx.lifecycle:lifecycle-common:2.6.2")
implementation("androidx.lifecycle:lifecycle-extensions:2.2.0")
implementation("com.jakewharton.retrofit:retrofit2-kotlinx-serialization-converter:1.0.0")
implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.10")
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.9.21")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.3")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.1")
implementation("com.squareup.okhttp3:logging-interceptor:4.11.0")
implementation("com.squareup.okhttp3:okhttp:4.11.0")
implementation("com.squareup.retrofit2:converter-scalars:2.9.0")
implementation("com.squareup.retrofit2:retrofit:2.9.0")
```

## Add Google Play Services

Add the Google Play Services Library as a dependency of your project. For detailed instructions, reference the official integration instructions for [Google Play Services](https://developers.google.com/android/guides/setup).

As opposed to referencing the entire Google Play Services package, you only need `play-services-base`, `play-services-ads-identifier`, and `play-services-appset`:

```gradle
implementation 'com.google.android.gms:play-services-base:18.1.0'
implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
implementation 'com.google.android.gms:play-services-appset:16.0.2'
```

### OPTIONAL STEP: Download the Chartboost Mediation Android Sample App

The Chartboost Mediation Android Sample App is no longer distributed via a package and has been moved to a public GitHub repo.

- [Chartboost Mediation Android SDK Sample App](https://github.com/ChartBoost/android-chartboost-mediation-sdk-example)