Skip to main content

Advertising Data Reporting

analytics

1. Interface Description

Function: Advertising Data Reporting

Interface declaration: analytics(object: Object): Promise<void>

Note

This interface is supported since SDK version 1.4.0 and must be used in conjunction with WeChat authorized login.

2. Input Parameters

FieldTypeRequiredDescription
report_typestringRequiredReporting type, currently supports "mall"
report_dataIReportDataRequiredReported content
IReportData
FieldTypeRequiredDescription
action_timenumberNoReporting time; if not filled, defaults to the current client time in seconds.
action_typestringRequiredAction type, e.g., visit_store, share, add_to_cart, etc. For detailed types, refer to the table action_types
click_idstringOptionalThe advertising platform adds click_id to the URL. Value retrieval method: Reference
action_paramIActionParamNoParameters associated with the action
product_paramIProductParamNoProduct structure details
IActionParam
FieldTypeRequiredDescription
valuenumberNoThe value of the conversion action (e.g., amount) carried as a parameter by the action.
leads_typestringNoLead source; currently supports PHONE (direct call), RESERVE (form reservation)
IProductParam
FieldTypeRequiredDescription
product_yun_typestringNoProduct type: goods (commodity), coupon (discount coupon), search_term (search term)
product_yun_idstringNoProduct id
product_yun_categorystringNoCustom product category
product_yun_keywordsstringNoProduct keywords
product_yun_pricenumberNoProduct original price
product_yun_valuenumberNoProduct transaction price
product_yun_namestringNoProduct name
product_yun_id_adstringNoProduct id in the advertising product library
product_yun_category_adstringNoProduct category in the advertising product library
action_types
Type ValueDescription
visit_storeAccess
shareShare
consultConsult
claim_offerCoupon claiming
add_to_cartAdd to Cart
add_to_wishlistAdd to Wishlist
complete_orderPlace Order
purchasePay
searchSearch
deliverDelivery
sign_inConfirm Receipt

3. Output Parameters

None

4. Sample Code

import cloudbase from "@cloudbase/js-sdk";
//Initialize the SDK instance
const app = cloudbase.init({
env: "xxxx-yyy"
});

// WeChat OAuth Login
const provider = auth.weixinAuthProvider({
appid: "...",
scope: "xxxx"
});

provider.getRedirectResult().then((loginState) => {
if (loginState) {
// Login successful!
app.analytics({
report_type: "mall",
report_data: {
action_type: "visit_store",
action_param: {
value: 100
},
product_param: {
product_yun_type: "goods",
product_yun_id: 1,
product_yun_keywords: "UNIQLO",
product_yun_price: 200,
product_yun_value: 100,
product_yun_name: "UNIQLO Utee-Disney"
}
}
});
}
});