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 a Unity app.
Supported integrations and ad formats
The AdMob mediation adapter for Chartboost has the following capabilities:
Integration | |
---|---|
Bidding | |
Waterfall | |
Formats | |
Banner | |
Interstitial | |
Rewarded |
Requirements
- Unity 4 or higher
- Latest Google Mobile Ads SDK
- To deploy on Android
- Android API level 21 or higher
- To deploy on iOS
- iOS deployment target of 12.0 or higher
- A working Unity project configured with Google Mobile Ads SDK. See Get Started for details.
- Complete the mediation Get started guide
Step 1: Set up configurations in Chartboost UI
Đăng ký tài khoản Chartboost và đăng nhập sau khi tài khoản của bạn được xác minh. Sau đó, hãy chuyển đến thẻ Quản lý ứng dụng.
Nhấp vào nút Thêm ứng dụng mới để tạo ứng dụng.
Điền vào phần còn lại của biểu mẫu và nhấp vào nút Add App (Thêm ứng dụng) để hoàn tất ứng dụng.
Sau khi tạo ứng dụng, bạn sẽ được chuyển hướng đến trang tổng quan của ứng dụng. Ghi lại Mã ứng dụng và Chữ ký ứng dụng của ứng dụng.
Android
iOS
AdMob yêu cầu Mã nhận dạng người dùng và Chữ ký người dùng của Chartboost để thiết lập AdMob mã đơn vị quảng cáo. Bạn có thể tìm thấy các thông số này bằng cách nhấp vào Dàn xếp Chartboost trên giao diện người dùng Chartboost.
Chuyển đến thẻ Resources > API Explorer (Tài nguyên > Trình khám phá API) và ghi lại User ID và Chữ ký người dùng nằm trong mục Xác thực.
Bật chế độ thử nghiệm
Bạn có thể bật chế độ kiểm thử trên ứng dụng của mình bằng cách chuyển đến thẻ Apps Management (Quản lý ứng dụng) trên giao diện người dùng Chartboost, chọn ứng dụng của bạn từ danh sách rồi nhấp vào Edit app settings (Chỉnh sửa chế độ cài đặt ứng dụng).
Android
iOS
Trong phần cài đặt của ứng dụng, bạn có thể bật/tắt Chế độ thử nghiệm trên ứng dụng đó.
Sau khi bật chế độ thử nghiệm, bạn có thể yêu cầu quảng cáo bằng cách sử dụng mã đơn vị quảng cáo đã tạo trước đó và nhận quảng cáo thử nghiệm Chartboost.
Sau khi bạn có thể nhận được quảng cáo thử nghiệm của Chartboost, ứng dụng của bạn sẽ được đưa vào Bài đánh giá ứng dụng dành cho nhà xuất bản của Chartboost. Để tính năng kiếm tiền trên Chartboost hoạt động, quy trình xem xét ứng dụng của nhà xuất bản cần được Chartboost phê duyệt.
Step 2: Set up Chartboost demand in AdMob UI
Định cấu hình cài đặt dàn xếp cho đơn vị quảng cáo của bạn
Android
Để biết hướng dẫn, hãy xem bước 2 trong hướng dẫn dành cho Android.
iOS
Để biết hướng dẫn, hãy xem bước 2 trong hướng dẫn dành cho iOS.
Add Chartboost to GDPR and US state regulations ad partners list
Hãy làm theo các bước trong cài đặt GDPR và cài đặt quy định của chính phủ Hoa Kỳ để thêm Chartboost vào GDPR và danh sách đối tác quảng cáo theo quy định của tiểu bang Hoa Kỳ trong AdMob giao diện người dùng.
Step 3: Import the Chartboost SDK and adapter
Download the latest version of Google Mobile Ads mediation plugin for Chartboost
from the download link in the
Changelog and extract
GoogleMobileAdsChartboostMediation.unitypackage
from the zip file.
In your Unity project editor, select Assets > Import Package >
Custom Package and find the GoogleMobileAdsChartboostMediation.unitypackage
file you downloaded. Make sure that all the files are selected and click
Import.
Then, select Assets > Play Services Resolver > Android Resolver >
Force Resolve. The Unity Play Services Resolver library will perform
dependency resolution from scratch and copy the declared dependencies into the
Assets/Plugins/Android
directory of your Unity app.
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.
The Google Mobile Ads mediation plugin for Chartboost version 3.1.0 includes the
Chartboost.AddDataUseConsent()
method. The following sample code sets data use
consent to NonBehavioral
. If you choose to call this method, it is recommended
that you do so prior to requesting ads using the Google Mobile Ads SDK.
using GoogleMobileAds.Api.Mediation.Chartboost;
// ...
Chartboost.AddDataUseConsent(CBGDPRDataUseConsent.NonBehavioral);
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.
The Google Mobile Ads mediation plugin for Chartboost version 3.1.0 includes the
Chartboost.AddDataUseConsent()
method. The following sample code sets data use
consent to OptInSale
. If you choose to call this method, it is recommended
that you do so prior to requesting ads using the Google Mobile Ads SDK.
using GoogleMobileAds.Api.Mediation.Chartboost;
// ...
Chartboost.AddDataUseConsent(CBCCPADataUseConsent.OptInSale);
Step 5: Add required code
Android
No additional code is required for Chartboost integration.
iOS
SKAdNetwork integration
Follow Chartboost's
documentation
to add the SKAdNetwork identifiers to your project's Info.plist
file.
Step 6: Test your implementation
Bật quảng cáo thử nghiệm
Hãy nhớ đăng ký thiết bị thử nghiệm cho AdMob và bật chế độ thử nghiệm trong Chartboost giao diện người dùng.
Xác minh quảng cáo thử nghiệm
Để xác minh rằng bạn đang nhận quảng cáo thử nghiệm từ Chartboost, hãy bật thử nghiệm riêng một nguồn quảng cáo trong công cụ kiểm tra quảng cáo bằng cách sử dụng Chartboost (Waterfall) (các) nguồn quảng cáo.
Optional Steps
Android
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" />
iOS
No additional steps are required for iOS integration.
Error codes
If the adapter fails to receive an ad from Chartboost,
publishers can check the underlying error from the ad response using
ResponseInfo
under the following classes:
Android
com.google.ads.mediation.chartboost.ChartboostAdapter
com.google.ads.mediation.chartboost.ChartboostMediationAdapter
iOS
GADMAdapterChartboost
GADMediationAdapterChartboost
Here are the codes and accompanying messages thrown by the Chartboost adapter when an ad fails to load:
Android
Error code | Reason |
---|---|
0-99 | Chartboost SDK returned an error. |
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 AdMob UI are missing/invalid. |
104 | The Chartboost interstitial or rewarded ad is not ready to be shown. |
iOS
Error code | Reason |
---|---|
101 | Chartboost server parameters configured in the AdMob UI are missing/invalid. |
102 | The Chartboost SDK returned an initialization error. |
103 | The Chartboost ad is not cached at show time. |
104 | The requested ad size does not match a Chartboost supported banner size. |
105 | Device's OS version is lower than Chartboost SDK's minimum supported OS version. |
200-299 | Chartboost SDK cache errors. See code for more details. |
300-399 | Chartboost SDK show errors. See code for more details. |
400-499 | Chartboost SDK click errors. See code for more details. |
Chartboost Unity Mediation Plugin Changelog
Version Next
- Renamed
DummyClient
toPlaceholderClient
.
Version 4.6.0
- Supports Chartboost Android adapter version 9.7.0.0.
- Supports Chartboost iOS adapter version 9.7.0.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 9.0.0.
Version 4.5.0
- Supports Chartboost Android adapter version 9.6.0.0.
- Supports Chartboost iOS adapter version 9.6.0.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 8.6.0.
Version 4.4.0
- Supports Chartboost Android adapter version 9.5.0.0.
- Supports Chartboost iOS adapter version 9.5.1.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 8.5.3.
Version 4.3.0
- Supports Chartboost Android adapter version 9.4.0.0.
- Supports Chartboost iOS adapter version 9.4.0.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 8.5.0.
Version 4.2.0
- Supports Chartboost Android adapter version 9.3.0.0.
- Supports Chartboost iOS adapter version 9.3.0.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 8.2.0.
Version 4.1.1
- Moved adapter content to
GoogleMobileAds/Mediation/Chartboost/
. - Refactored adapter namespace to use
GoogleMobileAds.Mediation.Chartboost
. - Supports Chartboost Android adapter version 9.2.1.1.
- Supports Chartboost iOS adapter version 9.2.0.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 8.1.0.
Version 4.1.0
- Supports Chartboost Android adapter version 9.2.0.0.
- Supports Chartboost iOS adapter version 9.2.0.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 7.4.1.
Version 4.0.0
- Supports Chartboost Android adapter version 9.1.1.0.
- Supports Chartboost iOS adapter version 9.1.0.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 7.3.0.
Version 3.5.1
- Supports Chartboost Android adapter version 8.4.3.1.
- Supports Chartboost iOS adapter version 8.5.0.2.
- Built and tested with the Google Mobile Ads Unity Plugin version 7.0.2.
Version 3.5.0
- Supports Chartboost Android adapter version 8.4.2.0.
- Supports Chartboost iOS adapter version 8.5.0.2.
- Built and tested with the Google Mobile Ads Unity Plugin version 7.0.0.
Version 3.4.1
- Supports Chartboost Android adapter version 8.3.1.0.
- Supports Chartboost iOS adapter version 8.5.0.2.
- Built and tested with the Google Mobile Ads Unity Plugin version 7.0.0.
Version 3.4.0
- Supports Chartboost Android adapter version 8.3.0.0.
- Supports Chartboost iOS adapter version 8.5.0.1.0.
Version 3.3.1
- Supports Chartboost Android adapter version 8.2.1.0.
- Supports Chartboost iOS adapter version 8.4.1.1.
Version 3.3.0
- Supports Chartboost Android adapter version 8.2.0.0.
- Supports Chartboost iOS adapter version 8.4.0.0.
Version 3.2.0
- Supports Chartboost Android adapter version 8.1.0.0.
- Supports Chartboost iOS adapter version 8.3.1.0.
Version 3.1.0
- Removed
RestrictDataCollection()
method from theChartboost
class. - Added
AddDataUseConsent()
helper methods to pass GDPR and CCPA information to Chartboost. - Supports Chartboost Android adapter version 8.1.0.0.
- Supports Chartboost iOS adapter version 8.2.0.0.
Version 3.0.1
- Supports Chartboost Android adapter version 8.0.3.1.
- Supports Chartboost iOS adapter version 8.1.0.1.
Version 3.0.0
- Supports Chartboost Android adapter version 8.0.2.0.
- Supports Chartboost iOS adapter version 8.1.0.0.
Version 2.0.1
- Supports Chartboost Android adapter version 7.5.0.1.
- Supports Chartboost iOS adapter version 8.0.4.0.
Version 2.0.0
- Supports Chartboost Android adapter version 7.5.0.0.
- Supports Chartboost iOS adapter version 8.0.1.1.
Version 1.3.0
- Updated the plugin to support the new Rewarded API.
- Supports Chartboost Android adapter version 7.3.1.1.
- Supports Chartboost iOS adapter version 7.5.0.0.
Version 1.2.0
- Supports Chartboost Android adapter version 7.3.0.0.
- Supports Chartboost iOS adapter version 7.3.0.0.
Version 1.1.1
- Supports Chartboost Android adapter version 7.2.0.1.
- Supports Chartboost iOS adapter version 7.2.0.1.
Version 1.1.0
- Supports Chartboost Android SDK version 7.2.0.
- Supports Chartboost iOS SDK version 7.2.0.
- Added
Chartboost.RestrictDataCollection()
method to enable GDPR data collection restrictions for the Chartboost SDK.
Version 1.0.0
- First release!
- Supports Chartboost Android SDK version 7.0.1.
- Supports Chartboost iOS SDK version 7.1.2.