library-core/com.naver.gfpsdk.caching/GfpAdCacheManager

GfpAdCacheManager

A class that manages ad caching. It caches ad responses and resources to disk, allowing ads to be preloaded at desired times and loaded more quickly. This is useful for situations where ads must be loaded at a cold-start, such as splash ads.

Types

LoadCallback

interface LoadCallback

Callback for loading cached adCallResponse.

PrefetchCallback

interface PrefetchCallback

Callback for ad prefetching.

Functions

clear

@JvmStatic

fun clear(context: Context, adUnitId: String)

Clear disk caches of specific ad unit id.

clearAll

@JvmStatic

fun clearAll(context: Context)

Clear all disk caches.

load

@JvmStatic

fun load(context: Context, adParam: AdParam, type: GfpAdCacheType, callback: GfpAdCacheManager.LoadCallback, autoPrefetchNext: Boolean = true, prefetchCallback: GfpAdCacheManager.PrefetchCallback? = null)

Load an ad response instance cached through prefetch from disk, propagating adParam to the auto-prefetch ad call when autoPrefetchNext is enabled.

@JvmStatic

fun ~~load~~(context: Context, adUnitId: String, type: GfpAdCacheType, callback: GfpAdCacheManager.LoadCallback, autoPrefetchNext: Boolean = true, prefetchCallback: GfpAdCacheManager.PrefetchCallback? = null)

Load an ad response instance cached through GfpAdCacheManager.prefetch from disk. All resources required to load the ad in that response are also cached on disk. You can load the ad directly using com.naver.gfpsdk.GfpAdLoader.loadAd with the returned com.naver.gfpsdk.internal.services.adcall.AdCallResponse.

prefetch

@JvmStatic

fun prefetch(context: Context, adParam: AdParam, type: GfpAdCacheType, callback: GfpAdCacheManager.PrefetchCallback? = null)

Prefetch and cache response and resources of ad to disk, applying targeting from adParam. The supplied adParam (customParam, keywords, content info, prebid params, etc.) is sent with the prefetch ad call so that the cached response reflects the publisher's targeting.

@JvmStatic

fun ~~prefetch~~(context: Context, adUnitId: String, type: GfpAdCacheType, callback: GfpAdCacheManager.PrefetchCallback? = null)

Prefetch and cache response and resources of ad to disk. The number of ad cache files stored on disk cannot exceed 5 per ad unit. It's recommended to call from a worker thread because it involves file I/O.