AppOpenAdPreloader

public final class AppOpenAdPreloader


开屏广告的预加载器。

摘要

公共方法

static boolean
destroy(String preloadId)

停止为给定 preloadId 预加载,并销毁所有关联的预加载广告。

static void

停止预加载并销毁所有预加载配置的预加载广告。

static @Nullable PreloadConfiguration

返回与此 preloadId 关联的开屏广告 PreloadConfiguration;如果不存在,则返回 null。

static Map<StringPreloadConfiguration>

返回所有应用打开广告 PreloadConfiguration 的映射,按关联的预加载 ID 作为键。

static int

返回给定预加载 ID 的可用广告数量。

static boolean
isAdAvailable(String preloadId)

确定给定 preloadId 是否至少有 1 条广告可用。

static @Nullable AppOpenAd
pollAd(String preloadId)

返回从 startstart 预加载的广告,并将其从缓存中移除。

static boolean
start(String preloadId, PreloadConfiguration preloadConfiguration)

开始为指定的 preloadIdPreloadConfiguration 预加载广告。

static boolean
start(
    String preloadId,
    PreloadConfiguration preloadConfiguration,
    PreloadCallbackV2 preloadCallback
)

开始为指定的 preloadIdPreloadConfiguration 和 预加载广告。

公共方法

销毁

public static boolean destroy(String preloadId)

停止为给定 preloadId 预加载,并销毁所有关联的预加载广告。

参数
String preloadId

要销毁的配置的预加载 ID。

返回
boolean

true,如果已销毁有效的预加载配置。如果指定的 preloadId 没有有效的预加载配置,则返回 false

destroyAll

public static void destroyAll()

停止预加载并销毁所有预加载配置的预加载广告。

getConfiguration

public static @Nullable PreloadConfiguration getConfiguration(String preloadId)

返回与此 preloadId 关联的开屏广告 PreloadConfiguration;如果不存在,则返回 null。

参数
String preloadId

与此配置相关联的预加载 ID。

返回
@Nullable PreloadConfiguration

给定预加载 ID 的 PreloadConfiguration;如果给定预加载 ID 没有配置,则为 null

getConfigurations

public static Map<StringPreloadConfigurationgetConfigurations()

返回所有应用打开广告 PreloadConfiguration 的映射,按关联的预加载 ID 作为键。

返回
Map<StringPreloadConfiguration>

开屏广告配置;如果不存在预加载器,则返回空映射。

getNumAdsAvailable

public static int getNumAdsAvailable(String preloadId)

返回给定预加载 ID 的可用广告数量。

参数
String preloadId

用于检查可用性的预加载 ID。

返回
int

给定预加载 ID 的可用广告数量。

isAdAvailable

public static boolean isAdAvailable(String preloadId)

确定给定 preloadId 是否至少有 1 条广告可用。

参数
String preloadId

用于检查可用性的预加载 ID。

返回
boolean

如果指定的预加载 ID 有可用的广告,则为 true;否则为 false

pollAd

public static @Nullable AppOpenAd pollAd(String preloadId)

返回从 startstart 预加载的广告,并将其从缓存中移除。

请注意,这可能是为 preloadId 预加载的任何广告。返回的顺序无法保证与 onAdPreloaded 事件的顺序一致。

参数
String preloadId

广告的预加载 ID。

返回
@Nullable AppOpenAd

指定预加载 ID 的开屏广告,如果没有可用的广告,则为 null

start

public static boolean start(String preloadId, PreloadConfiguration preloadConfiguration)

开始为指定的 preloadIdPreloadConfiguration 预加载广告。

SDK 会继续预加载广告,直到达到 getBufferSize 指定的广告数量,并尝试在整个会话期间保持缓冲区满载。

如果已使用 preloadId 启动 PreloadConfiguration,此方法将变为无操作并返回 false

参数
String preloadId

PreloadConfiguration 的字符串标识符。调用 pollAd 以获取此配置的广告时,请使用此标识符。

PreloadConfiguration preloadConfiguration

用于预加载广告的配置。

返回
boolean

如果已开始预加载,则为 true;如果 preloadId 正在使用中,则为 false

start

public static boolean start(
    String preloadId,
    PreloadConfiguration preloadConfiguration,
    PreloadCallbackV2 preloadCallback
)

开始为指定的 preloadIdPreloadConfiguration 和 预加载广告。

SDK 会继续预加载广告,直到达到 getBufferSize 指定的广告数量,并尝试在整个会话期间保持缓冲区满载。

对于每个广告请求,SDK 都会在预加载成功时触发 onAdPreloaded 回调,在预加载失败时触发 onAdFailedToPreload 回调。SDK 会自动重试失败的请求。

如果 PreloadConfiguration 已使用给定的 preloadId 启动,此方法不会执行任何操作并返回 false。会变为无操作并返回 false

参数
String preloadId

用于唯一标识此 PreloadConfiguration 的字符串。调用 pollAd 时,请使用此标识符检索此配置的预加载广告。

PreloadConfiguration preloadConfiguration

用于指定广告预加载方式的配置。

PreloadCallbackV2 preloadCallback

在给定 PreloadConfiguration 的广告可用性发生变化时要调用的回调。

返回
boolean

如果已开始预加载,则为 true;如果 preloadId 正在使用中,则为 false