行业资讯 >> 返回 您当前所在位置:首页 > 帮助中心 > 行业资讯 > 正文

国际快手Kwai事件像素部署文档

更新时间:2025-05-03 11:42:00点击次数:1387次
开发者模式是Kwai Pixel的一种实现方法,它为事件配置提供了灵活性,允许广告主在事件之外发送参数,并为其他Kwai产品所需,包括基于网络的高级匹配和动态产品广告(DPA)重定向。

开发者模式是Kwai Pixel的一种实现方法,它为事件配置提供了灵活性,允许广告主在事件之外发送参数,并为其他Kwai产品所需,包括基于网络的高级匹配和动态产品广告(DPA)重定向。通过额外的参数数据,广告主还可以获取额外的指标,如广告支出回报率(ROAS)。在开始前请仔细阅读一下文档:

重要:Pixel 使用说明文档

用开发者模式在事件管理器上创建Pixel

1.在事件管理器上创建Pixel

  • 登录Kwai for Business Manager,点击“资产”下的“Pixel”,然后点击“创建Pixel”

  • 输入Pixel名称,确认“手动安装Pixel代码”和“开发者模式”,然后点击“创建”。

安装Pixel代码

1.概览

一旦您选择了开发者模式,您会看到由3部分组成的页面:Pixel基础代码、Pixel事件代码和Pixel助手。要成功配置Pixel,需要安装Pixel基础代码和事件代码。Pixel助手是一个Chrome扩展程序,可以通过检查错误和为网站提供实现建议来帮助您验证和排除Pixel的安装故障。

点击“确定”将进入Pixel详情页。

2. Pixel基础代码

2.1 Pixel基础代码是什么?

为了启动Pixel并发送网站的事件数据,基础代码应该被插入到网站的源代码中。

基础代码有两个部分。

  • 第一部分是一般函数。

  • 第二部分包含kwaiq.load("input your pixelId"),这有助于根据其配置加载与特定Pixel相关的context。kwaiq.page()将报告一个页面浏览量事件,可用于验证代码安装。


2.2 如何安装Pixel基础代码?

您可以将基础代码粘贴在与之间。

  • 示例如下。请注意:基础代码仅能粘贴在与之间,且不可以将基础代码放置在<iframe>中


    kwai提供的basecode中存在通过fetch来获取数据的方法,若您的网页代码中也存在fetch方法,担心kwai提供的代码影响您网页代码的执行,则使用定制化basecode,来保证您的网页安全,可参考定制化basecode使用教程


    3.Pixel事件代码

    在安装事件代码之前,请确保您已经有了基础代码。如果没有基础代码,单独的事件代码将无法运行。

    kwai不支持自定义事件,因此必须使用kwai提供的事件代码中的事件名称

    3.1 Pixel事件代码是什么?

    Pixel事件代码使您能够报告特定操作或事件,以便监测转化。例如如果您从事电子商务业务,那么监测“添加至购物车”和“下单”等事件对您来说就非常重要。Kwai Pixel现在支持的活动列表如下:

    事件

    描述

    事件代码

    注:这里提到的的pixel id与事件存在一一对应的关系,即您想用pixel id=123456的pixel 追踪的事件为 purchase,则调用函数kwaiq.instance('123456').track('purchase')

    EVENT_ADD_PAYMENT_INFO

    当付款信息被添加到结账流程中。

    kwaiq.instance('input your pixel id').track('addPaymentInfo')

    EVENT_ADD_TO_CART

    当物品被添加至购物车。

    *该事件对应优化目标为“加购”

    kwaiq.instance('input your pixel id').track('addToCart')

    EVENT_BUTTON_CLICK

    当点击按钮。

    kwaiq.instance('input your pixel id').track('buttonClick')

    EVENT_PURCHASE

    当完成付款。

    *该事件对应优化目标为“付费”

    kwaiq.instance('input your pixel id').track('purchase')

    EVENT_CONTENT_VIEW

    当页面被查看。

    *该事件对应优化目标为“查看内容”

    kwaiq.instance('input your pixel id').track('contentView')

    EVENT_DOWNLOAD

    当点击打开外部浏览器下载页面按钮。

    kwaiq.instance('input your pixel id').track('download')

    EVENT_ FORM_SUBMIT

    当表格被提交。

    kwaiq.instance('input your pixel id').track('formSubmit')

    EVENT_INITIATED_CHECKOUT

    当结账流程开始。

    kwaiq.instance('input your pixel id').track('initiatedCheckout')

    EVENT_CONTACT

    当发生联络或咨询。

    kwaiq.instance('input your pixel id').track('contact')

    EVENT_PLACE_ORDER

    当订单下单。

    kwaiq.instance('input your pixel id').track('placeOrder')

    EVENT_SEARCH

    当发生搜索。

    kwaiq.instance('input your pixel id').track('search')

    EVENT_COMPLETE_REGISTRATION

    当注册完成。

    *该事件对应优化目标为“注册”

    kwaiq.instance('input your pixel id').track('completeRegistration')

    EVENT_ADD_TO_WISHLIST

    当物品被添加至心愿列表。

    kwaiq.instance('input your pixel id').track('addToWishlist')

    EVENT_SUBSCRIBE

    当订阅完成。

    kwaiq.instance('input your pixel id').track('subscribe')

    EVENT_FIRST_DEPOSIT

    首次入金

    kwaiq.instance('input your pixel id').track('firstDeposit')

    EVENT_CREDIT_APPROVAL

    授信

    kwaiq.instance('input your pixel id').track('creditApproval')

    EVENT_LOAN_APPLICATION

    贷款申请

    kwaiq.instance('input your pixel id').track('loanApplication')

    EVENT_LOAN_CREDIT

    贷款批准

    kwaiq.instance('input your pixel id').track('loanCredit')

    EVENT_LOAN_DISBURSAL

    贷款放款

    kwaiq.instance('input your pixel id').track('loanDisbursal')

    EVENT_CREDIT_CARD_APPLICATION

    信用卡申请

    kwaiq.instance('input your pixel id').track('creditCardApplication')

    EVENT_KEY_INAPP_EVENT

    关键事件

    kwaiq.instance('input your pixel id').track('keyInappEvent')

    EVENT_KEY_INAPP_EVENT_1

    关键事件1

    kwaiq.instance('input your pixel id').track('keyInappEvent1')

    EVENT_KEY_INAPP_EVENT_2

    关键事件2

    kwaiq.instance('input your pixel id').track('keyInappEvent2')

    EVENT_KEY_INAPP_EVENT_3

    关键事件3

    kwaiq.instance('input your pixel id').track('keyInappEvent3')

    EVENT_AD_VIEW

    (网页内)广告观看

    kwaiq.instance('input your pixel id').track('adView')

    EVENT_AD_CLICK

    (网页内)广告点击

    kwaiq.instance('input your pixel id').track('adClick')

    3.2 如何安装Pixel事件代码?
    • 无论是在网页加载时,还是在访问者完成某项操作(如单击按钮)时,您可以在基础代码中的kwaiq.page()和网页中的结尾<body>tag之间的任何位置调用kwaiq.instance('input your pixel id').track('input event name')函数,注意:不要将事件代码放置在<iframe>中,这里提到的pixel id与event name存在一一对应的关系,即您想用pixel id=123456的pixel 追踪 event name 为 purchase 的事件,则调用函数kwaiq.instance('123456').track('purchase')

    例如,如果您想在访问者完成购买后监测购买事件,您可以在购买确认页调用kwaiq.instance('input your pixel id').track('input event name')函数(前提是购买确认页加载了基础代码):

    <body>
      ...
      <script>
        kwaiq.instance('input your pixel id').track('purchase')
      </script>
      ...
    </body>

    如您想在访问者点击购买按钮时监测加购事件,可以将kwaiq.instance('input your pixel id').track('input event name')函数调用与加购按钮绑定。

    <button id="your addToCart button">addToCart</button>
    <script type="text/javascript">
    document.getElementById("your addToCart button").onclick = function () {
      kwaiq.instance('input your pixel id').track("addToCart", {
        content_id: "301",
        quantity: 1,
        price: 8,
        value: 9.2,
        currency: "USD",
      });
    };
    </script>
    3.3 如何包含事件参数?

    您可以使用kwaiq.instance('input your pixel id').track(event, [parameters]); 来获取参数。示例代码如下:

    //taking purchase event as an example
    // For single product
    kwaiq.instance('input your pixel id').track("purchase", {
      content_id: "301",
      content_type: "product",
      content_name: "dress",
      quantity: 1,
      price: 8,
      value: 9.2,
      currency: "USD",
      mapping_id:"12345678",
    });
    
    // For multiple products
    kwaiq.instance('input your pixel id').track("purchase", {
      contents: [
        {
          content_id: "301",
          content_type: "product",
          content_name: "dress",
          quantity: 1,
          price: 8,
        },
        {
          content_id: "401",
          content_type: "product",
          content_name: "dress",
          quantity: 1,
          price: 1.2,
        },
      ],
      value: 9.2,
      currency: "USD",
      mapping_id:"12345678",
    });

    目前支持的参数清单如下:

    注意:如果您想要回传价值信息,您需要回传value和currency两个必要参数(目前支持的currency值:BRL、IDR、USD)

    参数名

    描述

    必选或可选

    值类型

    content_type

    content_type对象属性值须设为product或product_group,具体取决于设置产品目录时对数据feed进行的配置。如果要监测与单个产品相关的事件,请将值设置为product。如果要监测与产品组相关的事件,请将其设置为product_group。

    可选

    必须是product或product_group。

    contents

    当有多个内容ID时,请使用contents。如果在参数中使用contents,则必须在子对象中包括以下内容:产品ID,以及数量(添加到购物车或购买的物品数量)。

    DPA需要contents或content_id

    必须是对象数组(内容参数、id子对象和数量子对象)。

    content_id*

    产品或内容的标识符

    DPA需要contents或content_id

    字符串

    content_category

    页面/产品的类别

    可选

    字符串

    content_name

    页面/产品的名称

    可选

    字符串

    currency

    指在社会和经济活动中作为流通手段使用的货币,例如美元

    根据https://en.wikipedia.org/wiki/ISO_4217,该值应为大写英文字母表示,例如“USD”、“BRL”、“IDN”

    可选,针对电商客户则建议包括

    枚举(字符串)

    value

    订单总价,例如10.13

    可选,针对电商客户则建议包括

    数字

    quantity*

    用户添加到购物车或购买的产品数量

    可选

    数字

    price*

    商品价格,单位为元,例如4.99

    可选

    数字

    query

    与搜索事件一起使用。用户输入的搜索字符串。

    可选

    字符串

    mapping_id

    用于帮助全渠道数据优化模型标识用户

    可选,请联系您的CST协助开启

    字符串


    3.4如何确保事件正常上报(非常重要)

    kwai使用click_id与pixel_id完成事件的上报。当用户点击广告进入您的网页时(这个网页是您在kwai for business ads manager 的ad set 模块填写的网址),系统会生成一个唯一的click_id,并自动将其添加到这个网页的链接的末尾(注意:同一用户对同一广告不同次点击会生成不同的click_id,因此click_id是动态变化的),举个例子:

    1)如图所示,您在kwai for business ads manager 的ad set 模块中填写的网址为:

    https://www.kwai.com/business

    2)当用户点击了您的广告后,会进入您在ad set 模块填写的网址,与此同时,系统自动将pixel_id与click_id拼接到网页链接的末尾,此时,链接自动变为:

    https://www.kwai.com/business?CampaignID=987654321&adSETID=123456789&CreativeID=123456789&click_id=CCpgibAfpRkSWv9zxgDuFHX71q5u%5FvMxqmvRClE6enEynSNeQAaSvb3CCcXoqXaPwbYpThJBW5n6%2D62kmmECfY5He3KFgOJB9YErIJ9cIUk%3D&pixel_id=12345678987654321

    3)您需要从上述链接中捕捉click_id与pixel_id这两个参数的值(即,click_id=CCpgibAfpRkSWv9zxgDuFHX71q5u%5FvMxqmvRClE6enEynSNeQAaSvb3CCcXoqXaPwbYpThJBW5n6%2D62kmmECfY5He3KFgOJB9YErIJ9cIUk%3D&pixel_id=12345678987654321),并且在后续跳转到的每一个页面的链接末尾拼接“click_id=CCpgibAfpRkSWv9zxgDuFHX71q5u%5FvMxqmvRClE6enEynSNeQAaSvb3CCcXoqXaPwbYpThJBW5n6%2D62kmmECfY5He3KFgOJB9YErIJ9cIUk%3D&pixel_id=12345678987654321”这两个参数

    您可以通过在https://www.kwai.com/business中添加以下代码可以实现该需求(请自行评估该方案的可行性)

    <script>
      window.onload = function () {
        var links = document.getElementsByTagName("a");
        for (var i = 0, n = links.length; i < n; i++) {
          var href =
            links[i].href.trim() +
            (links[i].href.indexOf("?") > 0 ? "&" : "?") +
            document.location.search.replace("?", "").toString();
          links[i].href = href;
        }
      };
    </script>

    请注意:

    1)对于广告点击后用户会话内发生的页面跳转,请确保click_id与pixel_id从原始落地页传递到后续跳转到的页面。将用户定向到后续页面时,您需要将click_id与pixel_id附在后续页面的末尾。

    2)在正式投放时,需要拼接的参数是click_id与pixel_id,在测试事件时需要拼接的参数是click_id、pixel_id与ks_px_test(预览时ks_px_test=1)


    4.用户选择不参加

    对于选择不被监测的用户,广告主与合作伙伴不应执行“kwaiq.track”来处理Pixel事件。不执行api操作,Pixel就不会报告事件。

    确保Pixel正常工作

    完成设置后,有两种方法可以检查Pixel是否正常运行:1、Pixel助手;2、预览广告。这两个都是必须的。

    1.Pixel助手
    • 安装Kwai Pixel助手。

    • 使用 Kwai Pixel Helper来检测pixel安装是否正确。详情请见:Kwai像素自检器


    2.预览事件

    通过预览事件,您可以模拟顾客的整个经历:从点击广告到Pixel记录转化。预览广告发生的转化将被记录在“预览事件”中,“预览事件”位于“事件管理器”的Pixel详情页,不会影响您的广告效果。

    FAQ | 常见问题


    1、我准备创建一个广告,并为我的转化目标选择一个事件,但我在“转化目标”栏下没有看到该事件。

    因为选择转化目标存在门槛,支持的优化目标事件与门槛如下,详情可见:OCPM-Target cost 出价产品手册

    转化目标

    投放门槛

    加购

    当account维度下此转化目标pixel预览成功后可选择此转化目标

    查看内容

    当account维度下此转化目标pixel预览成功后可选择此转化目标

    注册

    当account维度下此转化目标pixel预览成功且此转化目标累计10个转化行为后可选择此转化目标

    付费

    当account维度下此转化目标累计1个转化行为后可选择此转化目标


地 址:重庆市渝中区解放碑民生路232号
邮 编:400010
电 话:023-67898642
邮 箱:ceo@taolong.com
@YunGouCMS888
QQ客服
微信客服
微信公众号