adcolony.init()

类型 函数
返回值 无
修订 2024.3703 版
关键字 广告、广告宣传、AdColony、init
此外请参阅 adcolony.load()
adcolony.show()

概览

adcolony.init() 来初始化 AdColony 插件。此调用为必需，且必须在实施其他 AdColony 调用（例如 adcolony.load() 和 adcolony.show()）之前执行。

语法

adcolony.init( listener, params )
listener (必需)

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

params (必需)

Table. 包含 AdColony 初始化值的表 — 有关详细信息，请参阅下一部分。

参数参考

params 表包括 AdColony 初始化的参数。

注意

对于从 AdColony 插件的 Corona 广告体现迁移的开发者，此新插件已移除以下参数

  • apiKey（替换为 appId）
  • testMode；这现在在 AdColony 仪表盘中按应用设置
appId (必需)

String. 从 AdColony 仪表盘 中收集的应用的 AdColony 应用 ID。

adZones (必需)

Table. 包含区域的键值对表，如 AdColony 仪表盘 中定义的那样。键是用户定义，但建议使用有意义的名称，如 interstitial 和 rewardedVideo，因为这些名称是您在该插件内的其他函数的调用中将使用的名称。每个键值对的值是一个字符串，其中区域 ID 取自 AdColony 仪表盘中配置的区域。您可以配置任意数量的区域，但必须至少指定一个。

adOrientation (可选)

String. 您希望显示广告的首选方向。有效值是 "portrait" 和 "landscape"。默认为 "landscape"。

userId (可选)

String. 要赋予当前用户的唯一用户 ID。

debugLogging (可选)

Boolean. 如果为 true，则打开调试日志记录，该日志记录将在设备日志中显示额外的调试信息。默认为 false。

privacyFrameworks (必需)

Table. 包含已使用的隐私法规（用作键）和布尔值（值为 true 时使用）键值对的表。仅设置针对当前用户有效的选项。选项如下

privacyFrameworks = { gdpr=true, coppa=true, ccpa=true },
privacyConsents (必需)

Table. 包含适用于隐私框架的同意值的键值对表。仅设置针对当前用户有效的选项。

privacyConsents = { gdpr=true, coppa=true, ccpa=true },

已弃用

##### hasUserConsent (可选) Boolean. 如果设置为 false，AdColony 将启用 GDPR 数据收集限制，设置为 true 则代表启用相反的限制。

示例

local adcolony = require( "plugin.adcolony" )

-- AdColony listener function
local function adListener( event )

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

-- Initialize the AdColony plugin
adcolony.init( adListener,
    {
        appId = "YOUR_ADCOLONY_APP_ID",
        adZones = {
            interstitial = "YOUR_ADCOLONY_ZONE_ID_1",
            rewardedVideo = "YOUR_ADCOLONY_ZONE_ID_2"
        }
    })