Advertising

Definition

[h2]qg.setUnderAgeOfPromise(boolean underAgeOfPromise) (1077+)

• Description

  Sets the flag indicating whether a user is below the age of consent.

• Parameters

  Parameter	Type	Mandatory	Description
  underAgeOfPromise	boolean	Yes	true: below the age of consent false: at or above the age of consent

• Sample code

  qg.setUnderAgeOfPromise(true)

[h2]qg.requestConsentUpdate(Object object) (1077+)

• Description

  Requests an update to the user's consent status.

• Parameters

  Parameter	Type	Mandatory	Description
  success	function	No	Called when the request to update the user's consent status succeeds. For details, please refer to Parameters in the success callback function.
  fail	function	No	Called when the request to update the user's consent status fails.
  complete	function	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

  • Parameters in the success callback function

    Parameter	Type	Description
    consentStatus	number	Consent status. 0: The user has agreed to receive personalized and non-personalized ads. 1: The user has agreed to receive only non-personalized ads. 2: The user neither agrees nor declines to receive personalized or non-personalized ads.
    isNeedConsent	boolean	Indicates whether user consent is required. false: Personalized ads can be requested from the Petal Ads SDK. true: The user is in the EEA or another sensitive region, and user consent must be obtained.
    AdProviderList	array	Ad technology provider information list. For details about the AdProvider object structure, please refer to Parameters in AdProvider.

    • Parameters in AdProvider

      Parameter	Description
      id	ID of an ad technology provider.
      name	Name of an ad technology provider.
      serviceArea	Service area of an ad technology provider.
      privacyPolicyUrl	URL of the privacy policy of an ad technology provider.

• Sample code

  qg.requestConsentUpdate({
    success: function(data) {
      console.log('requestConsentUpdate success data ' + JSON.stringify(data))
    },
    fail: function(data) {
      console.log('requestConsentUpdate fail data ' + JSON.stringify(data))
    },
    complete: function() {},
  })

[h2]qg.setConsentStatus(number consentStatus) (1077+)

• Description

  Sets a user's consent status.

• Parameters

  Parameter	Type	Mandatory	Description
  consentStatus	number	Yes	User consent. 0: (PERSONALIZED) The user has agreed to receive personalized and non-personalized ads. 1: (NON_PERSONALIZED) The user has agreed to receive only non-personalized ads. 2: (UNKNOWN) The user neither agrees nor declines to receive personalized or non-personalized ads.

• Sample code

  qg.setConsentStatus(1)

[h2]qg.setTagForChildProtection(number childProtection) (1078+)

• Description

  Sets whether to process ad requests according to the COPPA.

• Parameters

  Parameter	Type	Mandatory	Description
  childProtection	number	Yes	Indicates whether to process ad requests according to the COPPA. -1: You do not want to specify whether your ad content needs to be COPPA-compliant. 0: Your ad content does not need to be COPPA-compliant. 1: You ad content needs to be COPPA-compliant (no ad will be returned for this ad request).

• Sample code

  qg.setTagForChildProtection(1)

[h2]qg.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr) (1078+)

• Description

  Sets whether to process ad requests in a manner appropriate for users below the age of consent.

• Parameters

  Parameter	Type	Mandatory	Description
  underAgeOfPromiseStr	number	Yes	Indicates whether to process ad requests in a manner appropriate for users below the age of consent. -1: You have not specified whether to process ad requests in a manner appropriate for users below the age of consent. 0: You do not want to process ad requests in a manner appropriate for users below the age of consent. 1: You want to process ad requests in a manner appropriate for users below the age of consent.

• Sample code

  qg.setTagForUnderAgeOfPromise(1)

[h2]qg.setAdContentClassification(string adContentClassification) (1078+)

• Description

  Sets the maximum ad content rating.

• Parameters

  Parameter	Type	Mandatory	Description
  adContentClassification	string	Yes	Ad content rating. W: content suitable for young children and above PI: content suitable for children and above J: content suitable for teenagers and above A: content suitable only for adults

• Sample code

  qg.setAdContentClassification('W')

[h2]qg.setNonPersonalizedAd(number personalizedAd) (1078+)

• Description

  Sets whether to request non-personalized ads.

• Parameters

  Parameter	Type	Mandatory	Description
  personalizedAd	number	Yes	Indicates whether to request non-personalized ads. 0: Request both personalized and non-personalized ads. 1: Request non-personalized ads.

• Sample code

  qg.setNonPersonalizedAd(1)

[h2]qg.createNativeAd(Object object) (1075+)

• Description

  Creates a native ad component. If a native ad component has been created before, the API returns the existing one.

• Parameters

  Parameter	Type	Mandatory	Description
  adUnitId	string	Yes	Native ad unit ID.
  success	function	No	Callback function triggered upon a successful API call. Code 0 indicates success.
  fail	function	No	Callback function triggered upon a failed API call. The failure cause is returned.
  complete	function	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

• Returns

  Native ad component.

• Sample code

  let nativeAd = qg.createNativeAd({
      adUnitId: 'xxx',
      success: (code) => {
          console.log("loadNativeAd loadNativeAd : success");
      },
      fail: (data, code) => {
          console.log("loadNativeAd loadNativeAd fail: " + data + "," + code);
      },
      complete: () => {
          console.log("loadNativeAd loadNativeAd : complete");
      }
  });

[h2]nativeAd.load() (1075+)

• Description

  Obtains ad data. On success, the onLoad callback is triggered; on failure, the onError callback is triggered.

  

  Currently, Huawei returns one ad data record each time the API is called.

• Parameters

  Parameter	Type	Mandatory	Description
  channelExtras	Object	No	Extended parameter. For details, please refer to Parameters in channelExtras.

  • Parameters in channelExtras

    Parameter	Type	Mandatory	Description
    customerChannel	string	No	Ad launch channel. The value ranges from 0 to 100.

• Sample code

  nativeAd.onLoad((data) => {
    console.info('ad data loaded: ' + JSON.stringify(data))
    this.adItemData = data.adList[0]
  })
  nativeAd.load({
    "channelExtras": { 
      "customerChannel": "1"
    } 
  })

[h2]nativeAd.reportAdShow() (1075+)

• Description

  Reports ad impressions. Only one report is valid for each ad. adId is a field in the ad data obtained by using the load method.

• Parameters

  Parameter	Type	Mandatory	Description
  adId	string	Yes	Ad ID, which is returned in the onload callback.

• Sample code

  nativeAd.reportAdShow({
      adId: "xxx"
  })

[h2]nativeAd.reportAdClick() (1075+)

• Description

  Reports ad clicks. Only one report is valid for each ad. adId is a field in the ad data obtained by using the load method.

• Parameters

  Parameter	Type	Mandatory	Description
  adId	string	Yes	Ad ID, which is returned in the onload callback.

• Sample code

  nativeAd.reportAdClick({
      adId: "xxx",
  })

[h2]nativeAd.onLoad(function callback) (1075+)

• Description

  Sets the callback for successful ad loading.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Function triggered after ad loading is complete. The callback data is an object containing the ad list in form {adList: xxx}. For details, please refer to Parameters in callback.

  • Parameters in callback

    Parameter	Type	Description
    adList	array	Ad details. For details, please refer to Parameters in item.

    • Parameters in item

      Parameter	Type	Description
      adId	string	Ad ID, which is used to report impressions and clicks.
      title	string	Ad title.
      source (1077+)	string	Ad source.
      icon	string	Icon of a promoted app.
      imgUrlList	array	List of image URLs.
      videoUrlList	array	List of video URLs.
      videoRatio(1078+)	array	Ad video aspect ratio.
      logoUrl	string	Ad logo image. NOTE: Currently, Huawei returns only an empty string "".
      clickBtnTxt	string	Text displayed on a clickable button.
      creativeType	number	Ad type. 1: text 2: large image 3: large image and text 4: GIF image 6: video and text 7: small image and text 8: three small images and text 9: video 10: icon (text) 103: large image and text with a download button 106: video and text with a download button 107: small image and text with a download button 108: three small images and text with a download button 102: large image with a download button 101: text with a download button 110: icon (text) with a download button NOTE: The value options of Huawei differ from those of the ad alliance.
      interactionType	number	Interaction type after an ad is clicked. 0: none 1: browsing 2: download 3: browser opening (download landing page displayed) 4: app home page opening 5: app details page opening NOTE: Currently, the value returned by Huawei is always 0.
      appName	string	App package name.
      versionName	string	App version number.
      developerName	string	App operator information.
      appDetailUrl	string	HTML5 address of the app introduction page. Opening this page via qg.openDeeplink is recommended.
      permissionUrl	string	HTML5 address of the app permission statement page. Opening this page via qg.openDeeplink is recommended.
      privacyUrl	string	Privacy policy URL of the app. Opening this page via qg.openDeeplink is recommended.

• Sample code

  nativeAd.onLoad((data) => {
   console.info('ad data loaded: ' + JSON.stringify(data))
   this.adItemData = data.adList[0]
  })

[h2]nativeAd.offLoad() (1075+)

• Description

  Removes the listener for successful native ad loading.

• Sample code

  nativeAd.offLoad();

[h2]nativeAd.onError(function callback) (1075+)

• Description

  Listens for native ad error events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Function triggered when an error occurs during ad loading. The callback data is an object containing the result code and message. For details, please refer to Parameters in callback.

  • Parameters in callback

    Parameter	Type	Description
    errCode	number	Result code.
    errMsg	string	Message.

• Sample code

  nativeAd.onError((e) => {
    console.error('load ad error:' + JSON.stringify(e));
    const errCode = e.errCode
    const errMsg = e.errMsg
  })

[h2]nativeAd.offError() (1075+)

• Description

  Removes the listener for native ad loading errors.

[h2]nativeAd.setTagForChildProtection(number childProtection) (1077+)

• Description

  Sets whether to process ad requests according to the COPPA.

• Parameters

  Parameter	Type	Mandatory	Description
  childProtection	number	Yes	Indicates whether to process ad requests according to the COPPA. -1: You do not want to specify whether your ad content needs to be COPPA-compliant. 0: Your ad content does not need to be COPPA-compliant. 1: You ad content needs to be COPPA-compliant (no ad will be returned for this ad request).

• Sample code

  nativeAd.setTagForChildProtection(1)

[h2]nativeAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr) (1077+)

• Description

  Sets whether to process ad requests in a manner appropriate for users below the age of consent.

• Parameters

  Parameter	Type	Mandatory	Description
  underAgeOfPromiseStr	number	Yes	Indicates whether to process ad requests in a manner appropriate for users below the age of consent. -1: You have not specified whether to process ad requests in a manner appropriate for users below the age of consent. 0: You do not want to process ad requests in a manner appropriate for users below the age of consent. 1: You want to process ad requests in a manner appropriate for users below the age of consent.

• Sample code

  nativeAd.setTagForUnderAgeOfPromise(1)

[h2]nativeAd.setAdContentClassification(string adContentClassification) (1077+)

• Description

  Sets the maximum ad content rating.

• Parameters

  Parameter	Type	Mandatory	Description
  adContentClassification	string	Yes	Ad content rating. W: content suitable for young children and above PI: content suitable for children and above J: content suitable for teenagers and above A: content suitable only for adults

• Sample code

  nativeAd.setAdContentClassification('W')

[h2]nativeAd.setNonPersonalizedAd(number personalizedAd) (1077+)

• Description

  Sets whether to request non-personalized ads.

• Parameters

  Parameter	Type	Mandatory	Description
  personalizedAd	number	Yes	Indicates whether to request non-personalized ads. 0: Request both personalized and non-personalized ads. 1: Request non-personalized ads.

• Sample code

  nativeAd.setNonPersonalizedAd(1)

[h2]nativeAd.startDownload(Object object) (1078+)

• Description
  • If the target app has not been installed, the user will be redirected to the corresponding ad landing page, where they can decide whether to manually download and install the app.
  • If the target app has already been installed, the user will be redirected to the corresponding ad landing page, where they can decide whether to manually open the app.
• Parameters

  Parameter	Type	Mandatory	Description
  adId	string	Yes	Ad ID, which is returned in the onload callback.

• Returns

  Value	Type	Description
  0	number	Call success.
  -1	number	The method failed due to incorrect parameters. For example, the asset is not an app download ad.

• Sample code

  const resultCode = nativeAd.startDownload({
      adId: "xxx"
  })
  console.log('startDownloadresultCode = ' + resultCode );

[h2]nativeAd.showDownloadButton(Object object) (1115+)

• Description

  Displays control buttons.

• Parameters

  Parameter	Type	Mandatory	Description
  adId	string	Yes	Native ad unit ID, returned in the callback of nativeAd.load().
  style	Object	Yes	Control button style. For details, please refer to Parameters in style.
  success	function	No	Callback function triggered upon a successful API call. Code 0 indicates success.
  fail	function	No	Callback function triggered upon a failed API call.
  complete	function	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

  • Parameters in style

    Parameter	Type	Mandatory	Description
    left	number	Yes	X-coordinate of the control's upper left corner, in pixels.
    top	number	Yes	Y-coordinate of the control's upper left corner, in pixels.
    width	number	No	Control width, in pixels.
    fixedWidth	boolean	No	Indicates whether the control has a fixed width. true: Scale down the text if the text length exceeds the width. If the text still cannot be completely displayed after being scaled down to 9 sp, the text is truncated. false: The control width is determined by the text length and meets both the requirements specified by minWidth and maxWidth. The default value is false.
    minWidth	number	No	Minimum control width, in pixels.
    maxWidth	number	No	Maximum control width, in pixels.
    heightType	string	No	Control height. normal: 40 dp short: 28 dp The default value is normal.
    textSize	number	No	Font size of the text, in pixels.
    font	string	No	Font.
    horizontalPadding	number	No	Left and right padding, in pixels.
    cornerRadius	number	No	Button corner radius, in pixels.
    normalTextColor	string	No	Text color in the normal style, for example, #005BBA.
    normalBackground	string	No	Button background color in the normal style, for example, #0D000000.
    pressedColor	string	No	Button pressed-state color in the normal style, for example, #1A000000.
    normalStroke	number	No	Button stroke width in the normal style, in pixels.
    normalStrokeCorlor	string	No	Button stroke color in the normal style, for example, #0D000000.
    processingTextColor	string	No	Text color in the processing state, for example, #000000.
    processingBackground	string	No	Button background color in the processing state, for example, #00000000.
    processingColor	string	No	Button progress color in the processing state, for example, #33007dff.
    processingStroke	number	No	Button stroke width in the processing state, in pixels.
    processingStrokeCorlor	string	No	Button stroke color in the processing state, for example, #33007dff.
    installingTextColor	string	No	Text color in the installing state, for example, #005BBA.
    installingBackground	string	No	Button background color in the installing state, for example, #0D000000.
    installingStroke	number	No	Button stroke width in the installing state, in pixels.
    installingStrokeCorlor	string	No	Button stroke color in the installing state, for example, #0D000000.

• Sample code

  this.nativeAd.showDownloadButton({
                  adId : "1**345",
                  style : {
                      left:300,
                      top:500,
                      heightType:'short',
                      width:300,
                      fixedWidth:true,
                      minWidth:200,
                      maxWidth:500,
                      textSize:50,
                      horizontalPadding:50,
                      cornerRadius:22,
                      normalTextColor:'#FFFFFF',
                      normalBackground:'#5291FF',
                      pressedColor:'#0A59F7',
                      normalStroke:5,
                      normalStrokeCorlor:'#FF000000',
                      processingTextColor:'#5291FF',
                      processingBackground:'#0F000000',
                      processingColor:'#000000',
                      processingStroke:10,
                      processingStrokeCorlor:'#0A59F7',
                      installingTextColor:'#000000',
                      installingBackground:'#FFFFFF',
                      installingStroke:15,
                      installingStrokeCorlor:'#5291FF'
                  },
                  success: (code) => {
                      console.log("showDownloadButton: success");
                  },
                  fail: (data, code) => {
                      console.log("showDownloadButton fail: " + data + "," + code);
                  },
                  complete: () => {
                      console.log("showDownloadButton : complete");
                  }
              });

[h2]nativeAd.hideDownloadButton(Object object) (1115+)

• Description

  Hides control buttons.

• Parameters

  Parameter	Type	Mandatory	Description
  adId	string	Yes	Native ad unit ID, returned in the callback of nativeAd.load().
  success	function	No	Callback function triggered upon a successful API call. Code 0 indicates success.
  fail	function	No	Callback function triggered upon a failed API call.
  complete	function	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

• Sample code

  nativeAd.hideDownloadButton({
                    adId : "1**345",
                    success: (code) => {
                        console.log("hideDownloadButton: success");
                   },
                    fail: (data, code) => {
                        console.log(" hideDownloadButton fail: " + data + "," + code);
                    },
                    complete: () => {
                        console.log("hideDownloadButton : complete");
                    }
  });

[h2]nativeAd.destroy() (1075+)

• Description

  Destroys a native ad.

• Sample code

  nativeAd.destroy();

[h2]qg.createRewardedVideoAd(Object object) (1075+)

• Description

  Creates a rewarded video ad. If an ad with the same adUnitId has already been created, the existing instance will be reused. After creation, the ad assets will be loaded. This API returns a singleton instance that is valid only within the current scene and must not be used across scenes.

• Parameters

  Parameter	Type	Mandatory	Description
  adUnitId	string	Yes	ID of a rewarded video ad unit.
  multiton	boolean	No	Indicates whether to enable the multi-instance mode. The default value is false (1077+).
  success	function	No	Callback triggered upon success. Code 0 indicates success.
  fail	function	No	Callback triggered upon failure, which returns the cause of the failure.
  complete	function	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

• Returns

  Rewarded video ad component.

• Sample code

  let rewardedVideoAd = qg.createRewardedVideoAd({
      adUnitId: 'xxx',
      success: (code) => {
          console.log("ad demo : loadAndShowVideoAd createRewardedVideoAd: success");
      },
      fail: (data, code) => {
          console.log("ad demo : loadAndShowVideoAd createRewardedVideoAd fail: " + data + "," + code);
      },
      complete: () => {
          console.log("ad demo : loadAndShowVideoAd createRewardedVideoAd complete");
      }
  });

[h2]rewardedVideoAd.load() (1075+)

• Description

  Manually obtains ads for refreshing the ad content. On success, the onLoad callback is triggered; on failure, the onError callback is triggered.

  

  If requests are sent too frequently, onError may be triggered.

• Parameters

  Parameter	Type	Mandatory	Description
  channelExtras	Object	No	Extended parameter. For details, please refer to Parameters in channelExtras.

  • Parameters in channelExtras

    Parameter	Type	Mandatory	Description
    customerChannel	string	No	Ad launch channel. The value ranges from 0 to 100.

• Sample code

  rewardedVideoAd.onLoad(() => {
    console.log('ad loaded.')
  })
  rewardedVideoAd.load({
    "channelExtras": { 
      "customerChannel": "1"
    } 
  })

[h2]rewardedVideoAd.show() (1075+)

• Description

  Displays the rewarded video ad. The rewarded video ad component is hidden by default, and calling show() will make it visible. If the call fails, the onError callback will be triggered.

• Sample code

  rewardedVideoAd.onError((e) => {
    console.error('load ad error:' + JSON.stringify(e));
    const errCode = e.errCode
    const errMsg = e.errMsg
  })
  rewardedVideoAd.show()

[h2]rewardedVideoAd.onLoad(function callback) (1075+)

• Description

  Sets the callback for successful ad loading.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Function triggered after ad loading is complete.

• Sample code

  rewardedVideoAd.onLoad(() => {
    console.log('ad loaded.')
  })

[h2]rewardedVideoAd.offLoad() (1075+)

• Description

  Removes the listener for successful rewarded video ad loading.

• Sample code

  rewardedVideoAd.offLoad();

[h2]rewardedVideoAd.onClose(function callback) (1075+)

• Description

  Listens for rewarded video ad closing events. A rewarded video ad can be closed only when the user actively closes it.

• Parameters

  Parameter	Type	Description
  callback	function	Function triggered after an ad is closed. The callback parameter is {isEnded: xxx}.

  • Parameters in callback

    Parameter	Type	Description
    isEnded	boolean	Indicates whether a rewarded video ad is closed after being completely watched. true: The rewarded video ad is closed after a user watches it completely. false: The rewarded video ad is closed during video playback.

• Sample code

  rewardedVideoAd.onClose((res) => {
    console.log('ad onClose: ' + res.isEnded)
  })

[h2]rewardedVideoAd.offClose() (1075+)

• Description

  Removes the listener for rewarded video ad closing events.

• Sample code

  rewardedVideoAd.offClose();

[h2]rewardedVideoAd.onError(function callback) (1075+)

• Description

  Listens for rewarded video ad error events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Function triggered when an error occurs during ad loading. The callback data is an object containing the result code and message.

  • Parameters in callback

    Parameter	Type	Description
    errCode	number	Result code.
    errMsg	string	Message.

• Sample code

  rewardedVideoAd.onError((e) => {
    console.error('load ad error:' + JSON.stringify(e));
    const errCode = e.errCode
    const errMsg = e.errMsg
  })

[h2]rewardedVideoAd.offError() (1075+)

• Description

  Removes the listener for rewarded video ad loading error events.

• Sample code

  rewardedVideoAd.offError();

[h2]rewardedVideoAd.setTagForChildProtection(number childProtection) (1077+)

• Description

  Sets whether to process ad requests according to the COPPA.

• Parameters

  Parameter	Type	Mandatory	Description
  childProtection	number	Yes	Indicates whether to process ad requests according to the COPPA. -1: You do not want to specify whether your ad content needs to be COPPA-compliant. 0: Your ad content does not need to be COPPA-compliant. 1: You ad content needs to be COPPA-compliant (no ad will be returned for this ad request).

• Sample code

  rewardedVideoAd.setTagForChildProtection(1)

[h2]rewardedVideoAd.setTagForUnderAgeOfPromise(number underAgeOfPromiseStr) (1077+)

• Description

  Sets whether to process ad requests in a manner appropriate for users below the age of consent.

• Parameters

  Parameter	Type	Mandatory	Description
  underAgeOfPromiseStr	number	Yes	Indicates whether to process ad requests in a manner appropriate for users below the age of consent. -1: You have not specified whether to process ad requests in a manner appropriate for users below the age of consent. 0: You do not want to process ad requests in a manner appropriate for users below the age of consent. 1: You want to process ad requests in a manner appropriate for users below the age of consent.

• Sample code

  rewardedVideoAd.setTagForUnderAgeOfPromise(1)

[h2]rewardedVideoAd.setAdContentClassification(string adContentClassification) (1077+)

• Description

  Sets the maximum ad content rating.

• Parameters

  Parameter	Type	Mandatory	Description
  adContentClassification	string	Yes	Ad content rating. W: content suitable for young children and above PI: content suitable for children and above J: content suitable for teenagers and above A: content suitable only for adults

• Sample code

  rewardedVideoAd.setAdContentClassification('W')

[h2]rewardedVideoAd.setNonPersonalizedAd(number personalizedAd) (1077+)

• Description

  Sets whether to request non-personalized ads.

• Parameters

  Parameter	Type	Mandatory	Description
  personalizedAd	number	Yes	Indicates whether to request non-personalized ads. 0: Request both personalized and non-personalized ads. 1: Request non-personalized ads.

• Sample code

  rewardedVideoAd.setNonPersonalizedAd(1)

[h2]rewardedVideoAd.destroy() (1075+)

• Description

  Destroys a rewarded video ad.

• Sample code

  rewardedVideoAd.destroy();

[h2]qg.createBannerAd(Object object) (1078+)

• Description

  Creates a banner ad component. If a banner ad component has been created before, the API returns the existing one.

• Parameters

  Parameter	Type	Mandatory	Description
  adUnitId	string	Yes	Banner ad unit ID.
  style	object	Yes	Style of the banner ad component. For details, please refer to Parameters in style.
  adIntervals	number	No	Interval for automatically refreshing an ad, in seconds. The value ranges from 30 to 120. The recommended value is 60. If this parameter is not passed, banner ads will not be automatically refreshed. This parameter is valid only when the API is called for the first time. If this parameter is not set for the first time, the setting is invalid in subsequent calls. The setting is valid only when the ad is re-created after the bannerAd.destroy() API is called to destroy the ad.

  • Parameters in style

    Parameter	Type	Mandatory	Description
    top	number	Yes	Y coordinate of the upper left corner of the banner ad component.
    left	number	Yes	X coordinate of the upper left corner of the banner ad component.
    width	number	Yes	Width of the banner ad component, in dp.
    height	number	Yes	Height of the banner ad component, in dp.

    The following table describes the restrictions on the width and height of the ad component.

    Width	Height	Description
    360	57	Regular banner ads, applicable to 1080 x 170 px ad assets.
    360	144	Large banner ads, applicable to 1080 x 432 px ad assets.
    160	600	Not supported in the Chinese mainland.
    300	250	Not supported in the Chinese mainland.
    320	100	Not supported in the Chinese mainland.
    320	50	Not supported in the Chinese mainland.
    468	60	Not supported in the Chinese mainland.
    728	90	Not supported in the Chinese mainland.
    -1	-2	The ad width and height automatically adapt to the screen size.

• Returns

  Banner ad component bannerAd. You can use bannerAd.style to obtain the actual width and height of an ad. The returns are described as follows.

  Parameter	Type	Description
  top	number	Y coordinate of the upper left corner of the banner ad component.
  left	number	X coordinate of the upper left corner of the banner ad component.
  width	number	Width of the banner ad component, in dp.
  height	number	Height of the banner ad component, in dp.
  realWidth	number	Actual width of the banner ad component, in pixels.
  realHeight	number	Actual height of the banner ad component, in pixels.

• Sample code

  let bannerAd = qg.createBannerAd({
      adUnitId: 'testw6vs28auh3',
      style:{
          top:20,
          left:20,
          height:57,
          width:360
      }
  })

[h2]bannerAd.show() (1078+)

• Description

  Loads and displays a banner ad. When an error occurs, onError is triggered. When the loading is successful, onLoad is triggered.

• Parameters

  Parameter	Type	Mandatory	Description
  channelExtras	Object	No	Extended parameter. For details, please refer to Parameters in channelExtras.

  • Parameters in channelExtras

    Parameter	Type	Mandatory	Description
    customerChannel	string	No	Ad launch channel. The value ranges from 0 to 100.

• Sample code

  bannerAd.show({
    "channelExtras": { 
      "customerChannel": "1"
    } 
  })

[h2]bannerAd.hide() (1078+)

• Description

  Hides a banner ad.

• Sample code

  bannerAd.hide();

[h2]bannerAd.onError(function callback) (1078+)

• Description

  Listens for banner ad error events.

• Returns

  Object.

  Parameter	Type	Mandatory	Description
  errMsg	string	Yes	Message.
  errCode	number	Yes	Result code.

• Sample code

  bannerAd.onError((err)=>{
      console.log(err)
  })

[h2]bannerAd.offError() (1078+)

• Description

  Removes the listener for banner ad error events.

• Sample code

  bannerAd.offError();

[h2]bannerAd.onLoad(function callback) (1078+)

• Description

  Listens for banner ad loading events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Function triggered after ad loading is complete.

• Sample code

  bannerAd.onLoad(() => {
      console.log('ad loaded.');
  });

[h2]bannerAd.offLoad() (1078+)

• Description

  Removes the listener for banner ad loading events.

• Sample code

  bannerAd.offLoad();

[h2]bannerAd.onClose(function callback) (1078+)

• Description

  Listens for banner ad closing events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Function triggered after an ad is closed.

• Sample code

  bannerAd.onClose(() => {
      console.log('ad closed.');
  });

[h2]bannerAd.offClose() (1078+)

• Description

  Removes the listener for banner ad closing events.

• Sample code

  bannerAd.offClose();

[h2]bannerAd.destroy() (1078+)

• Description

  Destroys a banner ad.

• Sample code

  bannerAd.destroy();

[h2]qg.createInterstitialAd(Object object) (1078+)

• Description

  Creates an interstitial ad component. If an interstitial ad component has been created before, the API returns the existing one.

• Parameters

  Parameter	Type	Mandatory	Description
  adUnitId	String	Yes	Interstitial ad unit ID.

• Sample code

  let interstitialAd = qg.createInterstitialAd({
      adUnitId: 'xxxx'
  })

[h2]interstitialAd.load() (1078+)

• Description

  Loads an interstitial ad.

• Parameters

  Parameter	Type	Mandatory	Description
  channelExtras	Object	No	Extended parameter. For details, please refer to Parameters in channelExtras.

  • Parameters in channelExtras

    Parameter	Type	Mandatory	Description
    customerChannel	string	No	Ad launch channel. The value ranges from 0 to 100.

• Sample code

  interstitialAd.load({
    "channelExtras": { 
      "customerChannel": "1"
    } 
  })

[h2]interstitialAd.show() (1078+)

• Description

  Displays an interstitial ad.

• Sample code

  interstitialAd.show();

[h2]interstitialAd.onLoad(function callback) (1078+)

• Description

  Listens for interstitial ad loading events.

• Sample code

  interstitialAd.onLoad(function (data) {
      console.log('onLoad data ' + JSON.stringify(data));
  });

[h2]interstitialAd.offLoad() (1078+)

• Description

  Removes the listener for interstitial ad loading events.

• Sample code

  interstitialAd.offLoad();

[h2]interstitialAd.onError(function callback) (1078+)

• Description

  Listens for interstitial ad error events.

• Returns

  Parameter	Type	Description
  errMsg	string	Message.
  errCode	number	Result code.

• Sample code

  interstitialAd.onError((err)=>{
      console.log(err)
  })

[h2]interstitialAd.offError() (1078+)

• Description

  Removes the listener for interstitial ad error events.

• Sample code

  interstitialAd.offError();

[h2]interstitialAd.onClose(function callback) (1078+)

• Description

  Listens for interstitial ad closing events.

• Sample code

  interstitialAd.onClose(()=>{
      console.log('interstitialAd closed');
  })

[h2]interstitialAd.offClose() (1078+)

• Description

  Removes the listener for interstitial ad closing events.

• Sample code

  interstitialAd.offClose();

[h2]interstitialAd.onClick(function callback) (1078+)

• Description

  Listens for interstitial ad click events.

• Sample code

  interstitialAd.onClick(()=>{
      console.log('interstitialAd clicked');
  })

[h2]interstitialAd.offClick() (1078+)

• Description

  Removes the listener for interstitial ad click events.

• Sample code

  interstitialAd.offClick();

[h2]interstitialAd.destroy() (1078+)

• Description

  Destroys an interstitial ad.

• Sample code

  interstitialAd.destroy()

Result Codes

A result code is the information obtained through the onError method.