本指南說明如何使用 Google Mobile Ads SDK,透過中介服務載入及顯示 Chartboost 廣告,也會介紹刊登序列整合作業,內容涵蓋如何將 Chartboost 新增至廣告單元的中介服務設定,以及如何將 Chartboost SDK 和轉接程式整合至 Android 應用程式。
支援的整合功能和廣告格式
Chartboost 中介服務轉接程式具備下列功能:
整合 | |
---|---|
出價 | |
瀑布 | |
格式 | |
橫幅廣告 | |
插頁式 | |
已獲得獎勵 | |
原生 |
需求條件
- Android API 級別 23 以上版本
最新版 Google Mobile Ads SDK
完成中介服務入門指南的步驟
步驟 1:在 Chartboost 使用者介面中設定
註冊 Chartboost 帳戶,並在帳戶通過驗證後登入。然後前往「應用程式管理」分頁。
按一下「新增應用程式」按鈕來建立應用程式。
填妥表單其餘部分,然後按一下「新增應用程式」按鈕,完成應用程式設定。
應用程式建立完成後,系統會將您導向應用程式的資訊主頁。記下應用程式的應用程式 ID 和應用程式簽章。
Ad Manager 需要 Chartboost 使用者 ID 和使用者簽章,才能設定 Ad Manager 廣告單元 ID。如要找出這些參數,請在 Chartboost 使用者介面中點選「Chartboost mediation」。
前往「Resources」>「API Explorer」分頁,並記下「Authentication」部分下方的「User ID」和「User Signature」。
更新 app-ads.txt
Authorized Sellers for Apps (app-ads.txt) 是互動廣告協會科技實驗室 (IAB Tech Lab) 主持的一項計畫,旨在確保您的應用程式廣告空間僅於您授權的管道出售。為避免廣告收益大幅減少,請務必導入 app-ads.txt
檔案。
如果尚未建立,請為 Ad Manager 建立 app-ads.txt 檔案。
如要為 Chartboost 導入 app-ads.txt
,請參閱「app-ads.txt」一文。
開啟測試模式
如要在應用程式中啟用測試模式,請前往 Chartboost 使用者介面的「應用程式管理」分頁,從清單中選取應用程式,然後按一下「編輯應用程式設定」。
在應用程式設定中,你可以開啟應用程式的「測試模式」。
啟用測試模式後,您可以使用先前建立的廣告單元 ID 要求廣告,並接收 Chartboost 測試廣告。
您能接收 Chartboost 測試廣告後,應用程式就會進入 Chartboost 的發布商應用程式審查。如要在 Chartboost 上營利,發布商應用程式審查必須通過 Chartboost 核准。
步驟 2:在 Ad Manager 使用者介面設定 Chartboost 需求
進行廣告單元的中介服務設定
登入 Ad Manager 帳戶。
依序前往「廣告放送」>「收益群組」,然後按一下「新增收益群組」按鈕。
輸入收益群組的專屬名稱,將「狀態」設為「有效」, 選取「廣告格式」,並將「廣告空間類型」設為「行動應用程式」。 在「指定目標」>「廣告空間」部分下方,選取要加入中介服務的「廣告空間」和「行動應用程式」。
接著,按一下「新增收益夥伴」按鈕。
如果已有 Chartboost 的收益夥伴,可直接選取,否則,請選取「建立新的收益夥伴」。
將「廣告聯播網」設為「Chartboost」,輸入專屬「名稱」,並啟用「中介服務」。
開啟「自動資料收集」,然後輸入在上一個部分取得的「使用者 ID」和「使用者簽章」。
選取「收益夥伴」後,將「整合類型」設為「Mobile SDK 中介服務」、「平台」設為「Android」,並將「狀態」設為「有效」。輸入上一節取得的「應用程式 ID」、「應用程式簽章」和「廣告位置」。然後輸入預設千次曝光出價值。
Chartboost 廣告位置 (命名位置) 是簡單的名稱,代表您要在應用程式中顯示廣告的位置。 Ad Manager 會將要求傳送至設定中指定的位置。要求傳送後,Chartboost 會在使用者介面中新增該位置,以供報表使用。
在 Chartboost 使用者介面中,按一下「進階設定」,即可在「基本設定」頁面中查看廣告位置。詳情請參閱 Chartboost 具名位置指南。
完成後,按一下頁面下方的「儲存」。
將 Chartboost 新增至 GDPR 和美國州級法規廣告合作夥伴名單
請按照「歐洲法規設定」和「美國州級法規設定」中的步驟,在 Ad Manager 使用者介面,將 Chartboost 新增至歐洲和美國州級法規廣告合作夥伴名單。
步驟 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:24.5.0")
implementation("com.google.ads.mediation:chartboost:9.9.2.0")
}
手動整合
從 Maven Central 下載最新版 Chartboost SDK 的
.aar
檔案,並加入專案。前往 Google 的 Maven 存放區,找到 Chartboost 轉接程式構件。選取最新版本,下載 Chartboost 轉接程式的
.aar
檔案並新增至專案。
步驟 4:在 Chartboost SDK 導入隱私權設定
歐盟地區同意授權和 GDPR
為遵守《Google 歐盟地區使用者同意聲明政策》,您必須向歐洲經濟區、英國和瑞士的使用者揭露特定資訊,並在法律有相關規定時,取得他們對使用 Cookie 或其他本機儲存空間的同意聲明,以及對收集、分享及使用個人資料進行廣告個人化的同意聲明。本政策是配合《歐盟地區電子通訊隱私指令》和《一般資料保護規則》(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.xml
檔案中,將下列屬性新增至每個顯示 Chartboost 廣告並支援不同螢幕方向的活動:
android:configChanges="keyboardHidden|orientation|screenSize"
步驟 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 中介服務轉接程式變更記錄
版本 9.9.3.0 (進行中)
9.9.2.0 版
- 已驗證與 Chartboost SDK 9.9.2 版相容。
建構及測試時使用的版本:
- Google Mobile Ads SDK 24.5.0 版。
- Chartboost SDK 9.9.2 版。
9.9.1.0 版
- 已驗證與 Chartboost SDK 9.9.1 版相容。
建構及測試時使用的版本:
- Google Mobile Ads SDK 24.4.0 版。
- Chartboost SDK 9.9.1 版。
9.9.0.0 版
- 已驗證與 Chartboost SDK 9.9.0 版相容。
建構及測試時使用的版本:
- Google Mobile Ads SDK 24.4.0 版。
- Chartboost SDK 9.9.0 版。
9.8.3.1 版
- Android 的 API 最低需求級別更新為 23。
- Google Mobile Ads SDK 最低需求版本更新為 24.0.0。
建構及測試時使用的版本:
- Google Mobile Ads SDK 24.0.0 版。
- Chartboost SDK 9.8.3 版。
9.8.3.0 版
- 已驗證與 Chartboost SDK 9.8.3 版相容。
建構及測試時使用的版本:
- Google Mobile Ads SDK 23.6.0 版。
- Chartboost SDK 9.8.3 版。
9.8.2.0 版
- 已驗證與 Chartboost SDK 9.8.2 版相容。
建構及測試時使用的版本:
- Google Mobile Ads SDK 23.6.0 版。
- Chartboost SDK 9.8.2 版。
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)
方法,做為硬式編碼的方式,可選擇使用哪個應用程式 ID 和應用程式簽章來初始化 Chartboost SDK。 - 已驗證與 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 的轉接程式專案
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 版本].[轉接程式修補程式版本]。
- 現在,只要在 build.gradle 檔案的依附元件標記中新增下列內容,即可將轉接程式新增為編譯依附元件:
compile 'com.google.ads.mediation:chartboost:6.6.0.0'
- 改為以 aar 形式發布轉接程式,而非 jar 檔案 (詳情請參閱 README)。
1.1.0 版本
- 從 Chartboost 額外項目中移除 Chartboost 廣告位置。為中介服務設定 Chartboost 時,現在可在 AdMob 控制台中指定廣告位置。
1.0.0 版本
- 原始版本。支援獎勵影片廣告和插頁式廣告。