Interface StickyBannerPlacement
-
- All Implemented Interfaces:
-
com.intentsoftware.addapptr.Placement
@Deprecated(message = "Use the AutoLoadBannerPlacement instead.") public interface StickyBannerPlacement implements Placement
Placement used for obtaining banner ads.
-
-
Method Summary
Modifier and Type Method Description abstract UnitstartAutoReload()Enables automatic reloading of placement. abstract UnitstartAutoReload(Integer seconds)Enables automatic reloading of placement and sets custom reload time. abstract UnitstopAutoReload()Disables automatic reloading of placement. abstract UnitsetAutoreloadInterval(Integer seconds)Sets reload time that will be used instead of time configured on addapptr.com account. abstract Booleanreload()Requests placement reload. abstract Booleanreload(Boolean force)Requests placement reload. abstract BooleanhasAd()Returns true if there is an ad loaded for given placementId. abstract ViewgetPlacementView()Returns placement view. abstract UnitsetDefaultImage(Bitmap image)Sets placement default image. abstract UnitsetDefaultImage(Integer resId)Sets placement default image. abstract UnitsetContentGravity(Integer gravity)Sets gravity for ads that don't fill entire placement area. abstract UnitenableCreativeHistory(Integer size)Enables the banner creative history. abstract Array<PlacementHistoryInfo>getCreativeHistory()Retrieves the banner creative history (if it was enabled). abstract StickyBannerPlacementListenergetListener()Set the placement listener that will listen to ad loading and display events. abstract UnitsetListener(StickyBannerPlacementListener listener)Set the placement listener that will listen to ad loading and display events. abstract AATKit.StatisticsListenergetStatisticsListener()Sets the statistics listener that will be notified about placement reporting events, like counted adspace, request etc. abstract UnitsetStatisticsListener(AATKit.StatisticsListener statisticsListener)Sets the statistics listener that will be notified about placement reporting events, like counted adspace, request etc. abstract ImpressionListenergetImpressionListener()Sets the impression listener for the given placement. abstract UnitsetImpressionListener(ImpressionListener impressionListener)Sets the impression listener for the given placement. abstract CollapsibleBannerOptionsgetCollapsibleBannerOptions()Setting for Google collapsible banners. abstract UnitsetCollapsibleBannerOptions(CollapsibleBannerOptions collapsibleBannerOptions)Setting for Google collapsible banners. abstract Map<String, List<String>>getTargetingInfo()Sets the targeting information for the given placement. abstract UnitsetTargetingInfo(Map<String, List<String>> targetingInfo)Sets the targeting information for the given placement. abstract StringgetContentTargetingUrl()Sets the content targeting url for the application. abstract UnitsetContentTargetingUrl(String contentTargetingUrl)Sets the content targeting url for the application. abstract List<String>getMultiContentTargetingUrls()Sets the multi content targeting url for the application. abstract UnitsetMultiContentTargetingUrls(List<String> multiContentTargetingUrls)Sets the multi content targeting url for the application. -
-
Method Detail
-
startAutoReload
abstract Unit startAutoReload()
Enables automatic reloading of placement. Autoreloader will use reload time configured on addapptr.com account or fallback to default {@value #BANNER_DEFAULT_RELOAD_INTERVAL_IN_SECONDS} seconds.
-
startAutoReload
abstract Unit startAutoReload(Integer seconds)
Enables automatic reloading of placement and sets custom reload time. This reload time will be used instead of time configured on addapptr.com account.
- Parameters:
seconds- Interval between ad reloads.
-
stopAutoReload
abstract Unit stopAutoReload()
Disables automatic reloading of placement.
-
setAutoreloadInterval
abstract Unit setAutoreloadInterval(Integer seconds)
Sets reload time that will be used instead of time configured on addapptr.com account.
- Parameters:
seconds- Interval between ad reloads.
-
reload
abstract Boolean reload()
Requests placement reload. Works only if automatic reloading is disabled.
- Returns:
True if call ends in causing a placement to reload, false otherwise.
-
reload
abstract Boolean reload(Boolean force)
Requests placement reload. Works only if automatic reloading is disabled.
- Parameters:
force- True if you want to be able to reload and show new banner before set banner reload interval (default: 30s) between reloads, false otherwise.- Returns:
True if call ends in causing a placement to reload, false otherwise.
-
hasAd
abstract Boolean hasAd()
Returns true if there is an ad loaded for given placementId.
- Returns:
True if there is an ad loaded for given placementId.
-
getPlacementView
abstract View getPlacementView()
Returns placement view. Works only for banner placements.
- Returns:
Placement view or null.
-
setDefaultImage
abstract Unit setDefaultImage(Bitmap image)
Sets placement default image. This image will be shown in placement when no ad is available.
- Parameters:
image- The bitmap to set.
-
setDefaultImage
abstract Unit setDefaultImage(Integer resId)
Sets placement default image. This image will be shown in placement when no ad is available.
- Parameters:
resId- The identifier of the resource.
-
setContentGravity
abstract Unit setContentGravity(Integer gravity)
Sets gravity for ads that don't fill entire placement area. Works only for banner placements.
- Parameters:
gravity- The android.view.Gravity to set.
-
enableCreativeHistory
abstract Unit enableCreativeHistory(Integer size)
Enables the banner creative history.
-
getCreativeHistory
abstract Array<PlacementHistoryInfo> getCreativeHistory()
Retrieves the banner creative history (if it was enabled).
-
getListener
abstract StickyBannerPlacementListener getListener()
Set the placement listener that will listen to ad loading and display events.
-
setListener
abstract Unit setListener(StickyBannerPlacementListener listener)
Set the placement listener that will listen to ad loading and display events.
-
getStatisticsListener
abstract AATKit.StatisticsListener getStatisticsListener()
Sets the statistics listener that will be notified about placement reporting events, like counted adspace, request etc.
-
setStatisticsListener
abstract Unit setStatisticsListener(AATKit.StatisticsListener statisticsListener)
Sets the statistics listener that will be notified about placement reporting events, like counted adspace, request etc.
-
getImpressionListener
abstract ImpressionListener getImpressionListener()
Sets the impression listener for the given placement.
-
setImpressionListener
abstract Unit setImpressionListener(ImpressionListener impressionListener)
Sets the impression listener for the given placement.
-
getCollapsibleBannerOptions
abstract CollapsibleBannerOptions getCollapsibleBannerOptions()
Setting for Google collapsible banners. Default is null, meaning disabled support for collapsible banners.
-
setCollapsibleBannerOptions
abstract Unit setCollapsibleBannerOptions(CollapsibleBannerOptions collapsibleBannerOptions)
Setting for Google collapsible banners. Default is null, meaning disabled support for collapsible banners.
-
getTargetingInfo
abstract Map<String, List<String>> getTargetingInfo()
Sets the targeting information for the given placement. Information provided for placement overrides targeting information for application set by the setTargetingInfo.
-
setTargetingInfo
abstract Unit setTargetingInfo(Map<String, List<String>> targetingInfo)
Sets the targeting information for the given placement. Information provided for placement overrides targeting information for application set by the setTargetingInfo.
-
getContentTargetingUrl
abstract String getContentTargetingUrl()
Sets the content targeting url for the application. This information will be used only if no placement-specific targeting is available.
-
setContentTargetingUrl
abstract Unit setContentTargetingUrl(String contentTargetingUrl)
Sets the content targeting url for the application. This information will be used only if no placement-specific targeting is available.
-
getMultiContentTargetingUrls
abstract List<String> getMultiContentTargetingUrls()
Sets the multi content targeting url for the application. Not all ad-networks supports multiple urls.
-
setMultiContentTargetingUrls
abstract Unit setMultiContentTargetingUrls(List<String> multiContentTargetingUrls)
Sets the multi content targeting url for the application. Not all ad-networks supports multiple urls.
-
-
-
-