appodeal.init()

类型 函数
返回值
修订 发行版 2024.3703
关键字 广告, Appodeal, init
另请参见 appodeal.show()
appodeal.*

概览

appodeal.init() 初始化 Appodeal 插件。

初始化后,你可以使用 appodeal.show() 展示广告。

重要提示

对于 Android 用户,某些适配器使用 android.permission.WRITE_EXTERNAL_STORAGE 权限可能更有效,请务必手动将其包含在项目中。

如果你想在你的项目中使用此功能,请将 disableWriteExternalPermissionCheck 初始化参数值设为 false

重要提示

现在你可以为特定广告类型禁用自动缓存!查看下方新的 disableAutoCacheForAdTypes 初始化参数了解更多信息。

autoCacheAds 参数已弃用,因此请确保所有内容都已正确配置。

语法

appodeal.init( adListener, params )
adListener (必需)

监听器. 将接收 adsRequest 事件的监听器函数。

params (必需)

表格. 包含 Appodeal 初始化值的表格 — 请参阅下一部分了解详细信息。

参数参考

params 表格包括 Appodeal 插件的初始化属性。

appKey (必需)

字符串. 你的 Appodeal 应用密钥。你可以在 Appodeal 开发者门户 中找到此 ID,它位于你的应用名称下方的“应用密钥”。

testMode (可选)

布尔值. 测试模式启用详细日志记录以帮助调试,并且还提供支持测试模式的网络的测试广告。要启用测试模式,请将此值设为 true。默认为 false

smartBanners (可选)

布尔值. 智能横幅将使用所有屏幕宽度来调整横幅宽度。默认情况下,智能横幅已启用。若要禁用它们,请将此值设为 false。

bannerAnimation (可选)

布尔值. 设为 true 以使横幅过渡具有动画效果(在切换横幅时淡入淡出)。默认为 false

childDirectedTreatment (可选)

布尔值. 设为 true 以将你的应用标记为符合 COPPA。默认为 false

customRules (可选)

Table。手动过滤器允许按任何可用特性对用户分组。例如,您知道将用户引导至您的来源并且您想跟踪此类用户的统计信息 - 将他们分组为一个细分。您可以在Appodeal 知识库中了解更多信息。这是一个带有键值数据对的表。您可以自由选择键名,因为没有预先定义键名。有效的值类型是字符串、布尔值或数字。

supportedAdTypes (可选)

Array。限制您希望 Appodeal 提供的广告类型。默认情况下,横幅广告、静态插页广告和奖励视频广告将被提供。您可以通过指定支持哪些类型在这个表数组中来限制要加载的广告类型。有效的值包括 "banner""interstitial""rewardedVideo"

disableWriteExternalPermissionCheck (可选)

Boolean。如果您不想使用可选的 android.permission.WRITE_EXTERNAL_STORAGE 权限(出于上面描述中说明的原因),您必须将该值设置为 true。默认值为 false

disableNetworks (可选)

Array。仅供高级使用。在初始化期间,阻止 Appodeal SDK 查找指定的广告网络 SDK。有效的值包括 "adcolony""admob""amazon_ads""applovin""appnext""avocarrot""chartboost""facebook""flurry""inmobi""inner-active""ironsource""mailru""mmedia""mopub""ogury""openx""pubnative""smaato""startapp""tapjoy""unity_ads""vungle""yandex"。如果您只是希望阻止来自某些广告网络的广告,您应该使用此选项 - 相反,您可以在 Appodeal 仪表板中为您的应用选择优先广告网络。

disableAutoCacheForAdTypes (可选)

Array。仅供高级使用。在 Appodeal SDK 初始化期间禁用指定广告类型的自动缓存。有效的值包括 "banner""interstitial""rewardedVideo"

hasUserConsent (可选)

Boolean。如果设置为 false,Appodeal 会启用 GDPR 数据收集限制,设置为 true 表示相反。默认值为 false。在 beta 版本和 3.2.0+ 中,使用通过传递 truefalse 这种方式来隐藏默认同意表单

示例

local appodeal = require( "plugin.appodeal" )

local function adListener( event )

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

-- Initialize the Appodeal plugin
appodeal.init( adListener, { appKey="YOUR_APP_KEY" } )