NativeAd

static interface

NativeAd.NativeAdLoadedListener

Listens for native ad loading successes.

NativeAd()

Constructs a native ad.

abstract void

destroy()

Destroys an ad object.

abstract void

dislikeAd(DislikeAdReason reason)

Dislikes the current ad as requested by a user.

abstract String

getAdSign()

Obtains a flag indicating whether a task is an ad task.

abstract String

getAdSource()

Obtains the ad source.

abstract String

getCallToAction()

Obtains the text to be displayed on an ad interaction button, for example, View details or Install.

abstract int

getCreativeType()

Obtains an ad creative type.

abstract String

getDescription()

Obtains the description of an ad.

abstract List<DislikeAdReason>

getDislikeAdReasons()

Obtains the "Dislike this ad" option.

Map<String, String>

getExt()

Obtains ad extension information.

abstract Image

getIcon()

Obtains the icon of an ad.

abstract List<Image>

getImages()

Obtains multi-image assets of an ad.

abstract MediaContent

getMediaContent()

Obtains the multimedia content for an ad.

abstract String

getTitle()

Obtains the title of an ad.

abstract String

getUniqueId()

Obtains the advertising ID.

abstract Video

getVideo()

Obtains video assets of an ad.

abstract VideoOperator

getVideoOperator()

Obtains the video controller of an ad.

abstract String

getWhyThisAd()

Obtains the redirection link to Why this ad.

abstract void

gotoWhyThisAdPage(Context context)

Goes to the Why this ad page.

abstract boolean

isCustomClickAllowed()

Checks whether custom click gestures are enabled.

abstract boolean

isCustomDislikeThisAdEnabled()

Checks whether custom ad disliking is enabled.

abstract void

onAdClose(Context context, List<String> keyWords)

Called when an ad is closed.

abstract void

recordClickEvent()

Reports a custom click event.

abstract boolean

recordClickEvent(Bundle data)

Reports a custom click event.

abstract boolean

recordImpressionEvent(Bundle data)

Reports an ad impression.

abstract boolean

recordShowStartEvent(Bundle data)

Reports an event indicating that an ad starts to be shown.

abstract void

setAllowCustomClick()

Enables custom click gestures.

abstract void

setDislikeAdListener(DislikeAdListener listener)

Sets an ad disliking listener.

abstract void

triggerClick(Bundle data)

Reports a click.

abstract boolean

hasAdvertiserInfo()

Checks whether advertiser information is delivered for the current ad.

abstract List<AdvertiserInfo>

getAdvertiserInfo()

Obtains the advertiser information.

abstract void

showAppDetailPage(Context context)

Shows the introduction page of the promoted app.

abstract boolean

isTransparencyOpen()

Checks whether ad transparency information is displayed.

abstract String

getTransparencyTplUrl()

Obtains the redirection URL of the ad transparency information.

abstract int

getInterActionType()

Obtains the ad purpose.

abstract void

setVideoConfiguration(VideoConfiguration videoConfiguration)

Sets video playback parameters.

For details, please refer to VideoConfiguration.

abstract BiddingInfo

getBiddingInfo()

Obtains the real-time bidding data returned to the app.

void

sendBiddingSuccess(Map<String, Object> sendSuccessInfo, ReportUrlListener reportUrlListener)

Reports the bidding success result.

void

sendBiddingFailed(Map<String, Object> sendFailInfo, ReportUrlListener reportUrlListener)

Reports the bidding failure result.

public NativeAd()

Constructs a native ad.

public abstract void destroy()

Destroys an ad object. After calling destroy(), do not call any other methods on the ad object.

public abstract void dislikeAd(DislikeAdReason reason)

Dislikes the current ad as requested by a user.

reason

Reason why a user dislikes an ad.

public abstract String getAdSign()

Obtains a flag indicating whether a task is an ad task.

String

Whether a task is an ad task.

• 0: no
• 1: yes

The default value is 1.

public abstract String getAdSource()

Obtains the ad source.

String

Ad source.

public abstract String getCallToAction()

Obtains the text to be displayed on an ad interaction button, for example, View details or Install.

String

Text to be displayed on a button.

public abstract int getCreativeType()

Obtains an ad creative type.

int

Ad creative type.

• 1: text.
• 2: large image.
• 3: large image with text.
• 4: GIF image
• 5: no specific type (for the scenario where metadata is returned in magazine unlock).
• 6: video with text.
• 7: small image with text.
• 8: three small images with text.
• 9: video.
• 12: dual-slot video.
• 100: unknown type, which is returned when an error occurs.
• 101: text with a download button.
• 102: large image with a download button.
• 103: large image with text and a download button.
• 106: video with text and a download button.
• 107: small image with text and a download button.
• 108: three small images with text and a download button.

public abstract String getDescription()

Obtains the description of an ad.

String

Ad description.

public abstract List<DislikeAdReason> getDislikeAdReasons()

Obtains the "Dislike this ad" option.

List<DislikeAdReason>

"Dislike this ad" option.

public Map<String, String> getExt()

Obtains ad extension information.

Map<String, String>

Ad extension information.

public abstract Image getIcon()

Obtains the icon of an ad.

Image

Icon of an ad.

public abstract List<Image> getImages()

Obtains multi-image assets of an ad.

List<Image>

Multi-image assets of an ad.

public abstract MediaContent getMediaContent()

Obtains the multimedia content for an ad.

MediaContent

Multimedia content for an ad.

public abstract String getTitle()

Obtains the title of an ad.

String

Ad title.

public abstract String getUniqueId()

Obtains the advertising ID.

String

Advertising ID.

public abstract Video getVideo()

Obtains video assets of an ad.

Video

Video assets of an ad.

public abstract VideoOperator getVideoOperator()

Obtains the video controller of an ad.

VideoOperator

Video controller of an ad.

public abstract String getWhyThisAd()

Obtains the redirection link to Why this ad.

String

Redirection link to Why this ad.

public abstract void gotoWhyThisAdPage(Context context)

Opens the page indicating why this ad or the ad transparency information is displayed.

context

Context.

public abstract boolean isCustomClickAllowed()

Checks whether custom click gestures are enabled.

boolean

Whether custom click gestures are enabled.

• true: yes
• false: no

The default value is false.

public abstract boolean isCustomDislikeThisAdEnabled()

Checks whether custom ad disliking is enabled.

boolean

Whether custom ad disliking is enabled.

• true: yes
• false: no

The default value is false.

public abstract void onAdClose(Context context, List<String> keyWords)

Called when an ad is closed.

context

Context.

keyWords

Ad keyword.

public abstract void recordClickEvent()

Reports a custom click event.

public abstract boolean recordClickEvent(Bundle data)

Reports a custom click event.

data

Click event data. You can pass clickX, clickY, and creativeSize to data, which helps traffic monetization.

• clickX: horizontal coordinate of the click position relative to the ad unit.

  Value type: int; value unit: px; example: 10

• clickY: vertical coordinate of the click position relative to the ad unit.

  Value type: int; value unit: px; example: 10

• creativeSize: ad unit dimensions (width x height).

  Value type: string; value unit: px; example: 1080 x 600

boolean

Whether a custom click event is reported successfully.

• true: yes
• false: no

The default value is false.

public abstract boolean recordImpressionEvent(Bundle data)

Reports an ad impression.

data

Impression data.

boolean

Whether an ad impression is reported successfully.

• true: yes
• false: no

public abstract boolean recordShowStartEvent(Bundle data)

Reports an event indicating that an ad starts to be shown.

data

Data carried in the reported event.

boolean

Whether an event indicating that an ad starts to be shown is reported successfully.

• true: yes
• false: no

public abstract void setAllowCustomClick()

Enables custom click gestures.

public abstract void setDislikeAdListener(DislikeAdListener listener)

Sets an ad disliking listener.

listener

Ad disliking listener.

public abstract void triggerClick(Bundle data)

Manually triggers a click.

data

Click data. You can pass clickX, clickY, and creativeSize to data, which helps traffic monetization.

• clickX: horizontal coordinate of the click position relative to the ad unit.

  Value type: int; value unit: px; example: 10

• clickY: vertical coordinate of the click position relative to the ad unit.

  Value type: int; value unit: px; example: 10

• creativeSize: ad unit dimensions (width x height).

  Value type: string; value unit: px; example: 1080 x 600

public abstract boolean hasAdvertiserInfo()

Checks whether advertiser information is delivered for the current ad.

boolean

Whether to deliver advertiser information. The options are true (yes) and false (no).

public abstract List getAdvertiserInfo()

Obtains the advertiser information.

List<AdvertiserInfo>

Advertiser information list.

public abstract void showAppDetailPage(Context context)

Shows the introduction page of the promoted app.

context

Context.

public abstract boolean isTransparencyOpen()

Checks whether ad transparency information is displayed.

boolean

Indicates whether ad transparency information is displayed.

public abstract String getTransparencyTplUrl()

Obtains the redirection URL of the ad transparency information.

String

Redirection URL of the ad transparency information.

public abstract int getInterActionType()

Obtains the ad purpose.

int

Ad purpose. The options are as follows:

0: for display only (No action is taken after the ad is tapped.)

1: web promotion (A web page is opened when the ad is tapped.)

2: app download (An app is downloaded when the ad is tapped.)

3: app or quick app engagement (The app or quick app is opened when the ad is tapped.)

5: app promotion (When the ad is tapped, the app is downloaded if it is not installed and opened if it is installed.)

7: e-commerce web page (When the ad is tapped, the app is downloaded if it is installed and a web page is opened if the app is not installed.)

8: scheduled download

9: HarmonyOS service

10: mini program startup

Public abstract void setVideoConfiguration(VideoConfiguration videoConfiguration)

Sets video playback parameters.

videoConfiguration

Video configuration that controls video playback.

public abstract BiddingInfo getBiddingInfo()

Obtains the real-time bidding data returned to the app.

BiddingInfo

Real-time bidding information returned by the ADX.

public void sendBiddingSuccess(Map<String, Object> sendSuccessInfo, ReportUrlListener reportUrlListener)

Reports the bidding success result.

sendSuccessInfo

Macro replacement parameters when a bid is successful; of the Map type.

The key represents the macro that needs to be replaced in the URL and is of the String type, while the value represents the corresponding replacement information and is of the Object type.

For details about macro replacement, please refer to Real-Time Bidding.

ReportUrlListener

Called when the bidding result is reported.

public void sendBiddingFailed(Map<String, Object> sendFailInfo, ReportUrlListener reportUrlListener)

Reports the bidding failure result.

sendFailInfo

Macro replacement parameters for a failed bid; of the Map type.

The key represents the macro that needs to be replaced in the URL and is of the String type, while the value represents the corresponding replacement information and is of the Object type.

For details about macro replacement, please refer to Real-Time Bidding.

ReportUrlListener

Called when the bidding result is reported.