This guide shows you how to use the Google Mobile Ads SDK to load and display ads from Chartboost using mediation, covering waterfall integrations. It covers how to add Chartboost to an ad unit's mediation configuration, and how to integrate the Chartboost SDK and adapter into an Android app.
Supported integrations and ad formats
The mediation adapter for Chartboost has the following capabilities:
Integration | |
---|---|
Bidding | |
Waterfall | |
Formats | |
Banner | |
Interstitial | |
Rewarded | |
Native |
Requirements
- Android API level 21 or higher
Latest Google Mobile Ads SDK
Complete the mediation Get started guide
Step 1: Set up configurations in Chartboost UI
اشترِك للحصول على حساب في Chartboost وسجِّل الدخول بعد إثبات ملكية حسابك. بعد ذلك، انتقِل إلى علامة التبويب إدارة التطبيقات.
انقر على الزر إضافة تطبيق جديد لإنشاء تطبيقك.
املأ ما تبقّى من النموذج وانقر على زر إضافة تطبيق لإنهاء عملية إعداد تطبيقك.
بعد إنشاء تطبيقك، سيتم توجيهك إلى لوحة البيانات الخاصة به. دوِّن معرّف التطبيق وتوقيع التطبيق لتطبيقك.
Ad Manager لإعداد Ad Manager رقم تعريف الوحدة الإعلانية، يجب استخدام رقم تعريف المستخدم وتوقيع المستخدم في Chartboost. يمكنك العثور على هذه المَعلمات من خلال النقر على توسّط Chartboost في واجهة مستخدم Chartboost.
انتقِل إلى علامة تبويب الموارد > مستكشف واجهة برمجة التطبيقات ودوِّن معرّف المستخدم وتوقيع المستخدم ضمن قسم المصادقة.
تفعيل وضع الاختبار
يمكنك تفعيل وضع الاختبار في تطبيقك من خلال الانتقال إلى علامة التبويب إدارة التطبيقات من واجهة مستخدم Chartboost واختيار تطبيقك من القائمة والنقر على تعديل إعدادات التطبيق.
من إعدادات تطبيقك، يمكنك تفعيل وضع الاختبار في تطبيقك.
بعد تفعيل وضع "الاختبار"، يمكنك طلب الإعلانات باستخدام رقم تعريف الوحدة الإعلانية الذي تم إنشاؤه سابقًا وتلقّي إعلان اختباري من Chartboost.
بعد أن تتمكّن من تلقّي إعلانات اختبارية في Chartboost، سيتم وضع تطبيقك في مراجعة تطبيقات الناشرين من Chartboost. لكي تعمل ميزة تحقيق الربح في Chartboost، يجب أن تتم الموافقة على مراجعة تطبيق الناشر من قِبل Chartboost.
Step 2: Set up Chartboost demand in Ad Manager UI
ضبط إعدادات التوسّط لوحدتك الإعلانية
سجِّل الدخول إلى حسابك على "مدير الإعلانات".
انتقِل إلى عرض الإعلانات > مجموعات الشبكات الإعلانية المدِرّة للأرباح وانقر على الزر مجموعة الشبكات الإعلانية المدِرّة للأرباح جديدة.
أدخِل اسمًا فريدًا لمجموعة الشبكات الإعلانية المدِرّة للأرباح، واضبط الحالة على نشط، واختَر شكل الإعلان، واضبط نوع المستودع على تطبيق متوافق مع الأجهزة الجوّالة. ضمن قسم الاستهداف > المستودع، اختَر الوحدة الإعلانية ضمن المستودع وتطبيق الأجهزة الجوّالة التي تريد إضافة توسّط إليها.
بعد ذلك، انقر على الزر إضافة شريك أرباح.
إذا كان لديك شريك أرباح في Chartboost، يمكنك اختياره. إذا لم يكن لديك حساب، اختَر إنشاء شريك جديد لتحقيق الأرباح.
اختَر Chartboost باعتبارها شبكة الإعلانات، وأدخِل اسمًا فريدًا وفعِّل التوسّط.
فعِّل الجمع التلقائي للبيانات، وأدخِل User ID and User Signature الذي تم الحصول عليه في القسم السابق.
بعد اختيار الشريك المحقِّق للأرباح، اختر توسّط حزمة تطوير البرامج (SDK) للأجهزة الجوّالة كـ نوع الدمج، وAndroid باعتبارها النظام الأساسي، ونشط كالحالة. أدخِل App ID, App Signature and Ad Location الذي تم الحصول عليه في القسم السابق. ثم أدخِل قيمة التكلفة التلقائية لكل ألف ظهور.
مواقع إعلانات Chartboost (المواقع الجغرافية التي تمت تسميتها) هي أسماء بسيطة تمثل مكانًا في تطبيقك تريد عرض الإعلان فيه. Ad Manager يرسل الطلبات إلى الموقع الجغرافي المحدد في الإعدادات. بعد إرسال الطلبات، سيضيف Chartboost الموقع إلى واجهة المستخدم لأغراض إعداد التقارير.
في واجهة مستخدم Chartboost، يمكن الكشف عن مواقع الإعلانات في صفحة الإعدادات الأساسية عن طريق النقر على الإعدادات المتقدمة. راجع دليل المواقع المُسمّاة في Chartboost للحصول على مزيد من التفاصيل.
انقر على حفظ في أسفل الصفحة عند الانتهاء.
Add Chartboost to GDPR and US state regulations ad partners list
اتّبِع الخطوات الواردة في إعدادات اللائحة العامة لحماية البيانات و إعدادات اللوائح السارية في الولايات الأمريكية لإضافة Chartboost إلى اللائحة العامة لحماية البيانات (GDPR) وقائمة شركاء الإعلانات للوائح الولايات الأمريكية في Ad Manager واجهة المستخدم.
Step 3: Import the Chartboost SDK and adapter
Android Studio integration (recommended)
In your project-level settings.gradle.kts
file, add the following
repositories:
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
maven {
url = uri("https://cboost.jfrog.io/artifactory/chartboost-ads/")
}
}
}
Then, in your app-level build.gradle.kts
file, add the following
implementation dependencies and configurations. Use the latest versions of the
Chartboost SDK and adapter:
dependencies {
implementation("com.google.android.gms:play-services-ads:23.3.0")
implementation("com.google.ads.mediation:chartboost:9.7.0.0")
}
Manual integration
Download the
.aar
file of the latest version of the Chartboost SDK from Maven Central, and add it to your project.Navigate to the Chartboost adapter artifacts on Google's Maven Repository. Select the latest version, download the Chartboost adapter's
.aar
file, and add it to your project.
Step 4: Implement privacy settings on Chartboost SDK
EU consent and GDPR
Under the Google EU User Consent Policy, you must ensure that certain disclosures are given to, and consents obtained from, users in the European Economic Area (EEA) regarding the use of device identifiers and personal data. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR). When seeking consent, you must identify each ad network in your mediation chain that may collect, receive, or use personal data and provide information about each network's use. Google currently is unable to pass the user's consent choice to such networks automatically.
In SDK version 8.1.0, Chartboost added the addDataUseConsent()
method. The
following sample code sets data use consent to NON_BEHAVIORAL
. If you choose
to call this method, it is recommended that you do so prior to requesting ads
through the Google Mobile Ads SDK.
Java
DataUseConsent dataUseConsent = new GDPR(GDPR.GDPR_CONSENT.NON_BEHAVIORAL);
Chartboost.addDataUseConsent(context, dataUseConsent);
Kotlin
val dataUseConsent = GDPR(GDPR.GDPR_CONSENT.NON_BEHAVIORAL)
Chartboost.addDataUseConsent(context, dataUseConsent)
See Chartboost's GDPR article and their Android Privacy Methods for more details and the values that can be provided in each method.
US states privacy laws
U.S. states privacy laws require giving users the right to opt out of the "sale" of their "personal information" (as the law defines those terms), with the opt-out offered via a prominent "Do Not Sell My Personal Information" link on the "selling" party's homepage. The U.S. states privacy laws compliance guide offers the ability to enable restricted data processing for Google ad serving, but Google is unable to apply this setting to each ad network in your mediation chain. Therefore, you must identify each ad network in your mediation chain that may participate in the sale of personal information and follow guidance from each of those networks to ensure compliance.
In SDK version 8.1.0, Chartboost added the addDataUseConsent()
method. The
following sample code sets data use consent to OPT_IN_SALE
. If you choose to
call this method, it is recommended that you do so prior to requesting ads
through the Google Mobile Ads SDK.
Java
DataUseConsent dataUseConsent = new CCPA(CCPA.CCPA_CONSENT.OPT_IN_SALE);
Chartboost.addDataUseConsent(context, dataUseConsent);
Kotlin
val dataUseConsent = CCPA(CCPA.CCPA_CONSENT.OPT_IN_SALE)
Chartboost.addDataUseConsent(context, dataUseConsent)
See Chartboost's CCPA article and their Android Privacy Methods for more details and the values that can be provided in each method.
Step 5: Add required code
Modify AndroidManifest
Other elements
Add the following attribute to each activity in the AndroidManifest.xml
file that will be showing Chartboost ads and supports different orientations:
android:configChanges="keyboardHidden|orientation|screenSize"
Lifecycle events
Per Chartboost's recommendation, Add the following code to all of your activity's lifecycle events that will be showing Chartboost ads.
Java
import com.chartboost.sdk.Chartboost;
// ...
@Override
public void onBackPressed() {
// If an interstitial is on screen, close it.
if (Chartboost.onBackPressed()) {
return;
} else {
super.onBackPressed();
}
}
Kotlin
import com.chartboost.sdk.Chartboost
// ...
@Override
fun onBackPressed() {
// If an interstitial is on screen, close it.
if (Chartboost.onBackPressed())
return
else
super.onBackPressed()
}
Step 6: Test your implementation
تفعيل الإعلانات التجريبية
احرص على تسجيل جهاز الاختبار من أجل Ad Manager وتفعيل وضع الاختبار في واجهة المستخدم Chartboost .
التحقّق من الإعلانات الاختبارية
للتأكّد من أنّك تتلقّى إعلانات اختبارية من Chartboost، فعِّل اختبار مصدر إعلان فردي في "أداة فحص الإعلانات" باستخدام Chartboost (Waterfall) مصادر الإعلانات.
Optional steps
Permissions
For optimal performance, Chartboost recommends adding the following optional
permissions to your app's AndroidManifest.xml
file:
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
Error codes
If the adapter fails to receive an ad from Chartboost, you can check the
underlying error from the ad response using
ResponseInfo.getAdapterResponses()
under the following classes:
com.google.ads.mediation.chartboost.ChartboostAdapter
com.google.ads.mediation.chartboost.ChartboostMediationAdapter
Here are the codes and accompanying messages thrown by the Chartboost adapter when an ad fails to load:
Error code | Reason |
---|---|
0-99 | Chartboost SDK returned an error. See Chartboost's documentation for more details. |
101 | The requested ad size does not match a Chartboost supported banner size. |
102 | Chartboost can only load 1 ad per location at a time. |
103 | Chartboost server parameters configured in the Ad Manager UI are missing/invalid. |
104 | The Chartboost interstitial or rewarded ad is not ready to be shown. |
Chartboost Android Mediation Adapter Changelog
Version 9.7.0.0
- Verified compatibility with Chartboost SDK version 9.7.0.
- Updated the minimum required Google Mobile Ads SDK version to 23.0.0.
Built and tested with:
- Google Mobile Ads SDK version 23.0.0.
- Chartboost SDK version 9.7.0.
Version 9.6.1.0
- Verified compatibility with Chartboost SDK version 9.6.1.
Built and tested with:
- Google Mobile Ads SDK version 22.6.0.
- Chartboost SDK version 9.6.1.
Version 9.6.0.0
- Verified compatibility with Chartboost SDK version 9.6.0.
Built and tested with:
- Google Mobile Ads SDK version 22.5.0.
- Chartboost SDK version 9.6.0.
Version 9.5.0.0
- Verified compatibility with Chartboost SDK version 9.5.0.
Built and tested with:
- Google Mobile Ads SDK version 22.3.0.
- Chartboost SDK version 9.5.0.
Version 9.4.1.0
- Verified compatibility with Chartboost SDK version 9.4.1.
Built and tested with:
- Google Mobile Ads SDK version 22.2.0.
- Chartboost SDK version 9.4.1.
Version 9.4.0.0
- Verified compatibility with Chartboost SDK version 9.4.0.
Built and tested with:
- Google Mobile Ads SDK version 22.1.0.
- Chartboost SDK version 9.4.0.
Version 9.3.1.0
- Verified compatibility with Chartboost SDK version 9.3.1.
Built and tested with:
- Google Mobile Ads SDK version 22.1.0.
- Chartboost SDK version 9.3.1.
Version 9.3.0.0
- Verified compatibility with Chartboost SDK version 9.3.0.
Built and tested with:
- Google Mobile Ads SDK version 22.0.0.
- Chartboost SDK version 9.3.0.
Version 9.2.1.1
- Updated adapter to use new
VersionInfo
class. - Updated the minimum required Google Mobile Ads SDK version to 22.0.0.
Built and tested with:
- Google Mobile Ads SDK version 22.0.0.
- Chartboost SDK version 9.2.1.
Version 9.2.1.0
- Verified compatibility with Chartboost SDK 9.2.1.
Built and tested with:
- Google Mobile Ads SDK version 21.5.0.
- Chartboost SDK version 9.2.1.
Version 9.2.0.0
- Verified compatibility with Chartboost SDK 9.2.0.
- Updated the minimum required Google Mobile Ads SDK version to 21.5.0.
Built and tested with:
- Google Mobile Ads SDK version 21.5.0.
- Chartboost SDK version 9.2.0.
Version 9.1.1.0
- Added the
ChartboostMediationAdapter.setAppParams(String, String)
method as an optional way to hardcode which app ID and app signature to use to initialize the Chartboost SDK. - Verified compatibility with Chartboost SDK 9.1.1.
- Updated the minimum required Google Mobile Ads SDK version to 21.3.0.
Built and tested with:
- Google Mobile Ads SDK version 21.3.0.
- Chartboost SDK version 9.1.1.
Version 8.4.3.1
- Updated the minimum required Google Mobile Ads SDK version to 21.0.0.
- Updated the minimum required Android API level to 19.
Built and tested with:
- Google Mobile Ads SDK version 21.0.0.
- Chartboost SDK version 8.4.3.
Version 8.4.3.0
- Verified compatibility with Chartboost SDK 8.4.3.
Built and tested with:
- Google Mobile Ads SDK version 20.6.0.
- Chartboost SDK version 8.4.3.
Version 8.4.2.0
- Verified compatibility with Chartboost SDK 8.4.2.
- Updated
compileSdkVersion
andtargetSdkVersion
to API 31. - Updated the minimum required Google Mobile Ads SDK version to 20.6.0.
Built and tested with:
- Google Mobile Ads SDK version 20.6.0.
- Chartboost SDK version 8.4.2.
Version 8.4.1.0
- Verified compatibility with Chartboost SDK 8.4.1.
- Updated the minimum required Google Mobile Ads SDK version to 20.6.0.
Built and tested with:
- Google Mobile Ads SDK version 20.6.0.
- Chartboost SDK version 8.4.1.
Version 8.3.1.0
- Verified compatibility with Chartboost SDK 8.3.1.
- Updated the adapter to use new
AdError
API.
Built and tested with:
- Google Mobile Ads SDK version 20.5.0.
- Chartboost SDK version 8.3.1.
Version 8.3.0.0
- Verified compatibility with Chartboost SDK 8.3.0.
- Updated the minimum required Google Mobile Ads SDK version to 20.5.0.
Built and tested with:
- Google Mobile Ads SDK version 20.5.0.
- Chartboost SDK version 8.3.0.
Version 8.2.1.0
- Verified compatibility with Chartboost SDK 8.2.1.
- Updated the minimum required Google Mobile Ads SDK version to 20.1.0.
Built and tested with:
- Google Mobile Ads SDK version 20.1.0.
- Chartboost SDK version 8.2.1.
Version 8.2.0.1
- Updated the minimum required Google Mobile Ads SDK version to 20.0.0.
Built and tested with:
- Google Mobile Ads SDK version 20.0.0.
- Chartboost SDK version 8.2.0.
Version 8.2.0.0
- Verified compatibility with Chartboost SDK 8.2.0.
- Updated the minimum required Google Mobile Ads SDK version to 19.5.0.
Built and tested with:
- Google Mobile Ads SDK version 19.5.0.
- Chartboost SDK version 8.2.0.
Version 8.1.0.0
- Verified compatibility with Chartboost SDK 8.1.0.
Built and tested with:
- Google Mobile Ads SDK version 19.2.0.
- Chartboost SDK version 8.1.0.
Version 8.0.3.2
- Added descriptive error codes and reasons for adapter load/show failures.
- Updated the minimum required Google Mobile Ads SDK version to 19.2.0.
Built and tested with:
- Google Mobile Ads SDK version 19.2.0.
- Chartboost SDK version 8.0.3.
Version 8.0.3.1
- Added support for Chartboost banner ads.
Built and tested with:
- Google Mobile Ads SDK version 19.1.0.
- Chartboost SDK version 8.0.3.
Version 8.0.3.0
- Verified compatibility with Chartboost SDK 8.0.3.
- Updated the minimum required Google Mobile Ads SDK version to 19.1.0.
Built and tested with:
- Google Mobile Ads SDK version 19.1.0.
- Chartboost SDK version 8.0.3.
Version 8.0.2.0
- Verified compatibility with Chartboost SDK 8.0.2.
- Updated the minimum required Google Mobile Ads SDK version to 19.0.1.
Built and tested with:
- Google Mobile Ads SDK version 19.0.1.
- Chartboost SDK version 8.0.2.
Version 8.0.1.0
- Verified compatibility with Chartboost SDK 8.0.1.
- Requires Chartboost SDK 8.0.1 or higher.
- Activity context is no longer required to load ads.
Built and tested with:
- Google Mobile Ads SDK version 18.3.0.
- Chartboost SDK version 8.0.1.
Version 7.5.0.1
- Fixed a bug where Chartboost adapter failed to invoke ad events.
- Updated the minimum required Google Mobile Ads SDK version to 18.3.0.
Built and tested with:
- Google Mobile Ads SDK version 18.3.0.
- Chartboost SDK version 7.5.0.
Version 7.5.0.0
- Verified compatibility with Chartboost SDK 7.5.0.
- Migrated the adapter to use AndroidX dependencies.
- Updated the minimum required Google Mobile Ads SDK version to 18.1.1.
Version 7.3.1.1
- Updated adapter to support new open-beta Rewarded API.
- Updated the minimum required Google Mobile Ads SDK version to 17.2.0.
Version 7.3.1.0
- Verified compatibility with Chartboost SDK 7.3.1.
Version 7.3.0.0
- Verified compatibility with Chartboost SDK 7.3.0.
Version 7.2.1.0
- Verified compatibility with Chartboost SDK 7.2.1.
Version 7.2.0.1
- Updated the adapter to invoke the
onRewardedVideoComplete()
ad event.
Version 7.2.0.0
- Verified compatibility with Chartboost SDK 7.2.0.
Version 7.1.0.0
- Verified compatibility with Chartboost SDK 7.1.0.
Version 7.0.1.0
- Verified compatibility with Chartboost SDK 7.0.1.
- Added support for new Chartboost error codes.
- Updated the Adapter project for Android Studio 3.0
Version 7.0.0.0
- Updated the adapter to make it compatible with Chartboost SDK 7.0.0.
Version 6.6.3.0
- Verified compatibility with Chartboost SDK 6.6.3.
Version 6.6.2.0
- Verified compatibility with Chartboost SDK 6.6.2.
Version 6.6.1.0
- Verified compatibility with Chartboost SDK 6.6.1.
Version 6.6.0.0
- Changed the version naming system to [Chartboost SDK version].[adapter patch version].
- The adapters can now be added as a compile dependency by adding the following
to the build.gradle file's dependencies tag:
compile 'com.google.ads.mediation:chartboost:6.6.0.0'
- Moved to distributing the adapter as an aar instead of a jar file (see README for additional instructions).
Version 1.1.0
- Removed Chartboost Ad Location from Chartboost extras. Ad Location is now specified in the AdMob console when configuring Chartboost for mediation.
Version 1.0.0
- Initial release. Supports reward-based video ads and interstitial ads.