Munchkin API参考

最近更新： 2024年11月23日

创建对象：

  • 管理员

Munchkin提供了几种可通过Javascript手动调用的函数。 这些功能允许对浏览器事件进行自定义跟踪，例如视频播放或非链接上的点击次数。

功能

Munchkin API包含以下函数： init、createTrackingCookie、munchkinFunction。

Munchkin.init()

必须在任何其他函数之前调用Munchkin.init()。 它在当前页面上设置Munchkin以将活动发送到特定实例，并为当前页面生成“访问网页”活动。

参数名称可选/必填类型描述
Munchkin ID必需字符串可在管理员>集成> Munchkin菜单下找到Munchkin帐户ID。 设置要将活动发送到的目标实例。
配置设置可选对象为Munchkin启用替代行为设置。
Munchkin.init('299-BYM-827');

Munchkin.createTrackingCookie()

调用时，将检查浏览器中是否存在_mkto_trk Cookie，如果不存在，将创建一个。 如果cookieAnon设置为false，则这对于在特定操作期间跟踪用户很有用，例如注册或下载资源。

参数名称可选/必填类型描述
forceCreate必需布尔值即使cookieAnon设置为false，也创建Cookie。
Munchkin.createTrackingCookie(true);

Munchkin.munchkinFunction()

用于生成自定义跟踪行为，如视频播放器播放和暂停，或生成非标准导航的页面访问次数，如哈希代码。

参数名称可选/必填类型描述
函数类型必需字符串确定要记录的活动。 允许的值： visitWebPage、clickLink、associateLead
数据必需对象包含要记录的活动的数据。

visitWebPage

使用visitWebPage调用munchkinFunction()会将当前用户的“访问”活动发送到Marketo。 您可以自定义与第二个参数中的数据对象一起发送的URL和querystring。

数据属性名称可选/必填类型描述
url必需字符串用于记录页面访问的URL文件路径。 此值附加到当前域名以创建完整页面名称。 例如，如果url为/index.html，域名为www.example.com，则访问的页面将记录为www.example.com/index.html。
参数可选字符串要记录的所需参数的查询字符串。

例如：foo=bar&biz=baz。

Munchkin.munchkinFunction('visitWebPage', {
        'url': '/Football/Team/Seahawks',
        'params': 'defense=legion_of_boom&qb=wilson'
    }
);

使用clickLink调用munchkinFunction()会将当前用户的点击活动发送至Marketo。 您可以使用数据对象中的href属性自定义点击URL。

数据属性名称可选/必填类型描述
href必需字符串用于记录链接点击的URL文件路径。 此值附加到当前域名以创建完整链接。

例如，如果href为/index.html且域名为www.example.com，则链接点击将被记录为www.example.com/index.html。

Munchkin.munchkinFunction('clickLink', {
        'href': '/Football/Team/Seahawks'
    }
);