华为HarmonyOS打造开放、合规的广告生态 - 激励广告

1. import { advertising, identifier } from '@kit.AdsKit';
2. import { common } from '@kit.AbilityKit';
3. import { hilog } from '@kit.PerformanceAnalysisKit';
4. import { BusinessError } from '@kit.BasicServicesKit';
6. @Entry
7. @Component
8. struct Index {
9. private ads: Array<advertising.Advertisement> = [];
10. private context = getContext(this) as common.UIAbilityContext;
11. private oaid: string = '';
13. aboutToAppear() {
14. try {
15. // 使用Promise回调方式获取OAID
16. identifier.getOAID().then((data: string) => {
17. this.oaid = data;
18. hilog.info(0x0000, 'testTag', '%{public}s', 'Succeeded in getting adsIdentifierInfo by promise');
19. }).catch((error: BusinessError) => {
20. hilog.error(0x0000, 'testTag', '%{public}s', `Failed to get adsIdentifierInfo, message: ${error.message}`);
21. })
22. } catch (error) {
23. hilog.error(0x0000, 'testTag', '%{public}s', `Catch err, code: ${error.code}, message: ${error.message}`);
24. }
25. }
27. build() {
28. Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
29. Row() {
30. Button('requestAd').onClick(() => {
31. let load: advertising.AdLoader = new advertising.AdLoader(this.context);
32. this.requestAd(load);
33. }).width('45%')
34. }
35. }
36. }
38. private requestAd(adLoader: advertising.AdLoader): void {
39. const adRequestParam: advertising.AdRequestParams = {
40. // 广告类型：激励广告
41. adType: 7,
42. // 'testx9dtjwj8hp'为测试专用的广告位ID，App正式发布时需要改为正式的广告位ID
43. adId: 'testx9dtjwj8hp',
44. // 开放匿名设备标识符
45. oaid: this.oaid
46. };
47. const adOption: advertising.AdOptions = {
48. // 设置是否请求非个性化广告
49. nonPersonalizedAd: 0,
50. // 是否允许流量下载0：不允许，1：允许，不设置以广告主设置为准
51. allowMobileTraffic: 0,
52. // 是否希望根据 COPPA 的规定将您的内容视为面向儿童的内容: -1默认值，不确定 0不希望 1希望
53. tagForChildProtection: -1,
54. // 是否希望按适合未达到法定承诺年龄的欧洲经济区 (EEA) 用户的方式处理该广告请求： -1默认值，不确定 0不希望 1希望
55. tagForUnderAgeOfPromise: -1,
56. // 设置广告内容分级上限: W: 3+,所有受众 PI: 7+,家长指导 J:12+,青少年 A: 16+/18+，成人受众
57. adContentClassification: 'A'
58. };
59. const adLoaderListener: advertising.AdLoadListener = {
60. onAdLoadFailure: (errorCode: number, errorMsg: string) => {
61. hilog.error(0x0000, 'testTag', '%{public}s',
62. `Failed to request ad, message: ${errorMsg}, error code: ${errorCode}`);
63. },
64. onAdLoadSuccess: (ads: Array<advertising.Advertisement>) => {
65. hilog.info(0x0000, 'testTag', '%{public}s', `Succeeded in requesting ad`);
66. this.ads.push(...ads);
67. },
68. };
69. adLoader.loadAd(adRequestParam, adOption, adLoaderListener);
70. }
71. }

开发者需要在App中订阅com.huawei.hms.pps.action.PPS_REWARD_STATUS_CHANGED事件来监听激励广告页面变化并接收奖励信息。示例代码中的订阅方法registerPPSReceiver()需要在每次展示广告前调用 。

在订阅到公共事件后，可以从CommonEventData的parameters参数中使用"reward_ad_status"作为key值获取激励广告页面变化状态，使用"reward_ad_data"作为key值获取奖励信息，属性rewardType用来获取奖励物品的名称，rewardAmount用来获取奖励物品的数量。

示例代码如下所示：

1. import { commonEventManager, BusinessError } from '@kit.BasicServicesKit';
2. import { hilog } from '@kit.PerformanceAnalysisKit';
4. const KEY_REWARD_DATA = "reward_ad_data";
5. const KEY_REWARD_STATUS = "reward_ad_status";
7. export class RewardAdStatusHandler {
8. // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
9. private subscriber: commonEventManager.CommonEventSubscriber | null = null;
11. // 订阅方法，需要在每次展示广告前调用
12. public registerPPSReceiver(): void {
13. if (this.subscriber) {
14. this.unRegisterPPSReceiver();
15. }
16. // 订阅者信息
17. const subscribeInfo: commonEventManager.CommonEventSubscribeInfo = {
18. events: ['com.huawei.hms.pps.action.PPS_REWARD_STATUS_CHANGED'],
19. // publisherBundleName被设置为"com.huawei.hms.adsservice",这意味着只有来自该包名的事件才会被订阅者接受和处理。
20. // 如果没有明确声明publisherBundleName，那么订阅者可能会收到来自其它包名的伪造事件，从而导致安全性问题或误导。
21. publisherBundleName: 'com.huawei.hms.adsservice'
22. };
23. // 创建订阅者回调
24. commonEventManager.createSubscriber(subscribeInfo, (err: BusinessError, commonEventSubscriber:
25. commonEventManager.CommonEventSubscriber) => {
26. if (err) {
27. hilog.error(0x0000, 'testTag', '%{public}s',
28. `createSubscriber error, code: ${err.code}, message: ${err.message}`);
29. return;
30. }
31. hilog.info(0x0000, 'testTag', '%{public}s', 'Succeeded in creating subscriber');
32. this.subscriber = commonEventSubscriber;
33. // 订阅公共事件回调
34. if (!this.subscriber) {
35. hilog.warn(0x0000, 'testTag', '%{public}s', 'Need create subscriber');
36. return;
37. }
38. commonEventManager.subscribe(this.subscriber, (err: BusinessError, commonEventSubscriber:
39. commonEventManager.CommonEventData) => {
40. if (err) {
41. hilog.error(0x0000, 'testTag', '%{public}s', `Subscribe error, code: ${err.code}, message: ${err.message}`);
42. } else {
43. hilog.info(0x0000, 'testTag', '%{public}s', 'Subscribe data');
44. const status: string = commonEventSubscriber?.parameters?.[KEY_REWARD_STATUS];
45. switch (status) {
46. case AdStatus.AD_OPEN:
47. hilog.info(0x0000, 'testTag', '%{public}s', 'onAdOpen');
48. break;
49. case AdStatus.AD_CLICKED:
50. hilog.info(0x0000, 'testTag', '%{public}s', 'onAdClick');
51. break;
52. case AdStatus.AD_CLOSED:
53. hilog.info(0x0000, 'testTag', '%{public}s', 'onAdClose');
54. this.unRegisterPPSReceiver();
55. break;
56. case AdStatus.AD_REWARDED:
57. const rewardData: Record<string, string | number> = commonEventSubscriber?.parameters?.[KEY_REWARD_DATA];
58. const rewardType: string = rewardData?.rewardType as string;
59. const rewardAmount: number = rewardData?.rewardAmount as number;
60. hilog.info(0x0000, 'testTag', '%{public}s',
61. `onAdReward, rewardType: ${rewardType}, rewardAmount: ${rewardAmount}`);
62. break;
63. case AdStatus.AD_VIDEO_START:
64. hilog.info(0x0000, 'testTag', '%{public}s', 'onAdVideoStart');
65. break;
66. case AdStatus.AD_COMPLETED:
67. hilog.info(0x0000, 'testTag', '%{public}s', 'onAdCompleted');
68. break;
69. default:
70. break;
71. }
72. }
73. });
74. });
75. }
77. // 取消订阅
78. public unRegisterPPSReceiver(): void {
79. commonEventManager.unsubscribe(this.subscriber, (err: BusinessError) => {
80. if (err) {
81. hilog.error(0x0000, 'testTag', '%{public}s', `Unsubscribe error, code: ${err.code}, message: ${err.message}`);
82. } else {
83. hilog.info(0x0000, 'testTag', '%{public}s', 'Succeeded in unsubscribing');
84. this.subscriber = null;
85. }
86. });
87. }
88. }
90. enum AdStatus {
91. AD_OPEN = 'onAdOpen',
92. AD_CLICKED = 'onAdClick',
93. AD_CLOSED = 'onAdClose',
94. AD_REWARDED = 'onAdReward',
95. AD_VIDEO_START = 'onVideoPlayBegin',
96. AD_COMPLETED = 'onVideoPlayEnd'
97. }

1. import { advertising } from '@kit.AdsKit';
2. import { common } from '@kit.AbilityKit';
4. @Entry
5. @Component
6. struct Index {
7. private context: common.UIAbilityContext = getContext(this) as common.UIAbilityContext;
8. // 步骤2中请求到的广告内容
9. private ads: Array<advertising.Advertisement> = [];
10. private displayOptions: advertising.AdDisplayOptions = {
11. // 激励广告视频播放是否静音
12. mute: true
13. };
15. build() {
16. Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
17. Row() {
18. Button('showAd').onClick(() => {
19. this.showAd();
20. }).width('45%')
21. }
22. }
23. }
25. private showAd() {
26. let load: advertising.AdLoader = new advertising.AdLoader(this.context);
27. // 此处ads[0]表示请求到的第一个广告，用户根据实际情况选择
28. advertising.showAd(this.ads[0], this.displayOptions, this.context);
29. }
30. }