在法律有相應(yīng)要求的情況下，您必須征得用戶的同意才能使用其個(gè)人數(shù)據(jù)（例如OAID）來(lái)投放廣告。
HUAWEI Ads平臺(tái)投放的廣告包括個(gè)性化廣告和非個(gè)性化廣告。為了征求用戶意見(jiàn)，HUAWEI Ads平臺(tái)提供了Consent SDK。
本章節(jié)介紹了如何使用Consent SDK征求用戶意見(jiàn)，以及在征得用戶意見(jiàn)后如何根據(jù)用戶意見(jiàn)獲取廣告。
Consent SDK使用
1.集成Consent SDK。
a.在項(xiàng)目級(jí)build.gradle文件中配置Maven倉(cāng)地址：
buildscript {
repositories {
google()
jcenter()
//配置Consent SDK的Maven倉(cāng)地址
maven { url 'https://developer.huawei.com/repo/' }
}
...
}
allprojects {
repositories {
google()
jcenter()
//配置Consent SDK的Maven倉(cāng)地址
maven { url 'https://developer.huawei.com/repo/' }
}
}
b.在應(yīng)用級(jí)的build.gradle文件中添加編譯依賴：
c.將{version}替換為實(shí)際的版本號(hào)，版本號(hào)索引請(qǐng)參見(jiàn)版本更新說(shuō)明，修改如下：
dependencies {
implementation 'com.huawei.hms:ads-consent:3.4.39.302'
}
在完成以上的配置后，點(diǎn)擊工具欄中的gradle同步圖標(biāo)，完成“build.gradle”文件的同步，將相關(guān)依賴下載到本地。
2.更新用戶意見(jiàn)狀態(tài)。
使用Consent SDK時(shí)，應(yīng)確保Consent SDK獲得的是HUAWEI Ads平臺(tái)廣告技術(shù)提供商的最新信息。如果在征求用戶意見(jiàn)后，廣告技術(shù)提供商的列表發(fā)生改變，則Consent SDK會(huì)自動(dòng)將用戶意見(jiàn)置為未知狀態(tài)。因此在每次啟動(dòng)應(yīng)用時(shí)都必須通過(guò)調(diào)用requestConsentUpdate()方法確定用戶的意見(jiàn)狀態(tài)。
示例代碼如下所示：
Java
...
import com.huawei.hms.ads.consent.*;
...
public class ConsentActivity extends AppCompatActivity {
...
@Override
protected void onCreate(Bundle savedInstanceState) {
...
// 檢查consent狀態(tài)
checkConsentStatus();
...
}
...
private void checkConsentStatus() {
...
Consent consentInfo = Consent.getInstance(this);
...
consentInfo.requestConsentUpdate(new ConsentUpdateListener() {
@Override
public void onSuccess(ConsentStatus consentStatus, boolean isNeedConsent, List<AdProvider> adProviders) {
// 獲取用戶意見(jiàn)狀態(tài)成功
...
}
@Override
public void onFail(String errorDescription) {
// 獲取用戶意見(jiàn)狀態(tài)失敗
...
}
});
...
}
...
}
Kotlin
...
import com.huawei.hms.ads.consent.*
...
class ConsentActivity : BaseActivity() {
...
override fun onCreate(savedInstanceState: Bundle?) {
...
// 檢查consent狀態(tài)
checkConsentStatus()
...
}
...
private fun checkConsentStatus() {
...
val consentInfo = Consent.getInstance(this)
...
consentInfo.requestConsentUpdate(object : ConsentUpdateListener {
override fun onSuccess(consentStatus: ConsentStatus, isNeedConsent: Boolean, adProviders: List<AdProvider>) {
// 獲取用戶意見(jiàn)狀態(tài)成功
...
}
override fun onFail(errorDescription: String) {
// 獲取用戶意見(jiàn)狀態(tài)失敗
...
}
})
...
}
...
}
如果成功更新用戶意見(jiàn)信息，那么會(huì)通過(guò)ConsentUpdateListener的onSuccess()方法提供更新后的用戶意見(jiàn)狀態(tài)參數(shù)consentStatus、是否需要Consent參數(shù)isNeedConsent和廣告技術(shù)提供商的adProviders列表。
ConsentStatus具有以下三種狀態(tài)：
·如果回調(diào)參數(shù)isNeedConsent取值為false，則表明可以向HUAWEI Ads SDK請(qǐng)求個(gè)性化廣告。
·如果回調(diào)參數(shù)isNeedConsent取值為true，則表明該用戶在歐洲經(jīng)濟(jì)區(qū)內(nèi)或其他敏感地區(qū)內(nèi)，需要進(jìn)一步確認(rèn)用戶意見(jiàn)。
·當(dāng)返回的ConsentStatus為PERSONALIZED或NON_PERSONALIZED，則表明已征求過(guò)用戶意見(jiàn)，不需要再次征求。
·當(dāng)返回的ConsentStatus為UNKNOWN，則需要通過(guò)彈框等方式征求用戶意見(jiàn)。
如果ConsentUpdateListener返回onFail()時(shí)，則直接請(qǐng)求非個(gè)性化廣告。
AdProvider為廣告技術(shù)提供商信息，參數(shù)定義如下：
說(shuō)明
requestConsentUpdate()方法每次會(huì)請(qǐng)求網(wǎng)絡(luò)以更新廣告技術(shù)提供商列表，為了保障用戶體驗(yàn)，媒體可以自行實(shí)現(xiàn)超時(shí)控制。
3.征求用戶意見(jiàn)。
您需要通過(guò)彈框等方式向用戶征求意見(jiàn)，并展示廣告技術(shù)提供商的完整列表。以下是通過(guò)彈框征求用戶意見(jiàn)的樣例：
a.彈框征求用戶意見(jiàn)。
示例代碼如下所示：
Java
...
import com.huawei.hms.ads.consent.*;
...
public class ConsentActivity extends AppCompatActivity {
...
@Override
protected void onCreate(Bundle savedInstanceState) {
...
// 檢查consent狀態(tài)
checkConsentStatus();
...
}
...
private void checkConsentStatus() {
...
Consent consentInfo = Consent.getInstance(this);
...
consentInfo.requestConsentUpdate(new ConsentUpdateListener() {
@Override
public void onSuccess(ConsentStatus consentStatus, boolean isNeedConsent, List<AdProvider> adProviders) {
...
// 此返回參數(shù)代表是否需要consent
if (isNeedConsent) {
// UNKNOWN狀態(tài)，需要重新收集用戶信息
if (consentStatus == ConsentStatus.UNKNOWN) {
...
showConsentDialog();
}
// 如果是PERSONALIZED或者NON_PERSONALIZED狀態(tài)，則不需要彈框收集用戶意見(jiàn)
else {
...
}
} else {
...
}
}
@Override
public void onFail(String errorDescription) {
...
}
});
...
}
...
private void showConsentDialog() {
// 開(kāi)始Consent彈出框處理
ConsentDialog dialog = new ConsentDialog(this, mAdProviders);
dialog.setCallback(this);
dialog.setCanceledOnTouchOutside(false);
dialog.show();
}
}
Kotlin
...
import com.huawei.hms.ads.consent.*
...
class ConsentActivity : BaseActivity() {
...
override fun onCreate(savedInstanceState: Bundle?) {
...
// 檢查consent狀態(tài)
checkConsentStatus()
...
}
...
private fun checkConsentStatus() {
...
val consentInfo = Consent.getInstance(this)
...
consentInfo.requestConsentUpdate(object : ConsentUpdateListener {
override fun onSuccess(consentStatus: ConsentStatus, isNeedConsent: Boolean, adProviders: List<AdProvider>) {
...
// 此返回參數(shù)代表是否需要consent
if (isNeedConsent) {
// UNKNOWN狀態(tài)，需要重新收集用戶信息
if (consentStatus == ConsentStatus.UNKNOWN) {
...
showConsentDialog()
}
// 如果是PERSONALIZED或者NON_PERSONALIZED狀態(tài)，則不需要彈框收集用戶意見(jiàn)
else {
...
}
} else {
...
}
}
override fun onFail(errorDescription: String) {
// 獲取用戶意見(jiàn)狀態(tài)失敗
...
}
})
...
}
...
private fun showConsentDialog() {
// 開(kāi)始Consent彈出框處理
val dialog = ConsentDialog(this, mAdProviders)
dialog.setCallback(this)
dialog.setCanceledOnTouchOutside(false)
dialog.show()
}
}
對(duì)話框效果圖如下：
點(diǎn)擊“here”跳轉(zhuǎn)至更多信息：
b.展示廣告技術(shù)提供商列表。
您需要將廣告技術(shù)提供商的名稱展示給用戶，并提供訪問(wèn)廣告技術(shù)提供商隱私政策的入口。
通過(guò)點(diǎn)擊上述更多信息頁(yè)面中的here鏈接彈出廣告技術(shù)提供商列表對(duì)話框，效果如下：
c.設(shè)置用戶意見(jiàn)。
征得用戶意見(jiàn)后，請(qǐng)使用setConsentStatus()方法設(shè)置用戶的選擇。
示例代碼如下所示：
Java
Consent.getInstance(getApplicationContext()).setConsentStatus(ConsentStatus.PERSONALIZED);
Kotlin
Consent.getInstance(getApplicationContext()).setConsentStatus(ConsentStatus.PERSONALIZED)
說(shuō)明
請(qǐng)務(wù)必讓用戶可以隨時(shí)更改或撤消意見(jiàn)，并將用戶更新后的意見(jiàn)設(shè)置給Consent SDK。
d.設(shè)置“未達(dá)到法定承諾年齡用戶”的標(biāo)記。
如果您需要針對(duì)未達(dá)到法定承諾年齡的用戶請(qǐng)求對(duì)應(yīng)的廣告，則在調(diào)用requestConsentUpdate()前必須通過(guò)調(diào)用setUnderAgeOfPromise設(shè)置“未達(dá)到法定承諾年齡用戶”的標(biāo)記。
示例代碼如下所示：
Java
//設(shè)置“未達(dá)到法定承諾年齡用戶”的標(biāo)記
Consent.getInstance(getApplicationContext()).setUnderAgeOfPromise(true);
Kotlin
//設(shè)置“未達(dá)到法定承諾年齡用戶”的標(biāo)記
Consent.getInstance(getApplicationContext()).setUnderAgeOfPromise(true)
一旦將此設(shè)置為true，則每次requestConsentUpdate()請(qǐng)求均會(huì)回調(diào)onFail(String errorDescription)方法，并提供給用戶錯(cuò)誤描述參數(shù)errorDescription，此時(shí)不需要再展示征求用戶意見(jiàn)彈框。設(shè)置為false表明用戶已達(dá)到法定承諾年齡。
說(shuō)明
當(dāng)Consent SDK設(shè)置了此標(biāo)記后，在請(qǐng)求廣告時(shí)，基于受眾人群請(qǐng)求廣告中setTagForUnderAgeOfPromise的參數(shù)應(yīng)與Consent參數(shù)保持一致。
4.根據(jù)用戶意見(jiàn)獲取廣告。
請(qǐng)求廣告時(shí)，默認(rèn)不設(shè)置setNonPersonalizedAd方法，請(qǐng)求個(gè)性化廣告與非個(gè)性化廣告。如果用戶在Consent階段沒(méi)有做出選擇，則只能請(qǐng)求非個(gè)性化廣告。
如果設(shè)置setNonPersonalizedAd方法且值為：
·ALLOW_ALL：個(gè)性化廣告與非個(gè)性化廣告
·ALLOW_NON_PERSONALIZED：非個(gè)性化廣告
示例代碼如下所示：
Java
//setNonPersonalizedAd設(shè)置為ALLOW_NON_PERSONALIZED時(shí)，只請(qǐng)求非個(gè)性化廣告
RequestOptions requestOptions=HwAds.getRequestOptions();
requestOptions=requestOptions.toBuilder().setNonPersonalizedAd(ALLOW_NON_PERSONALIZED).build();
HwAds.setRequestOptions(requestOptions);
AdParam adParam=new AdParam.Builder().build();
adView.loadAd(adParam);
Kotlin
//setNonPersonalizedAd設(shè)置為ALLOW_NON_PERSONALIZED時(shí)，只請(qǐng)求非個(gè)性化廣告
var requestOptions:RequestOptions?=HwAds.getRequestOptions()
requestOptions=requestOptions.toBuilder().setNonPersonalizedAd(ALLOW_NON_PERSONALIZED).build()
HwAds.setRequestOptions(requestOptions)
val adParam=AdParam.Builder().build()
adView!!.loadAd(adParam)
Consent SDK測(cè)試
為了讓您能輕松地測(cè)試應(yīng)用，Consent SDK提供了可設(shè)置的調(diào)試選項(xiàng)。
1.調(diào)用getTestDeviceId()獲取設(shè)備ID。
示例代碼如下所示：
Java
String testDeviceId=Consent.getInstance(getApplicationContext()).getTestDeviceId();
Kotlin
val testDeviceId = Consent.getInstance(getApplicationContext()).testDeviceId
2.使用獲取的設(shè)備ID將您的設(shè)備作為調(diào)試設(shè)備列入允許清單。
示例代碼如下所示：
Java
Consent.getInstance(getApplicationContext()).addTestDeviceId(testDeviceId);
Kotlin
Consent.getInstance(getApplicationContext()).addTestDeviceId(testDeviceId)
調(diào)用setDebugNeedConsent設(shè)置是否需要Consent。
示例代碼如下所示：
Java
//設(shè)置調(diào)試需要Consent，此時(shí)ConsentUpdateListener方法返回的isNeedConsent參數(shù)為true
Consent.getInstance(getApplicationContext()).setDebugNeedConsent(DebugNeedConsent.DEBUG_NEED_CONSENT);
//設(shè)置調(diào)試不需要Consent，此時(shí)ConsentUpdateListener方法返回的isNeedConsent參數(shù)為false
Consent.getInstance(getApplicationContext()).setDebugNeedConsent(DebugNeedConsent.DEBUG_NOT_NEED_CONSENT);
Kotlin
// 設(shè)置調(diào)試需要Consent，此時(shí)ConsentUpdateListener方法返回的isNeedConsent參數(shù)為true
Consent.getInstance(getApplicationContext()).setDebugNeedConsent(DebugNeedConsent.DEBUG_NEED_CONSENT)
// 設(shè)置調(diào)試不需要Consent，此時(shí)ConsentUpdateListener方法返回的isNeedConsent參數(shù)為false
Consent.getInstance(getApplicationContext()).setDebugNeedConsent(DebugNeedConsent.DEBUG_NOT_NEED_CONSENT)
完成這些步驟后，調(diào)用更新用戶意見(jiàn)狀態(tài)時(shí)會(huì)根據(jù)您的調(diào)試狀態(tài)返回isNeedConsent的值。
說(shuō)明
如果把設(shè)備設(shè)置為測(cè)試設(shè)備，那么會(huì)返回固定的測(cè)試廣告技術(shù)提供商列表，無(wú)法驗(yàn)證真實(shí)廣告技術(shù)提供商列表變化的場(chǎng)景。
HUAWEI Ads
專欄
閩公網(wǎng)安備 35010202001226號(hào)
