本指南說明如何使用 Google Mobile Ads SDK 透過中介服務載入並顯示 Chartboost 廣告,並涵蓋瀑布流整合。本文件將說明如何將 Chartboost 新增至廣告單元的中介設定,以及如何將 Chartboost SDK 和轉接程式整合至 Android 應用程式。
支援的整合和廣告格式
Chartboost 的仲介適配器具有下列功能:
整合 | |
---|---|
出價 | |
瀑布 | |
格式 | |
橫幅廣告 | |
插頁式 | |
已獲得獎勵 | |
原生 |
需求條件
最新版 Google Mobile Ads SDK
完成中介服務入門指南
步驟 1:在 Chartboost UI 中設定設定
註冊 Chartboost 帳戶,並在帳戶驗證通過後登入。接著前往「應用程式管理」分頁。
按一下「新增應用程式」按鈕,建立應用程式。
填寫表單中的其他資料,然後按一下「新增應用程式」按鈕,完成應用程式。
應用程式建立完成後,系統會將您導向應用程式資訊主頁。記下應用程式的應用程式 ID 和應用程式簽名。
設定 Ad Manager 廣告單元 ID 時,Ad Manager 需要 Chartboost 的使用者 ID 和使用者簽章。如要查看這些參數,請在 Chartboost UI 中點選「Chartboost 中介服務」。
前往「Resources」>「API Explorer」分頁,然後記下「Authentication」部分下方的「User ID」和「User Signature」。
開啟測試模式
如要在應用程式中啟用測試模式,請前往 Chartboost UI 中的「應用程式管理」分頁,從清單中選取應用程式,然後按一下「編輯應用程式設定」。
您可以在應用程式設定中切換應用程式的測試模式。
啟用測試模式後,您可以使用先前建立的廣告單元 ID 要求廣告,並接收 Chartboost 測試廣告。
您可以開始接收 Chartboost 測試廣告後,您的應用程式就會刊登在 Chartboost 的發布商應用程式審查頁面。如要透過 Chartboost 營利,發布商應用程式審查必須獲得 Chartboost 核准。
步驟 2:在 Ad Manager 使用者介面中設定 Chartboost 需求
設定廣告單元的中介服務設定
登入 Ad Manager 帳戶。
前往「廣告放送」>「收益群組」,然後按一下「新增收益群組」按鈕。
為收益群組輸入專屬的名稱,將狀態設為有效,選取廣告格式,然後將廣告空間類型設為行動應用程式。在「指定目標」>「廣告空間」部分下方,選取要加入中介服務的「廣告空間」和「行動應用程式」下方的廣告單元。
接著,按一下「新增收益夥伴」按鈕。
如果您已與 Chartboost 的收益合作夥伴簽訂合作夥伴協議,可以選取該合作夥伴。否則,請選取「建立新的收益夥伴」。
選取「Chartboost」做為「廣告聯播網」,輸入專屬的「名稱」,然後啟用「中介服務」。
開啟「自動資料收集」,然後輸入先前取得的「使用者 ID」和「使用者簽章」。
選取「收益夥伴」後,請選擇「Mobile SDK 中介服務」做為「整合類型」、「Android」做為「平台」,以及「有效」做為「狀態」。輸入先前取得的 應用程式 ID、應用程式簽名和廣告位置。接著輸入「Default CPM」值。
Chartboost 廣告位置 (命名位置) 是簡單的名稱,代表您要在應用程式中顯示廣告的位置。Ad Manager 會將要求傳送至設定中指定的位置。要求傳送後,Chartboost 會將位置新增至 UI,以便產生報表。
在 Chartboost UI 中,只要點選「進階設定」,即可在「基本設定」頁面中顯示廣告位置。詳情請參閱 Chartboost 命名位置指南。
完成後,按一下頁面底部的「儲存」。
將 Chartboost 新增至 GDPR 和美國州級法規廣告合作夥伴清單
請按照GDPR 設定和美國州級法規設定中的步驟,將 Chartboost 新增至 Ad Manager UI 中的 GDPR 和美國州級法規廣告合作夥伴清單。
步驟 3:匯入 Chartboost SDK 和轉接程式
Android Studio 整合 (建議)
在專案層級的 settings.gradle.kts
檔案中,新增下列存放區:
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
maven {
url = uri("https://cboost.jfrog.io/artifactory/chartboost-ads/")
}
}
}
接著,在應用程式層級的 build.gradle.kts
檔案中,新增下列實作依附元件和設定。使用最新版的 Chartboost SDK 和轉接程式:
dependencies {
implementation("com.google.android.gms:play-services-ads:23.6.0")
implementation("com.google.ads.mediation:chartboost:9.8.1.0")
}
手動整合
從 Maven Central 下載最新版 Chartboost SDK 的
.aar
檔案,然後將其新增至專案。前往 Google 的 Maven 存放區,找到 Chartboost 轉接器構件。選取最新版本,下載 Chartboost 轉接器的
.aar
檔案,然後將其新增至專案。
步驟 4:在 Chartboost SDK 中實作隱私權設定
歐盟同意聲明和 GDPR
根據 Google 的《歐盟地區使用者同意授權政策》,您必須確保向歐洲經濟區 (EEA) 境內使用者揭露特定資訊,並徵得使用者同意聲明,才能使用裝置 ID 和個人資料。本政策是配合《歐盟電子通訊隱私指令》和《一般資料保護規則》(GDPR) 的法規而制定。在徵求同意聲明時,您必須指出中介服務鏈中可能會收集、接收或使用個人資料的每個廣告聯播網,並提供每個聯播網的使用方式相關資訊。Google 目前無法自動將使用者的同意聲明選項傳送至這類網路。
在 SDK 8.1.0 版中,Chartboost 新增了 addDataUseConsent()
方法。以下程式碼範例會將資料使用同意聲明設為 NON_BEHAVIORAL
。如果您選擇呼叫這個方法,建議您在透過 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)
如要進一步瞭解詳情和各個方法可提供的值,請參閱 Chartboost 的 GDPR 文章和Android 隱私權方法。
美國州級隱私權法律
美國各州的隱私權法規定,使用者有權選擇拒絕「販售」自己的「個人資訊」(如該法案對「販售」與「個人資訊」這兩個詞的定義),且「賣方」必須在首頁上提供顯眼的「不要販售我的個人資訊」連結,供使用者選擇拒絕。美國州級隱私權法律遵循指南提供啟用 Google 廣告放送服務的受限的資料處理模式功能,但 Google 無法將這項設定套用至中介服務鏈中的每個廣告聯播網。因此,您必須在中介服務鏈中找出可能參與個人資訊販售的廣告聯播網,並遵循各個廣告聯播網的指示,確保符合規定。
在 SDK 8.1.0 版中,Chartboost 新增了 addDataUseConsent()
方法。以下程式碼範例會將資料使用同意聲明設為 OPT_IN_SALE
。如果您選擇呼叫這個方法,建議您在透過 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)
如要進一步瞭解相關細節和各個方法可提供的值,請參閱 Chartboost 的 CCPA 文章和Android 隱私權方法。
步驟 5:新增必要程式碼
修改 AndroidManifest
其他元素
在 AndroidManifest.xml
檔案中,將下列屬性新增至每個會顯示 Chartboost 廣告且支援不同方向的活動:
android:configChanges="keyboardHidden|orientation|screenSize"
生命週期事件
根據 Chartboost 的建議,請在所有會顯示 Chartboost 廣告的活動生命週期事件中加入以下程式碼。
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()
}
步驟 6:測試導入作業
啟用測試廣告
請務必為 Ad Manager 註冊測試裝置,並在 Chartboost 使用者介面中啟用測試模式。
驗證測試廣告
如要確認您收到 Chartboost 的測試廣告,請使用 Chartboost (刊登序列) 廣告來源,在廣告檢查器中啟用單一廣告來源測試。
選擇性步驟
權限
為達到最佳效能,Chartboost 建議您在應用程式的 AndroidManifest.xml
檔案中加入下列選用權限:
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
錯誤代碼
如果轉接器無法接收 Chartboost 的廣告,您可以使用下列類別中的 ResponseInfo.getAdapterResponses()
檢查廣告回應的基礎錯誤:
com.google.ads.mediation.chartboost.ChartboostAdapter
com.google.ads.mediation.chartboost.ChartboostMediationAdapter
以下是廣告載入失敗時,Chartboost 轉接程式所擲回的程式碼和隨附訊息:
錯誤代碼 | 原因 |
---|---|
0-99 | Chartboost SDK 傳回錯誤。詳情請參閱 Chartboost 的說明文件。 |
101 | 請求的廣告大小與 Chartboost 支援的橫幅廣告大小不符。 |
102 | Chartboost 一次只能為每個位置載入 1 則廣告。 |
103 | 在 Ad Manager 使用者介面中設定的 Chartboost 伺服器參數遺失/無效。 |
104 | Chartboost 插頁式或獎勵廣告尚未準備好顯示。 |
Chartboost Android Mediation 轉換器變更記錄
9.8.1.0 版
- 已確認與 Chartboost SDK 9.8.1 版相容。
建構及測試時使用:
- Google Mobile Ads SDK 23.5.0 版。
- Chartboost SDK 版本 9.8.1。
9.8.0.0 版
- 已確認與 Chartboost SDK 9.8.0 版相容。
建構及測試時使用:
- Google Mobile Ads SDK 23.4.0 版。
- Chartboost SDK 版本 9.8.0。
9.7.0.0 版
- 已確認與 Chartboost SDK 9.7.0 版相容。
- 將最低必要的 Google Mobile Ads SDK 版本更新至 23.0.0。
建構及測試時使用:
- Google Mobile Ads SDK 23.0.0 以上版本。
- Chartboost SDK 版本 9.7.0。
9.6.1.0 版
- 已確認與 Chartboost SDK 9.6.1 版相容。
建構及測試時使用:
- Google Mobile Ads SDK 22.6.0 版。
- Chartboost SDK 9.6.1 版。
9.6.0.0 版
- 已確認與 Chartboost SDK 9.6.0 版相容。
建構及測試時使用:
- Google Mobile Ads SDK 22.5.0 版。
- Chartboost SDK 版本 9.6.0。
9.5.0.0 版
- 已確認與 Chartboost SDK 9.5.0 版相容。
建構及測試時使用:
- Google Mobile Ads SDK 22.3.0 版。
- Chartboost SDK 版本 9.5.0。
9.4.1.0 版
- 已確認與 Chartboost SDK 9.4.1 版相容。
建構及測試時使用:
- Google Mobile Ads SDK 22.2.0 版。
- Chartboost SDK 版本 9.4.1。
9.4.0.0 版
- 已確認與 Chartboost SDK 9.4.0 版本相容。
建構及測試時使用:
- Google Mobile Ads SDK 22.1.0 版。
- Chartboost SDK 版本 9.4.0。
9.3.1.0 版
- 已確認與 Chartboost SDK 9.3.1 版相容。
建構及測試時使用:
- Google Mobile Ads SDK 22.1.0 版。
- Chartboost SDK 版本 9.3.1。
9.3.0.0 版
- 已確認與 Chartboost SDK 9.3.0 版相容。
建構及測試時使用:
- Google Mobile Ads SDK 22.0.0 版。
- Chartboost SDK 版本 9.3.0。
9.2.1.1 版
- 更新轉接器,以便使用新的
VersionInfo
類別。 - 將 Google Mobile Ads SDK 最低要求版本更新至 22.0.0。
建構及測試時使用:
- Google Mobile Ads SDK 22.0.0 版。
- Chartboost SDK 版本 9.2.1。
9.2.1.0 版
- 已確認與 Chartboost SDK 9.2.1 相容。
建構及測試時使用:
- Google Mobile Ads SDK 21.5.0 以上版本。
- Chartboost SDK 版本 9.2.1。
9.2.0.0 版
- 已確認與 Chartboost SDK 9.2.0 相容。
- 將最低要求的 Google Mobile Ads SDK 版本更新至 21.5.0。
建構及測試時使用:
- Google Mobile Ads SDK 21.5.0 以上版本。
- Chartboost SDK 版本 9.2.0。
9.1.1.0 版
- 新增
ChartboostMediationAdapter.setAppParams(String, String)
方法,做為硬式編碼的選用方式,用於指定要用來初始化 Chartboost SDK 的應用程式 ID 和應用程式簽名。 - 已確認與 Chartboost SDK 9.1.1 相容。
- 將最低必要的 Google Mobile Ads SDK 版本更新至 21.3.0。
建構及測試時使用:
- Google Mobile Ads SDK 21.3.0 版。
- Chartboost SDK 版本 9.1.1。
8.4.3.1 版
- 將 Google Mobile Ads SDK 最低要求版本更新至 21.0.0。
- 將最低 Android API 級別更新為 19。
建構及測試時使用:
- Google Mobile Ads SDK 21.0.0 版。
- Chartboost SDK 8.4.3 版。
版本 8.4.3.0
- 已確認與 Chartboost SDK 8.4.3 相容。
建構及測試時使用:
- Google Mobile Ads SDK 20.6.0 版。
- Chartboost SDK 8.4.3 版。
8.4.2.0 版
- 已確認與 Chartboost SDK 8.4.2 相容。
- 將
compileSdkVersion
和targetSdkVersion
更新至 API 31。 - 將最低要求的 Google Mobile Ads SDK 版本更新至 20.6.0。
建構及測試時使用:
- Google Mobile Ads SDK 20.6.0 版。
- Chartboost SDK 8.4.2 版。
8.4.1.0 版
- 已確認與 Chartboost SDK 8.4.1 相容。
- 將最低要求的 Google Mobile Ads SDK 版本更新至 20.6.0。
建構及測試時使用:
- Google Mobile Ads SDK 20.6.0 版。
- Chartboost SDK 8.4.1 版。
8.3.1.0 版
- 已確認與 Chartboost SDK 8.3.1 相容。
- 更新轉接器,以便使用新的
AdError
API。
建構及測試時使用:
- Google Mobile Ads SDK 20.5.0 版。
- Chartboost SDK 8.3.1 版。
8.3.0.0 版
- 已確認與 Chartboost SDK 8.3.0 相容。
- 將 Google Mobile Ads SDK 最低要求版本更新至 20.5.0。
建構及測試時使用:
- Google Mobile Ads SDK 20.5.0 版。
- Chartboost SDK 版本 8.3.0。
8.2.1.0 版
- 已確認與 Chartboost SDK 8.2.1 相容。
- 將 Google Mobile Ads SDK 最低需求版本更新至 20.1.0。
建構及測試時使用:
- Google Mobile Ads SDK 20.1.0 版。
- Chartboost SDK 8.2.1 版。
8.2.0.1 版
- 將最低要求的 Google Mobile Ads SDK 版本更新至 20.0.0。
建構及測試時使用:
- Google Mobile Ads SDK 20.0.0 版。
- Chartboost SDK 8.2.0 以上版本。
8.2.0.0 版
- 已確認與 Chartboost SDK 8.2.0 相容。
- 將最低要求的 Google Mobile Ads SDK 版本更新至 19.5.0。
建構及測試時使用:
- Google Mobile Ads SDK 19.5.0 版。
- Chartboost SDK 8.2.0 以上版本。
8.1.0.0 版
- 已確認與 Chartboost SDK 8.1.0 相容。
建構及測試時使用:
- Google Mobile Ads SDK 19.2.0 版。
- Chartboost SDK 8.1.0 版。
8.0.3.2 版
- 新增說明錯誤代碼和原因,以便說明轉接器載入/顯示失敗。
- 將最低必要的 Google Mobile Ads SDK 版本更新至 19.2.0。
建構及測試時使用:
- Google Mobile Ads SDK 19.2.0 版。
- Chartboost SDK 版本 8.0.3。
8.0.3.1 版
- 新增 Chartboost 橫幅廣告支援功能。
建構及測試時使用:
- Google Mobile Ads SDK 19.1.0 版。
- Chartboost SDK 版本 8.0.3。
8.0.3.0 版
- 已確認與 Chartboost SDK 8.0.3 相容。
- 將最低要求的 Google Mobile Ads SDK 版本更新至 19.1.0。
建構及測試時使用:
- Google Mobile Ads SDK 19.1.0 版。
- Chartboost SDK 版本 8.0.3。
8.0.2.0 版
- 已確認與 Chartboost SDK 8.0.2 相容。
- 將最低要求的 Google Mobile Ads SDK 版本更新至 19.0.1。
建構及測試時使用:
- Google Mobile Ads SDK 19.0.1 版。
- Chartboost SDK 8.0.2 版。
8.0.1.0 版
- 已確認與 Chartboost SDK 8.0.1 相容。
- 需要 Chartboost SDK 8.0.1 以上版本。
- 載入廣告時,不再需要活動內容。
建構及測試時使用:
- Google Mobile Ads SDK 18.3.0 版。
- Chartboost SDK 8.0.1 版。
7.5.0.1 版
- 修正 Chartboost 轉接器無法叫用廣告事件的錯誤。
- 將最低要求的 Google Mobile Ads SDK 版本更新至 18.3.0。
建構及測試時使用:
- Google Mobile Ads SDK 18.3.0 版。
- Chartboost SDK 版本 7.5.0。
7.5.0.0 版
- 已確認與 Chartboost SDK 7.5.0 相容。
- 已將轉接程式遷移至使用 AndroidX 依附元件。
- 將最低必要的 Google Mobile Ads SDK 版本更新至 18.1.1。
7.3.1.1 版
- 更新轉接器,支援新的公開測試版 Rewarded API。
- 將最低必要的 Google Mobile Ads SDK 版本更新至 17.2.0。
7.3.1.0 版
- 已驗證與 Chartboost SDK 7.3.1 的相容性。
7.3.0.0 版
- 已確認與 Chartboost SDK 7.3.0 相容。
7.2.1.0 版
- 已確認與 Chartboost SDK 7.2.1 的相容性。
7.2.0.1 版
- 更新轉接程式,以便叫用
onRewardedVideoComplete()
廣告事件。
7.2.0.0 版
- 已確認與 Chartboost SDK 7.2.0 相容。
7.1.0.0 版
- 已確認與 Chartboost SDK 7.1.0 相容。
7.0.1.0 版
- 已驗證與 Chartboost SDK 7.0.1 的相容性。
- 新增 Chartboost 錯誤代碼支援。
- 更新 Android Studio 3.0 的 Adapter 專案
7.0.0.0 版
- 更新轉接器,使其與 Chartboost SDK 7.0.0 相容。
6.6.3.0 版
- 已確認與 Chartboost SDK 6.6.3 相容。
6.6.2.0 版
- 已確認與 Chartboost SDK 6.6.2 相容。
6.6.1.0 版
- 已確認與 Chartboost SDK 6.6.1 相容。
6.6.0.0 版
- 將版本命名系統改為 [Chartboost SDK 版本]。[adapter patch 版本]。
- 只要將下列內容新增至 build.gradle 檔案的依附元件標記,即可將轉接程式新增為編譯依附元件:
compile 'com.google.ads.mediation:chartboost:6.6.0.0'
- 改為以 aar 而非 jar 檔案分發轉接器 (請參閱 README 取得其他操作說明)。
1.1.0 版本
- 已從 Chartboost 額外選項中移除 Chartboost 廣告位置。在 AdMob 控制台中設定 Chartboost 中介服務時,現在可指定廣告位置。
1.0.0 版本
- 原始版本。支援獎勵影片廣告和插頁式廣告。