• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.advertising.AdsServiceExtensionAbility (广告扩展服务)(系统接口)
2
3<!--Kit: Ads Kit-->
4<!--Subsystem: Advertising-->
5<!--Owner: @SukiEvas-->
6<!--Designer: @zhansf1988-->
7<!--Tester: @hongmei_may-->
8<!--Adviser: @RayShih-->
9
10本模块为设备厂商提供广告扩展能力,设备厂商可自主实现单广告位请求和多广告位请求的业务逻辑。
11
12> **说明:**<br/>
13> 本模块首批接口从API version 11开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。<br/>
14> 本模块接口为系统接口。
15
16## 导入模块
17
18```ts
19import { AdsServiceExtensionAbility } from '@kit.AdsKit';
20```
21
22## AdsServiceExtensionAbility.onLoadAd
23
24onLoadAd(adParam: advertising.AdRequestParams, adOptions: advertising.AdOptions, respCallback: RespCallback)
25
26单广告位请求业务实现方法,设备厂商需在该方法中实现广告请求业务逻辑并将结果回调给媒体。
27
28**系统接口:** 此接口为系统接口。
29
30**系统能力:** SystemCapability.Advertising.Ads
31
32**参数:**
33
34| 参数名       | 类型                                                                  | 必填 | 说明          |
35|--------------|-----------------------------------------------------------------------|-----|-------------|
36| adParam      | advertising.[AdRequestParams](js-apis-advertising.md#adrequestparams) | 是   | 广告请求参数。 |
37| adOptions    | advertising.[AdOptions](js-apis-advertising.md#adoptions)             | 是   | 广告配置参数。 |
38| respCallback | [RespCallback](js-apis-adsserviceextensionability.md#respcallback)    | 是   | 广告请求回调。 |
39
40**示例:**
41
42```ts
43import { AdsServiceExtensionAbility, advertising, RespCallback } from '@kit.AdsKit';
44
45export default class AdsExtensionAbility extends AdsServiceExtensionAbility {
46  onLoadAd(adParam: advertising.AdRequestParams, adOptions: advertising.AdOptions, respCallback: RespCallback) {
47    const respData: Map<string, Array<advertising.Advertisement>> = new Map();
48    // 设置广告返回数据
49    // ...
50    respCallback(respData);
51  }
52}
53```
54
55## AdsServiceExtensionAbility.onLoadAdWithMultiSlots
56
57onLoadAdWithMultiSlots(adParams: advertising.AdRequestParams[], adOptions: advertising.AdOptions, respCallback: RespCallback)
58
59多广告位请求业务实现方法,设备厂商需在该方法中实现广告请求业务逻辑并将结果回调给媒体。
60
61**系统接口:** 此接口为系统接口。
62
63**系统能力:** SystemCapability.Advertising.Ads
64
65**参数:**
66
67| 参数名       | 类型                                                                    | 必填 | 说明          |
68|--------------|-------------------------------------------------------------------------|-----|-------------|
69| adParams     | advertising.[AdRequestParams](js-apis-advertising.md#adrequestparams)[] | 是   | 广告请求参数。 |
70| adOptions    | advertising.[AdOptions](js-apis-advertising.md#adoptions)               | 是   | 广告配置参数。 |
71| respCallback | [RespCallback](js-apis-adsserviceextensionability.md#respcallback)      | 是   | 广告请求回调。 |
72
73**示例:**
74
75```ts
76import { AdsServiceExtensionAbility, advertising, RespCallback } from '@kit.AdsKit';
77
78export default class AdsExtensionAbility extends AdsServiceExtensionAbility {
79  onLoadAdWithMultiSlots(adParams: advertising.AdRequestParams[], adOptions: advertising.AdOptions,
80    respCallback: RespCallback) {
81    const respData: Map<string, Array<advertising.Advertisement>> = new Map();
82    // 设置广告返回数据
83    // ...
84    respCallback(respData);
85  }
86}
87```