接口文档SDK业务专题开发者工具

电商业务参数说明


参数说明:

  1. 有枚举值的字段已经在备注中注明。
  2. 字符串类型的字段长度不允许超过200。数组参数类型以”_ARR”为后缀,字段元素个数不超过10个。
  3. ★为关键必填字段,没有这个信息,就无法和商品目录关联。
    –为在该维度下不必要的,可忽略的字段。
    √为建议填写字段,完善的字段内容帮助我们做出更好的商品推荐算法以获得更高的广告点击和转化。请尽可能提供。
  4. 参数中相关的ID字段,需要和商品目录中的相应ID字段对应。这样我们才可以做出更多的及准确的商品推荐算法。
当content_type为ecommerce时,不同Actions所对应的参数如下:
Actions 参数名称 参数说明 参数类型 取值范围 Ecommerce Ecommerce Ecommerce Ecommerce
VIEW_
CONTENT
content_type 行业类型 string ^.{0,200}$ ★ ecommerce ★ ecommerce ★ ecommerce ★ ecommerce
object 行为对象 string ^.{0,200}$ ★ product ★ category ★ brand ★ shop
product_id 商品id string ^.{0,200}$ ★ — — —
product_
name
商品名称 string ^.{0,200}$ √ — — —
first_cate
gory_id
商品一级
类目 id
integer √ √ — —
first_cate
gory_name
商品一级
类目名称
string ^.{0,200}$ √ √ — —
second_cate
gory_id
商品二级
类目 id
integer √ √ — —
second_cate
gory_name
商品二级
类目名称
string ^.{0,200}$ √ √ — —
third_cate
gory_id
商品三级
类目 id
integer √ √ — —
third_cate
gory_name
商品三级
类目名称
string ^.{0,200}$ √ √ — —
fourth_cate
gory_id
商品四级
类目 id
integer √ √ — —
fourth_cate
gory_name
商品四级
类目名称
string ^.{0,200}$ √ √ — —
price 商品价格 float √ — — —
original_
price
商品市面
价格
float √ — — —
brand_id 商品的品
牌 id
integer √ — ★ √
brand_name 商品的品
牌名称
string ^.{0,200}$ √ — √ √
shop_id 商品的店
铺 id
integer √ — √ ★
shop_name 商品的店
铺名称
string ^.{0,200}$ √ — √ √
Actions 参数名称 参数说明 参数类型 取值范围 Ecommerce Ecommerce Ecommerce 备注
VIEW_
CONTENT
content_type 行业类型 string ^.{0,200}$ ★ ecommerce ★ ecommerce ★ ecommerce 该行为的 object 为某些特定的活动或专题页面
object 行为对象 string ^.{0,200}$ ★ product_list ★ brand_list ★ shop_list
product_id
s_list
商品id合
集
string[] ^.{0,200}$ ★ — —
brand_ids
_list
品牌id合
集
integer — ★ —
shop_ids
_list
店铺id合
集
integer — — ★
Actions 参数名称 参数说明 参数类型 取值范围 Ecommerce 备注
ADD_TO_CART
INITIATE_CHECKOUT
COMPLETE_ORDER
PURCHASE
content_type 行业类型 string ^.{0,200}$ ★ ecommerce
object 行为对象 string ^.{0,200}$ ★ product
product_id 商品id string ^.{0,200}$ ★ 多个 product,分别上报,每次都需要传 Action。
product_
name
商品名称 string ^.{0,200}$ √
first_cate
gory_id
商品一级
类目id
integer √
first_cate
gory_name
商品一级
类目名称
string ^.{0,200}$ √
second_cate
gory_id
商品二级
类目id
integer √
second_cate
gory_name
商品二级
类目名称
string ^.{0,200}$ √
third_cate
gory_id
商品三级
类目id
integer √
third_cate
gory_name
商品三级
类目名称
string ^.{0,200}$ √
fourth_cate
gory_id
商品四级
类目id
integer √
fourth_cate
gory_name
商品四级
类目名称
string ^.{0,200}$ √
price 商品价格 float √
original_
price
商品市面
价格
float √
brand_id 商品的品
牌id
integer √
brand_name 商品的品
牌名称
string ^.{0,200}$ √
shop_id 商品的店
铺id
integer √
shop_name 商品的店
铺名称
string ^.{0,200}$ √
Actions 参数名称 参数说明 参数类型 取值范围 Ecommerce Ecommerce
ADD_TO_
WISHLIST
content_type 行业类型 string ^.{0,200}$ ★ ecommerce ★ ecommerce
object 行为对象 string ^.{0,200}$ ★ product ★ shop
product_id 商品id string ^.{0,200}$ ★ —
product_name 商品名称 string ^.{0,200}$ √ —
first_cate
gory_id
商品一级
类目 id
integer √ —
first_cate
gory_name
商品一级
类目名称
string ^.{0,200}$ √ —
second_cate
gory_id
商品二级
类目 id
integer √ —
second_cate
gory_name
商品二级
类目名称
string ^.{0,200}$ √ —
third_cate
gory_id
商品三级
类目 id
integer √ —
third_cate
gory_name
商品三级
类目名称
string ^.{0,200}$ √ —
fourth_cate
gory_id
商品四级
类目 id
integer √ —
fourth_cate
gory_name
商品四级
类目名称
string ^.{0,200}$ √ —
price 商品价格 float √ —
original
_price
商品市面
价格
float √ —
brand_id 商品的品
牌 id
integer √ √
brand_name 商品的品
牌名称
string ^.{0,200}$ √ √
shop_id 商品的店
铺 id
integer √ ★
shop_name 商品的店
铺名称
string ^.{0,200}$ √ √
Actions 参数名称 参数说明 参数类型 取值范围 Ecommerce 备注
SEARCH content_type 行业类型 string ^.{0,200}$ ★ ecommerce
object 行为对象 string ^.{0,200}$ ★ search_product_list
query 搜索query string ^.{0,200}$ ★
preferred_
price_range
偏好价格
范围
integer[] √ 价格范围数据按照数组顺序两两配对,
如:假设要有3组价格范围,分别是 [0,50][30,70][100,200] ,则所传数组应为 [0,50,30,70,100,200] 。
preferred
_brand_ids
偏好品牌
id
string[] √
product_ids
_list
商品id合
集
string[] ^.{0,200}$ ★ 搜索只给出 Top 10 结果即可,按搜索顺序给出。