AppOpenAdPreloader

Kotlin |Java

public final class AppOpenAdPreloader

應用程式開啟頁面廣告的預先載入器。

摘要

公用方法
`static boolean`	`destroy(String preloadId)` 停止指定 `preloadId` 的預先載入作業，並終止所有相關聯的預先載入廣告。
`static void`	`destroyAll()` 停止預先載入，並針對所有預先載入設定，毀損預先載入的廣告。
`static @Nullable PreloadConfiguration`	`getConfiguration(String preloadId)` 傳回與這個 `preloadId` 相關聯的應用程式開啟頁面廣告 `PreloadConfiguration`，如果不存在則傳回 null。
`static Map<String, PreloadConfiguration>`	`getConfigurations()` 傳回所有應用程式開啟廣告的對應，並以相關聯的預先載入 ID 做為鍵。`PreloadConfiguration`
`static int`	`getNumAdsAvailable(String preloadId)` 傳回指定預先載入 ID 的可用廣告數量。
`static boolean`	`isAdAvailable(String preloadId)` 判斷指定 `preloadId` 是否至少有一則廣告可用。
`static @Nullable AppOpenAd`	`pollAd(String preloadId)` 傳回從 `start` 或 `start` 預先載入的廣告，並從快取中移除。
`static boolean`	`start(String preloadId, PreloadConfiguration preloadConfiguration)` 開始預先載入指定 `preloadId` 和 `PreloadConfiguration` 的廣告。
`static boolean`	`start( String preloadId, PreloadConfiguration preloadConfiguration, PreloadCallbackV2 preloadCallback )` 開始預先載入指定 `preloadId`、`PreloadConfiguration` 和 `PreloadCallbackV2` 的廣告。

public static boolean destroy(String preloadId)

停止指定 preloadId 的預先載入作業，並終止所有相關聯的預先載入廣告。

參數
`String preloadId`	要終止的設定預先載入 ID。

傳回
`boolean`	`true`，前提是已毀損的預先載入設定處於啟用狀態。如果指定 `preloadId` 沒有有效的預先載入設定，則傳回 `false`。

public static void destroyAll()

停止預先載入，並針對所有預先載入設定，毀損預先載入的廣告。

public static @Nullable PreloadConfiguration getConfiguration(String preloadId)

傳回與這個 preloadId 相關聯的應用程式開啟頁面廣告 PreloadConfiguration，如果不存在則傳回 null。

參數
`String preloadId`	與此設定連結的預先載入 ID。

傳回
`@Nullable PreloadConfiguration`	指定預先載入 ID 的 `PreloadConfiguration`，或指定預先載入 ID 沒有設定時的 `null`。

public static Map<String, PreloadConfiguration> getConfigurations()

傳回所有應用程式開啟廣告的對應，並以相關聯的預先載入 ID 做為鍵。PreloadConfiguration

傳回
`Map<String, PreloadConfiguration>`	應用程式開啟頁面廣告設定，或是不存在預先載入器時的空白對應。

public static int getNumAdsAvailable(String preloadId)

傳回指定預先載入 ID 的可用廣告數量。

參數
`String preloadId`	要檢查是否可用的預先載入 ID。

傳回
`int`	指定預先載入 ID 可用的廣告數量。

public static boolean isAdAvailable(String preloadId)

判斷指定 preloadId 是否至少有一則廣告可用。

參數
`String preloadId`	要檢查是否可用的預先載入 ID。

傳回
`boolean`	如果指定預先載入 ID 有可用的廣告，則傳回 `true`，否則傳回 `false`。

public static @Nullable AppOpenAd pollAd(String preloadId)

傳回從 start 或 start 預先載入的廣告，並從快取中移除。

請注意，這可能是為 preloadId 預先載入的任何廣告。傳回的順序不一定會與 onAdPreloaded 事件的順序相符。

參數
`String preloadId`	廣告的預先載入 ID。

傳回
`@Nullable AppOpenAd`	指定預先載入 ID 的應用程式開啟頁面廣告，如果沒有可用廣告，則為 `null`。

public static boolean start(String preloadId, PreloadConfiguration preloadConfiguration)

開始預先載入指定 preloadId 和 PreloadConfiguration 的廣告。

SDK 會持續預先載入廣告，直到達到 getBufferSize 指定的廣告數量為止，並嘗試在整個工作階段中保持緩衝區滿載。

如果已使用 preloadId 啟動 PreloadConfiguration，這個方法會變成無運算，並傳回 false。

參數
`String preloadId`	這個 `PreloadConfiguration` 的字串 ID。呼叫 pollAd 時，請使用這個 ID 取得這項設定的廣告。
`PreloadConfiguration preloadConfiguration`	預先載入廣告的設定。

傳回
`boolean`	如果預先載入已啟動，則為 `true`；如果 preloadId 正在使用中，則為 `false`。

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

開始預先載入指定 preloadId、PreloadConfiguration 和 PreloadCallbackV2 的廣告。

SDK 會持續預先載入廣告，直到達到 getBufferSize 指定的廣告數量為止，並嘗試在整個工作階段中保持緩衝區滿載。

每收到一個廣告請求，SDK 就會在預先載入成功時觸發 onAdPreloaded 回呼，預先載入失敗時則觸發 onAdFailedToPreload 回呼。SDK 會自動重試失敗的要求。

如果已使用指定 preloadId 啟動 PreloadConfiguration，這個方法不會執行任何動作，並會傳回 false。會變成無運算，並傳回 false。

參數
`String preloadId`	唯一識別此 `PreloadConfiguration` 的字串。呼叫 `pollAd` 時，請使用這個 ID 擷取此設定的預先載入廣告。
`PreloadConfiguration preloadConfiguration`	決定廣告預先載入方式的設定。
`PreloadCallbackV2 preloadCallback`	指定 `PreloadConfiguration` 的廣告可用性變更時，要叫用的回呼。

傳回
`boolean`	如果預先載入已啟動，則為 `true`；如果 preloadId 正在使用中，則為 `false`。