vungle.show()

类型 [函数][api.type.function]
返回值 布尔值
修订 版本 2024.3703
关键词 广告, Vungle
另请参阅 vungle.init()
vungle.load()
vungle.*

概述

vungle.show() 开始播放广告位全屏如果已缓存并可供显示，则播放视频广告。

此 API 返回布尔值 true 或 false，具体取决于缓存的视频广告是否可用。

语法

vungle.show( params )
params (必填)

表. 指定广告请求属性的表 — 有关详细信息，请参阅下一节。

参数参考

params 表包含广告请求的属性。

placementID (必填)

字符串. 要显示的广告的广告位 ID。

isAutoRotation (必填)

布尔值. 如果为 true（默认值），视频广告将随设备方向自动旋转。如果为 false，它将使用广告的首选方向。这仅适用于 Android — 对于 iOS，它会查看 orientations 键。

orientation (可选)

数字. 仅适用于 iOS，具有可能方向值的位掩码。默认值为 UIInterfaceOrientationMaskAll。

isSoundEnabled (可选)

布尔值. 如果为 true（默认值），则在视频广告播放期间将启用声音，具体取决于设备的声音设置。如果为 false，视频播放将以静音开始。请注意，用户可以在播放过程中将声音静音或取消静音。

username (可选)

字符串. 此参数仅适用于激励性广告单元类型。指定后，它表示您希望在服务器到服务器回调中接收的用户标识符，该回调会奖励用户完成视频广告观看。

alertTitle, alertText, alertContinue (可选)

字符串. 您可以自定义一条消息，以便在用户尝试在完成前关闭激励性视频时向用户显示。请注意，此设置仅适用于标准 Vungle 广告。“动态模板”广告可在 Vungle 控制面板上进行相同的自定义。

immersive (可选)

字符串. 仅适用于 Android，在 KitKat+ 设备上启用或禁用沉浸式模式。

large (可选)

字符串. 仅适用于 iOS，绘制更大的按钮来控制广告功能，例如静音或关闭。

示例

local vungle = require( "plugin.vungle.v6" )

local appID
if ( system.getInfo("platform") == "android" ) then
    appID = "YOUR_ANDROID_APP_ID"
else
    appID = "YOUR_IOS_APP_ID"
end

-- Vungle listener function
local function adListener( event )

    if ( event.phase == "init" ) then  -- Successful initialization
        print( event.provider )
    end
end

-- Initialize the Vungle plugin
vungle.init( appID, adListener )

local adShown = vungle.show( { placementId="placementID1", isSoundEnabled=true } )