IconAd

Kotlin |Java

public interface IconAd extends Ad

---

An ad that highlights an app icon. This ad is composed of ad assets which are displayed as Android UI components.

Summary

Nested types
public static class IconAd.Companion

Public methods
abstract AdChoicesInfo	getAdChoicesInfo() The information for the AdChoices attribution.
abstract IconAdEventCallback	getAdEventCallback() Callback for receiving icon ad lifecycle events.
abstract String	getCallToAction() The ad's call to action (such as "Buy" or "Install").
abstract String	getHeadline() The primary text headline.
abstract @NonNull Image	getIcon() An image for the icon.
abstract Double	getStarRating() A star rating from 0 to 5 representing how many stars the app has in the store offering it.
default static final void	load(     @NonNull IconAdRequest adRequest,     @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback ) Loads an IconAd, providing the result via adLoadCallback.
default static final void	loadFromAdResponse(     @NonNull String adResponse,     @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback ) Loads an IconAd, providing the result via adLoadCallback.
abstract void	setAdEventCallback(IconAdEventCallback adEventCallback) Callback for receiving icon ad lifecycle events.

Inherited methods

From com.google.android.libraries.ads.mobile.sdk.common.Ad abstract void destroy() Destroys the ad, stopping any extra processing and destroying resources associated with the ad. abstract long getPlacementId() An identifier for a placement in reporting. abstract @NonNull ResponseInfo getResponseInfo() Gets information about the ad response for this ad. abstract void setPlacementId(long placementId) An identifier for a placement in reporting.

Public methods

getAdChoicesInfo

abstract AdChoicesInfo getAdChoicesInfo()

The information for the AdChoices attribution.

getAdEventCallback

abstract IconAdEventCallback getAdEventCallback()

Callback for receiving icon ad lifecycle events.

getCallToAction

abstract String getCallToAction()

The ad's call to action (such as "Buy" or "Install").

getHeadline

abstract String getHeadline()

The primary text headline.

getIcon

abstract @NonNull Image getIcon()

An image for the icon.

getStarRating

abstract Double getStarRating()

A star rating from 0 to 5 representing how many stars the app has in the store offering it.

load

default static final void load(
    @NonNull IconAdRequest adRequest,
    @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback
)

Loads an IconAd, providing the result via adLoadCallback.

Parameters
@NonNull IconAdRequest adRequest	An IconAdRequest with targeting information.
@NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback	A callback to be invoked when loading completes.

loadFromAdResponse

default static final void loadFromAdResponse(
    @NonNull String adResponse,
    @NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback
)

Loads an IconAd, providing the result via adLoadCallback.

Parameters
@NonNull String adResponse	An ad response from a server-to-server ad request.
@NonNull AdLoadCallback<@NonNull IconAd> adLoadCallback	A callback to be invoked when loading completes.

setAdEventCallback

abstract void setAdEventCallback(IconAdEventCallback adEventCallback)

Callback for receiving icon ad lifecycle events.