add_payment_info
此事件表示用户已提交其付款信息。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
currency |
string |
是* | USD |
与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略商品级 currency 。
如果未设置此参数,系统会使用 items 中第一件商品所用的币种。*如果设置 value ,则必须提供 currency ,这样才能准确计算收入指标。
|
value |
number |
是* | 7.77 | 与事件相关的货币价值。 *如需生成有意义的报告,通常必须提供 value 。
如果您将事件标记为转化,则建议您设置 value 。
*如果设置 value ,则必须提供 currency 。
|
coupon |
string |
否 | SUMMER_FUN | 与事件相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
payment_type |
string |
否 | 信用卡 | 选定的付款方式。 |
items |
Array<Item> |
是 | 与事件相关的商品。 |
Item 参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_id |
string |
是* | SKU_12345 |
商品的 ID。
*必须提供 |
item_name |
string |
是* | Stan 和 Friends Tee |
商品的名称。
*必须提供 |
affiliation |
string |
否 | Google 商店 |
用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
currency |
string |
否 | USD |
币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略事件级 currency 。不支持为每个事件设置多种币种。应为每件商品设置同一币种。 |
creative_name |
string |
否 | summer_banner2 | 促销广告素材的名称。 如果设置此参数,系统会忽略事件级 creative_name 。
如果未设置此参数,系统会使用事件级 creative_name (如果存在)。 |
creative_slot |
string |
否 | featured_app_1 | 与商品相关的促销广告素材投放到的广告位的名称。 如果设置此参数,系统会忽略事件级 creative_slot 。
如果未设置此参数,系统会使用事件级 creative_slot (如果存在)。 |
discount |
number |
否 | 2.22 | 与商品相关的折扣货币价值。 |
index |
number |
否 | 5 | 列表中商品的索引/商品在列表中的位置。 |
item_brand |
string |
否 | 商品所属品牌。 | |
item_category |
string |
否 | 服饰 | 商品所属类别。如果将其用作类别层次结构或类目的一部分,则为第一个类别。 |
item_category2 |
string |
否 | 成人 | 商品的第二类层次结构或其他类目。 |
item_category3 |
string |
否 | 衬衫 | 商品的第三类层次结构或其他类目。 |
item_category4 |
string |
否 | 圆领 | 商品的第四类层次结构或其他类目。 |
item_category5 |
string |
否 | 短袖 | 商品的第五类层次结构或其他类目。 |
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果设置此参数,系统会忽略事件级 item_list_id 。
如果未设置此参数,系统会使用事件级 item_list_id (如果存在)。
|
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果设置此参数,系统会忽略事件级 item_list_name 。
如果未设置此参数,系统会使用事件级 item_list_name (如果存在)。
|
item_variant |
string |
否 | 绿色 | 用于提供其他商品详情/选项的商品款式/规格、唯一代码或说明。 |
location_id |
string |
否 | L_12345 |
与商品相关的地理位置。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。 如果设置此参数,系统会忽略事件级 location_id 。
如果未设置此参数,系统会使用事件级 location_id (如果存在)。 |
price |
number |
否 | 9.99 | 商品的货币价格(以指定的 currency 参数为单位)。 |
promotion_id |
string |
否 | P_12345 |
与商品相关的促销活动的 ID。 如果设置此参数,系统会忽略事件级 promotion_id 。
如果未设置此参数,系统会使用事件级 promotion_id (如果存在)。
|
promotion_name |
string |
否 | 夏季促销 |
与商品相关的促销活动的名称。 如果设置此参数,系统会忽略事件级 promotion_name 。
如果未设置此参数,系统会使用事件级 promotion_name (如果存在)。
|
quantity |
number |
否 | 1 |
商品数量。 |
add_to_cart
此事件表示商品已添加到购物车,可供购买。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
currency |
string |
是* | USD |
与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略商品级 currency 。
如果未设置此参数,系统会使用 items 中第一件商品所用的币种。*如果设置 value ,则必须提供 currency ,这样才能准确计算收入指标。
|
value |
number |
是* | 7.77 | 与事件相关的货币价值。 *如需生成有意义的报告,通常必须提供 value 。
如果您将事件标记为转化,则建议您设置 value 。
*如果设置 value ,则必须提供 currency 。
|
items |
Array<Item> |
是 | 与事件相关的商品。 |
Item 参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_id |
string |
是* | SKU_12345 |
商品的 ID。
*必须提供 |
item_name |
string |
是* | Stan 和 Friends Tee |
商品的名称。
*必须提供 |
affiliation |
string |
否 | Google 商店 |
用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
currency |
string |
否 | USD |
币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略事件级 currency 。不支持为每个事件设置多种币种。应为每件商品设置同一币种。 |
creative_name |
string |
否 | summer_banner2 | 促销广告素材的名称。 如果设置此参数,系统会忽略事件级 creative_name 。
如果未设置此参数,系统会使用事件级 creative_name (如果存在)。 |
creative_slot |
string |
否 | featured_app_1 | 与商品相关的促销广告素材投放到的广告位的名称。 如果设置此参数,系统会忽略事件级 creative_slot 。
如果未设置此参数,系统会使用事件级 creative_slot (如果存在)。 |
discount |
number |
否 | 2.22 | 与商品相关的折扣货币价值。 |
index |
number |
否 | 5 | 列表中商品的索引/商品在列表中的位置。 |
item_brand |
string |
否 | 商品所属品牌。 | |
item_category |
string |
否 | 服饰 | 商品所属类别。如果将其用作类别层次结构或类目的一部分,则为第一个类别。 |
item_category2 |
string |
否 | 成人 | 商品的第二类层次结构或其他类目。 |
item_category3 |
string |
否 | 衬衫 | 商品的第三类层次结构或其他类目。 |
item_category4 |
string |
否 | 圆领 | 商品的第四类层次结构或其他类目。 |
item_category5 |
string |
否 | 短袖 | 商品的第五类层次结构或其他类目。 |
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果设置此参数,系统会忽略事件级 item_list_id 。
如果未设置此参数,系统会使用事件级 item_list_id (如果存在)。
|
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果设置此参数,系统会忽略事件级 item_list_name 。
如果未设置此参数,系统会使用事件级 item_list_name (如果存在)。
|
item_variant |
string |
否 | 绿色 | 用于提供其他商品详情/选项的商品款式/规格、唯一代码或说明。 |
location_id |
string |
否 | L_12345 |
与商品相关的地理位置。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。 如果设置此参数,系统会忽略事件级 location_id 。
如果未设置此参数,系统会使用事件级 location_id (如果存在)。 |
price |
number |
否 | 9.99 | 商品的货币价格(以指定的 currency 参数为单位)。 |
promotion_id |
string |
否 | P_12345 |
与商品相关的促销活动的 ID。 如果设置此参数,系统会忽略事件级 promotion_id 。
如果未设置此参数,系统会使用事件级 promotion_id (如果存在)。
|
promotion_name |
string |
否 | 夏季促销 |
与商品相关的促销活动的名称。 如果设置此参数,系统会忽略事件级 promotion_name 。
如果未设置此参数,系统会使用事件级 promotion_name (如果存在)。
|
quantity |
number |
否 | 1 |
商品数量。 |
add_to_wishlist
此事件表示商品已添加到心愿单。使用此事件可找出您应用中的热门礼品。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
currency |
string |
是* | USD |
与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略商品级 currency 。
如果未设置此参数,系统会使用 items 中第一件商品所用的币种。*如果设置 value ,则必须提供 currency ,这样才能准确计算收入指标。
|
value |
number |
是* | 7.77 | 与事件相关的货币价值。 *如需生成有意义的报告,通常必须提供 value 。
如果您将事件标记为转化,则建议您设置 value 。
*如果设置 value ,则必须提供 currency 。
|
items |
Array<Item> |
是 | 与事件相关的商品。 |
Item 参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_id |
string |
是* | SKU_12345 |
商品的 ID。
*必须提供 |
item_name |
string |
是* | Stan 和 Friends Tee |
商品的名称。
*必须提供 |
affiliation |
string |
否 | Google 商店 |
用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
currency |
string |
否 | USD |
币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略事件级 currency 。不支持为每个事件设置多种币种。应为每件商品设置同一币种。 |
creative_name |
string |
否 | summer_banner2 | 促销广告素材的名称。 如果设置此参数,系统会忽略事件级 creative_name 。
如果未设置此参数,系统会使用事件级 creative_name (如果存在)。 |
creative_slot |
string |
否 | featured_app_1 | 与商品相关的促销广告素材投放到的广告位的名称。 如果设置此参数,系统会忽略事件级 creative_slot 。
如果未设置此参数,系统会使用事件级 creative_slot (如果存在)。 |
discount |
number |
否 | 2.22 | 与商品相关的折扣货币价值。 |
index |
number |
否 | 5 | 列表中商品的索引/商品在列表中的位置。 |
item_brand |
string |
否 | 商品所属品牌。 | |
item_category |
string |
否 | 服饰 | 商品所属类别。如果将其用作类别层次结构或类目的一部分,则为第一个类别。 |
item_category2 |
string |
否 | 成人 | 商品的第二类层次结构或其他类目。 |
item_category3 |
string |
否 | 衬衫 | 商品的第三类层次结构或其他类目。 |
item_category4 |
string |
否 | 圆领 | 商品的第四类层次结构或其他类目。 |
item_category5 |
string |
否 | 短袖 | 商品的第五类层次结构或其他类目。 |
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果设置此参数,系统会忽略事件级 item_list_id 。
如果未设置此参数,系统会使用事件级 item_list_id (如果存在)。
|
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果设置此参数,系统会忽略事件级 item_list_name 。
如果未设置此参数,系统会使用事件级 item_list_name (如果存在)。
|
item_variant |
string |
否 | 绿色 | 用于提供其他商品详情/选项的商品款式/规格、唯一代码或说明。 |
location_id |
string |
否 | L_12345 |
与商品相关的地理位置。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。 如果设置此参数,系统会忽略事件级 location_id 。
如果未设置此参数,系统会使用事件级 location_id (如果存在)。 |
price |
number |
否 | 9.99 | 商品的货币价格(以指定的 currency 参数为单位)。 |
promotion_id |
string |
否 | P_12345 |
与商品相关的促销活动的 ID。 如果设置此参数,系统会忽略事件级 promotion_id 。
如果未设置此参数,系统会使用事件级 promotion_id (如果存在)。
|
promotion_name |
string |
否 | 夏季促销 |
与商品相关的促销活动的名称。 如果设置此参数,系统会忽略事件级 promotion_name 。
如果未设置此参数,系统会使用事件级 promotion_name (如果存在)。
|
quantity |
number |
否 | 1 |
商品数量。 |
begin_checkout
此事件表示用户已开始结帐流程。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
currency |
string |
是* | USD |
与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略商品级 currency 。
如果未设置此参数,系统会使用 items 中第一件商品所用的币种。*如果设置 value ,则必须提供 currency ,这样才能准确计算收入指标。
|
value |
number |
是* | 7.77 | 与事件相关的货币价值。 *如需生成有意义的报告,通常必须提供 value 。
如果您将事件标记为转化,则建议您设置 value 。
*如果设置 value ,则必须提供 currency 。
|
coupon |
string |
否 | SUMMER_FUN | 与事件相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
items |
Array<Item> |
是 | 与事件相关的商品。 |
Item 参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_id |
string |
是* | SKU_12345 |
商品的 ID。
*必须提供 |
item_name |
string |
是* | Stan 和 Friends Tee |
商品的名称。
*必须提供 |
affiliation |
string |
否 | Google 商店 |
用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
currency |
string |
否 | USD |
币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略事件级 currency 。不支持为每个事件设置多种币种。应为每件商品设置同一币种。 |
creative_name |
string |
否 | summer_banner2 | 促销广告素材的名称。 如果设置此参数,系统会忽略事件级 creative_name 。
如果未设置此参数,系统会使用事件级 creative_name (如果存在)。 |
creative_slot |
string |
否 | featured_app_1 | 与商品相关的促销广告素材投放到的广告位的名称。 如果设置此参数,系统会忽略事件级 creative_slot 。
如果未设置此参数,系统会使用事件级 creative_slot (如果存在)。 |
discount |
number |
否 | 2.22 | 与商品相关的折扣货币价值。 |
index |
number |
否 | 5 | 列表中商品的索引/商品在列表中的位置。 |
item_brand |
string |
否 | 商品所属品牌。 | |
item_category |
string |
否 | 服饰 | 商品所属类别。如果将其用作类别层次结构或类目的一部分,则为第一个类别。 |
item_category2 |
string |
否 | 成人 | 商品的第二类层次结构或其他类目。 |
item_category3 |
string |
否 | 衬衫 | 商品的第三类层次结构或其他类目。 |
item_category4 |
string |
否 | 圆领 | 商品的第四类层次结构或其他类目。 |
item_category5 |
string |
否 | 短袖 | 商品的第五类层次结构或其他类目。 |
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果设置此参数,系统会忽略事件级 item_list_id 。
如果未设置此参数,系统会使用事件级 item_list_id (如果存在)。
|
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果设置此参数,系统会忽略事件级 item_list_name 。
如果未设置此参数,系统会使用事件级 item_list_name (如果存在)。
|
item_variant |
string |
否 | 绿色 | 用于提供其他商品详情/选项的商品款式/规格、唯一代码或说明。 |
location_id |
string |
否 | L_12345 |
与商品相关的地理位置。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。 如果设置此参数,系统会忽略事件级 location_id 。
如果未设置此参数,系统会使用事件级 location_id (如果存在)。 |
price |
number |
否 | 9.99 | 商品的货币价格(以指定的 currency 参数为单位)。 |
promotion_id |
string |
否 | P_12345 |
与商品相关的促销活动的 ID。 如果设置此参数,系统会忽略事件级 promotion_id 。
如果未设置此参数,系统会使用事件级 promotion_id (如果存在)。
|
promotion_name |
string |
否 | 夏季促销 |
与商品相关的促销活动的名称。 如果设置此参数,系统会忽略事件级 promotion_name 。
如果未设置此参数,系统会使用事件级 promotion_name (如果存在)。
|
quantity |
number |
否 | 1 |
商品数量。 |
exception
当应用的正常执行流程中断时,系统会记录 exception 事件。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
description |
string |
否 | 未填写必填字段。 | 对所发生异常的说明。 |
fatal |
boolean |
否 | true |
异常是否严重。 |
generate_lead
在带来潜在客户时记录此事件,以便了解再互动广告系列的效果。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
currency |
string |
是* | USD |
与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略商品级 currency 。
如果未设置此参数,系统会使用 items 中第一件商品所用的币种。*如果设置 value ,则必须提供 currency ,这样才能准确计算收入指标。
|
value |
number |
是* | 7.77 | 与事件相关的货币价值。 *如需生成有意义的报告,通常必须提供 value 。
如果您将事件标记为转化,则建议您设置 value 。
*如果设置 value ,则必须提供 currency 。
|
join_group
在用户加入群组(例如公会、团队或家庭)时记录此事件。使用此事件可分析特定群组或社交功能的受欢迎程度。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
group_id |
string |
否 | G_12345 | 群组的 ID。 |
login
发送此事件即表示用户已登录。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
method |
string |
否 | 登录时所用的方法。 |
page_view
此事件表明用户查看了网页。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
page_location |
string |
否 | https://example.com | 网页的网址。 |
client_id |
string |
否 | ABC_123 | 客户端 ID。 |
language |
string |
否 | en_us | 客户端使用的语言。请参阅语言标记和代码。 |
page_encoding |
string |
否 | UTF-8 | 网页的编码。 |
page_title |
string |
否 | 首页 | 网页的标题。 |
user_agent |
string |
否 | 客户端的用户代理。 |
purchase
此事件表示用户已购买一件或多件商品。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
currency |
string |
是* | USD |
与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略商品级 currency 。
如果未设置此参数,系统会使用 items 中第一件商品所用的币种。*如果设置 value ,则必须提供 currency ,这样才能准确计算收入指标。
|
transaction_id |
string |
是 | T_12345 | 交易的唯一标识符。 |
value |
number |
是* | 12.21 | 与事件相关的货币价值。 *如需生成有意义的报告和填充“购买者”预测性受众群体,则必须提供 value 。
*如果设置 value ,则必须提供 currency 。
|
affiliation |
string |
否 | Google 商店 | 用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与事件相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
shipping |
number |
否 | 3.33 | 与交易相关的运费。 |
tax |
number |
否 | 1.11 | 与交易相关的税费。 |
items |
Array<Item> |
是 | 与事件相关的商品。 |
Item 参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_id |
string |
是* | SKU_12345 |
商品的 ID。
*必须提供 |
item_name |
string |
是* | Stan 和 Friends Tee |
商品的名称。
*必须提供 |
affiliation |
string |
否 | Google 商店 |
用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
currency |
string |
否 | USD |
币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略事件级 currency 。不支持为每个事件设置多种币种。应为每件商品设置同一币种。 |
creative_name |
string |
否 | summer_banner2 | 促销广告素材的名称。 如果设置此参数,系统会忽略事件级 creative_name 。
如果未设置此参数,系统会使用事件级 creative_name (如果存在)。 |
creative_slot |
string |
否 | featured_app_1 | 与商品相关的促销广告素材投放到的广告位的名称。 如果设置此参数,系统会忽略事件级 creative_slot 。
如果未设置此参数,系统会使用事件级 creative_slot (如果存在)。 |
discount |
number |
否 | 2.22 | 与商品相关的折扣货币价值。 |
index |
number |
否 | 5 | 列表中商品的索引/商品在列表中的位置。 |
item_brand |
string |
否 | 商品所属品牌。 | |
item_category |
string |
否 | 服饰 | 商品所属类别。如果将其用作类别层次结构或类目的一部分,则为第一个类别。 |
item_category2 |
string |
否 | 成人 | 商品的第二类层次结构或其他类目。 |
item_category3 |
string |
否 | 衬衫 | 商品的第三类层次结构或其他类目。 |
item_category4 |
string |
否 | 圆领 | 商品的第四类层次结构或其他类目。 |
item_category5 |
string |
否 | 短袖 | 商品的第五类层次结构或其他类目。 |
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果设置此参数,系统会忽略事件级 item_list_id 。
如果未设置此参数,系统会使用事件级 item_list_id (如果存在)。
|
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果设置此参数,系统会忽略事件级 item_list_name 。
如果未设置此参数,系统会使用事件级 item_list_name (如果存在)。
|
item_variant |
string |
否 | 绿色 | 用于提供其他商品详情/选项的商品款式/规格、唯一代码或说明。 |
location_id |
string |
否 | L_12345 |
与商品相关的地理位置。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。 如果设置此参数,系统会忽略事件级 location_id 。
如果未设置此参数,系统会使用事件级 location_id (如果存在)。 |
price |
number |
否 | 9.99 | 商品的货币价格(以指定的 currency 参数为单位)。 |
promotion_id |
string |
否 | P_12345 |
与商品相关的促销活动的 ID。 如果设置此参数,系统会忽略事件级 promotion_id 。
如果未设置此参数,系统会使用事件级 promotion_id (如果存在)。
|
promotion_name |
string |
否 | 夏季促销 |
与商品相关的促销活动的名称。 如果设置此参数,系统会忽略事件级 promotion_name 。
如果未设置此参数,系统会使用事件级 promotion_name (如果存在)。
|
quantity |
number |
否 | 1 |
商品数量。 |
退款
此事件表示退款已发放。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
currency |
string |
是* | USD |
与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略商品级 currency 。
如果未设置此参数,系统会使用 items 中第一件商品所用的币种。*如果设置 value ,则必须提供 currency ,这样才能准确计算收入指标。
|
transaction_id |
string |
是 | T_12345 | 交易的唯一标识符。 |
value |
number |
是* | 7.77 | 与事件相关的货币价值。 *如需生成有意义的报告,通常必须提供 value 。
如果您将事件标记为转化,则建议您设置 value 。
*如果设置 value ,则必须提供 currency 。
|
affiliation |
string |
否 | Google 商店 | 用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与事件相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
shipping |
number |
否 | 3.33 | 与交易相关的运费。 |
tax |
number |
否 | 1.11 | 与交易相关的税费。 |
items |
Array<Item>
|
否* | 与事件相关的商品。 *对于部分退款,必须提供 items ,而对于全额退款,则可忽略此参数。
|
Item 参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_id |
string |
是* | SKU_12345 |
商品的 ID。
*必须提供 |
item_name |
string |
是* | Stan 和 Friends Tee |
商品的名称。
*必须提供 |
affiliation |
string |
否 | Google 商店 |
用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
currency |
string |
否 | USD |
币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略事件级 currency 。不支持为每个事件设置多种币种。应为每件商品设置同一币种。 |
creative_name |
string |
否 | summer_banner2 | 促销广告素材的名称。 如果设置此参数,系统会忽略事件级 creative_name 。
如果未设置此参数,系统会使用事件级 creative_name (如果存在)。 |
creative_slot |
string |
否 | featured_app_1 | 与商品相关的促销广告素材投放到的广告位的名称。 如果设置此参数,系统会忽略事件级 creative_slot 。
如果未设置此参数,系统会使用事件级 creative_slot (如果存在)。 |
discount |
number |
否 | 2.22 | 与商品相关的折扣货币价值。 |
index |
number |
否 | 5 | 列表中商品的索引/商品在列表中的位置。 |
item_brand |
string |
否 | 商品所属品牌。 | |
item_category |
string |
否 | 服饰 | 商品所属类别。如果将其用作类别层次结构或类目的一部分,则为第一个类别。 |
item_category2 |
string |
否 | 成人 | 商品的第二类层次结构或其他类目。 |
item_category3 |
string |
否 | 衬衫 | 商品的第三类层次结构或其他类目。 |
item_category4 |
string |
否 | 圆领 | 商品的第四类层次结构或其他类目。 |
item_category5 |
string |
否 | 短袖 | 商品的第五类层次结构或其他类目。 |
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果设置此参数,系统会忽略事件级 item_list_id 。
如果未设置此参数,系统会使用事件级 item_list_id (如果存在)。
|
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果设置此参数,系统会忽略事件级 item_list_name 。
如果未设置此参数,系统会使用事件级 item_list_name (如果存在)。
|
item_variant |
string |
否 | 绿色 | 用于提供其他商品详情/选项的商品款式/规格、唯一代码或说明。 |
location_id |
string |
否 | L_12345 |
与商品相关的地理位置。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。 如果设置此参数,系统会忽略事件级 location_id 。
如果未设置此参数,系统会使用事件级 location_id (如果存在)。 |
price |
number |
否 | 9.99 | 商品的货币价格(以指定的 currency 参数为单位)。 |
promotion_id |
string |
否 | P_12345 |
与商品相关的促销活动的 ID。 如果设置此参数,系统会忽略事件级 promotion_id 。
如果未设置此参数,系统会使用事件级 promotion_id (如果存在)。
|
promotion_name |
string |
否 | 夏季促销 |
与商品相关的促销活动的名称。 如果设置此参数,系统会忽略事件级 promotion_name 。
如果未设置此参数,系统会使用事件级 promotion_name (如果存在)。
|
quantity |
number |
否 | 1 |
商品数量。 |
search
使用此事件可为搜索操作提供背景信息。此事件有助于您找出应用中最热门的内容。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
search_term |
string |
是 | T 恤 | 搜索的字词。 |
select_content
此事件表示用户选择了某个类型的某些内容。此事件有助于您找出应用中的热门内容和内容类别。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
content_type |
string |
否 | product | 所选内容的类型。 |
item_id |
string |
否 | I_12345 | 所选商品的标识符。 |
share
在用户分享了内容时使用此事件。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
method |
string |
否 | 共享内容的方法。 | |
content_type |
string |
否 | 图片 | 共享内容的类型。 |
item_id |
string |
否 | C_12345 | 共享内容的 ID。 |
sign_up
此事件表示用户已注册帐号。使用此事件可了解登录用户和退出用户的不同行为。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
method |
string |
否 | 注册时所用的方法。 |
view_item
此事件表示向用户展示了某些内容。使用此事件可了解用户查看了哪些最热门商品。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
currency |
string |
是* | USD |
与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略商品级 currency 。
如果未设置此参数,系统会使用 items 中第一件商品所用的币种。*如果设置 value ,则必须提供 currency ,这样才能准确计算收入指标。
|
value |
number |
是* | 7.77 | 与事件相关的货币价值。 *如需生成有意义的报告,通常必须提供 value 。
如果您将事件标记为转化,则建议您设置 value 。
*如果设置 value ,则必须提供 currency 。
|
items |
Array<Item> |
是 | 与事件相关的商品。 |
Item 参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_id |
string |
是* | SKU_12345 |
商品的 ID。
*必须提供 |
item_name |
string |
是* | Stan 和 Friends Tee |
商品的名称。
*必须提供 |
affiliation |
string |
否 | Google 商店 |
用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
currency |
string |
否 | USD |
币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略事件级 currency 。不支持为每个事件设置多种币种。应为每件商品设置同一币种。 |
creative_name |
string |
否 | summer_banner2 | 促销广告素材的名称。 如果设置此参数,系统会忽略事件级 creative_name 。
如果未设置此参数,系统会使用事件级 creative_name (如果存在)。 |
creative_slot |
string |
否 | featured_app_1 | 与商品相关的促销广告素材投放到的广告位的名称。 如果设置此参数,系统会忽略事件级 creative_slot 。
如果未设置此参数,系统会使用事件级 creative_slot (如果存在)。 |
discount |
number |
否 | 2.22 | 与商品相关的折扣货币价值。 |
index |
number |
否 | 5 | 列表中商品的索引/商品在列表中的位置。 |
item_brand |
string |
否 | 商品所属品牌。 | |
item_category |
string |
否 | 服饰 | 商品所属类别。如果将其用作类别层次结构或类目的一部分,则为第一个类别。 |
item_category2 |
string |
否 | 成人 | 商品的第二类层次结构或其他类目。 |
item_category3 |
string |
否 | 衬衫 | 商品的第三类层次结构或其他类目。 |
item_category4 |
string |
否 | 圆领 | 商品的第四类层次结构或其他类目。 |
item_category5 |
string |
否 | 短袖 | 商品的第五类层次结构或其他类目。 |
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果设置此参数,系统会忽略事件级 item_list_id 。
如果未设置此参数,系统会使用事件级 item_list_id (如果存在)。
|
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果设置此参数,系统会忽略事件级 item_list_name 。
如果未设置此参数,系统会使用事件级 item_list_name (如果存在)。
|
item_variant |
string |
否 | 绿色 | 用于提供其他商品详情/选项的商品款式/规格、唯一代码或说明。 |
location_id |
string |
否 | L_12345 |
与商品相关的地理位置。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。 如果设置此参数,系统会忽略事件级 location_id 。
如果未设置此参数,系统会使用事件级 location_id (如果存在)。 |
price |
number |
否 | 9.99 | 商品的货币价格(以指定的 currency 参数为单位)。 |
promotion_id |
string |
否 | P_12345 |
与商品相关的促销活动的 ID。 如果设置此参数,系统会忽略事件级 promotion_id 。
如果未设置此参数,系统会使用事件级 promotion_id (如果存在)。
|
promotion_name |
string |
否 | 夏季促销 |
与商品相关的促销活动的名称。 如果设置此参数,系统会忽略事件级 promotion_name 。
如果未设置此参数,系统会使用事件级 promotion_name (如果存在)。
|
quantity |
number |
否 | 1 |
商品数量。 |
view_item_list
向用户展示某类商品的列表时记录此事件。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果在商品级别进行设置,系统会忽略此参数。 |
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果在商品级别进行设置,系统会忽略此参数。 |
items |
Array<Item> |
是 | 与事件相关的商品。 |
Item 参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_id |
string |
是* | SKU_12345 |
商品的 ID。
*必须提供 |
item_name |
string |
是* | Stan 和 Friends Tee |
商品的名称。
*必须提供 |
affiliation |
string |
否 | Google 商店 |
用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
currency |
string |
否 | USD |
币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略事件级 currency 。不支持为每个事件设置多种币种。应为每件商品设置同一币种。 |
creative_name |
string |
否 | summer_banner2 | 促销广告素材的名称。 如果设置此参数,系统会忽略事件级 creative_name 。
如果未设置此参数,系统会使用事件级 creative_name (如果存在)。 |
creative_slot |
string |
否 | featured_app_1 | 与商品相关的促销广告素材投放到的广告位的名称。 如果设置此参数,系统会忽略事件级 creative_slot 。
如果未设置此参数,系统会使用事件级 creative_slot (如果存在)。 |
discount |
number |
否 | 2.22 | 与商品相关的折扣货币价值。 |
index |
number |
否 | 5 | 列表中商品的索引/商品在列表中的位置。 |
item_brand |
string |
否 | 商品所属品牌。 | |
item_category |
string |
否 | 服饰 | 商品所属类别。如果将其用作类别层次结构或类目的一部分,则为第一个类别。 |
item_category2 |
string |
否 | 成人 | 商品的第二类层次结构或其他类目。 |
item_category3 |
string |
否 | 衬衫 | 商品的第三类层次结构或其他类目。 |
item_category4 |
string |
否 | 圆领 | 商品的第四类层次结构或其他类目。 |
item_category5 |
string |
否 | 短袖 | 商品的第五类层次结构或其他类目。 |
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果设置此参数,系统会忽略事件级 item_list_id 。
如果未设置此参数,系统会使用事件级 item_list_id (如果存在)。
|
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果设置此参数,系统会忽略事件级 item_list_name 。
如果未设置此参数,系统会使用事件级 item_list_name (如果存在)。
|
item_variant |
string |
否 | 绿色 | 用于提供其他商品详情/选项的商品款式/规格、唯一代码或说明。 |
location_id |
string |
否 | L_12345 |
与商品相关的地理位置。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。 如果设置此参数,系统会忽略事件级 location_id 。
如果未设置此参数,系统会使用事件级 location_id (如果存在)。 |
price |
number |
否 | 9.99 | 商品的货币价格(以指定的 currency 参数为单位)。 |
promotion_id |
string |
否 | P_12345 |
与商品相关的促销活动的 ID。 如果设置此参数,系统会忽略事件级 promotion_id 。
如果未设置此参数,系统会使用事件级 promotion_id (如果存在)。
|
promotion_name |
string |
否 | 夏季促销 |
与商品相关的促销活动的名称。 如果设置此参数,系统会忽略事件级 promotion_name 。
如果未设置此参数,系统会使用事件级 promotion_name (如果存在)。
|
quantity |
number |
否 | 1 |
商品数量。 |
view_search_results
向用户展示搜索结果时记录此事件。
参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
search_term |
string |
否 | 服饰 | 搜索时所用的字词。 |
items |
Array<Item> |
否 | 与事件相关的商品。 |
Item 参数
名称 | 类型 | 是否必须提供 | 示例值 | 说明 |
---|---|---|---|---|
item_id |
string |
是* | SKU_12345 |
商品的 ID。
*必须提供 |
item_name |
string |
是* | Stan 和 Friends Tee |
商品的名称。
*必须提供 |
affiliation |
string |
否 | Google 商店 |
用于指定供应公司或实体店位置的商品关联商户。 事件级和商品级 affiliation 参数彼此独立。
|
coupon |
string |
否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
|
currency |
string |
否 | USD |
币种(采用由 3 个字母表示的 ISO 4217 格式)。 如果设置此参数,系统会忽略事件级 currency 。不支持为每个事件设置多种币种。应为每件商品设置同一币种。 |
creative_name |
string |
否 | summer_banner2 | 促销广告素材的名称。 如果设置此参数,系统会忽略事件级 creative_name 。
如果未设置此参数,系统会使用事件级 creative_name (如果存在)。 |
creative_slot |
string |
否 | featured_app_1 | 与商品相关的促销广告素材投放到的广告位的名称。 如果设置此参数,系统会忽略事件级 creative_slot 。
如果未设置此参数,系统会使用事件级 creative_slot (如果存在)。 |
discount |
number |
否 | 2.22 | 与商品相关的折扣货币价值。 |
index |
number |
否 | 5 | 列表中商品的索引/商品在列表中的位置。 |
item_brand |
string |
否 | 商品所属品牌。 | |
item_category |
string |
否 | 服饰 | 商品所属类别。如果将其用作类别层次结构或类目的一部分,则为第一个类别。 |
item_category2 |
string |
否 | 成人 | 商品的第二类层次结构或其他类目。 |
item_category3 |
string |
否 | 衬衫 | 商品的第三类层次结构或其他类目。 |
item_category4 |
string |
否 | 圆领 | 商品的第四类层次结构或其他类目。 |
item_category5 |
string |
否 | 短袖 | 商品的第五类层次结构或其他类目。 |
item_list_id |
string |
否 | related_products | 商品向用户展示时所在列表的 ID。 如果设置此参数,系统会忽略事件级 item_list_id 。
如果未设置此参数,系统会使用事件级 item_list_id (如果存在)。
|
item_list_name |
string |
否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果设置此参数,系统会忽略事件级 item_list_name 。
如果未设置此参数,系统会使用事件级 item_list_name (如果存在)。
|
item_variant |
string |
否 | 绿色 | 用于提供其他商品详情/选项的商品款式/规格、唯一代码或说明。 |
location_id |
string |
否 | L_12345 |
与商品相关的地理位置。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 ID。 如果设置此参数,系统会忽略事件级 location_id 。
如果未设置此参数,系统会使用事件级 location_id (如果存在)。 |
price |
number |
否 | 9.99 | 商品的货币价格(以指定的 currency 参数为单位)。 |
promotion_id |
string |
否 | P_12345 |
与商品相关的促销活动的 ID。 如果设置此参数,系统会忽略事件级 promotion_id 。
如果未设置此参数,系统会使用事件级 promotion_id (如果存在)。
|
promotion_name |
string |
否 | 夏季促销 |
与商品相关的促销活动的名称。 如果设置此参数,系统会忽略事件级 promotion_name 。
如果未设置此参数,系统会使用事件级 promotion_name (如果存在)。
|
quantity |
number |
否 | 1 |
商品数量。 |