add_payment_info
此事件表示用户在电子商务结账流程中提交了自己的付款信息。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "add_payment_info",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "coupon": "SUMMER_FUN",
        "payment_type": "Credit Card",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
add_shipping_info
此事件表示用户在电子商务结账流程中提交了自己的配送信息。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 value,则必须提供currency,这样才能准确计算收入指标。 | 
| value | number | 是* | 7.77 | 与事件相关的货币价值。 *为了生成有意义的报告,通常必须提供 value。如果您将事件标记为转化,则建议您设置value。*如果设置 value,则必须提供currency。 | 
| coupon | string | 否 | SUMMER_FUN | 与事件相关的优惠券名称/代码。 事件级和商品级 coupon参数彼此独立。 | 
| shipping_tier | string | 否 | Ground | 用户为所购商品选择的配送级别(例如 Ground、Air和Next-day)。 | 
| 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "add_shipping_info",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "coupon": "SUMMER_FUN",
        "shipping_tier": "Ground",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
add_to_cart
此事件表示商品已添加到购物车,可供购买。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "add_to_cart",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
add_to_wishlist
此事件表示商品已添加到心愿单。使用此事件可找出您应用中的热门礼品。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "add_to_wishlist",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
begin_checkout
此事件表示用户已开始结账流程。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "begin_checkout",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "coupon": "SUMMER_FUN",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
campaign_details
使用此事件发送将应用于未来事件的广告系列详情。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| campaign_id | string | 否 | google_1234 | 广告系列 ID。 | 
| campaign | string | 否 | Summer_fun | 用于标识具体的促销活动或战略性广告系列的名称。 | 
| source | string | 否 | 广告系列流量来源(例如 Google、电子邮件等)。 | |
| medium | string | 否 | cpc | 广告系列媒介(例如电子邮件、每次点击费用等)。 | 
| term | string | 否 | summer+travel | 广告系列字词,用于付费搜索,为广告提供关键字。 | 
| content | string | 否 | logolink | 广告系列内容,用于 A/B 测试和内容定位广告,以区分指向相同网址的不同广告或链接。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "campaign_details",
      "params": {
        "campaign_id": "google_1234",
        "campaign": "Summer_fun",
        "source": "google",
        "medium": "cpc",
        "term": "summer+travel",
        "content": "logolink"
      }
    }]
  })
});
earn_virtual_currency
此事件将衡量用户在游戏中获得虚拟货币的情况。请在记录此事件时一同记录 spend_virtual_currency 事件,以便更好地了解您的虚拟经济情况。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| virtual_currency_name | string | 否 | 宝石 | 虚拟货币的名称。 | 
| value | number | 否 | 5 | 虚拟货币的价值。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "earn_virtual_currency",
      "params": {
        "virtual_currency_name": "Gems",
        "value": 5
      }
    }]
  })
});
generate_lead
此事件将衡量带来潜在客户的情况(例如,通过表单)。请记录此事件,以了解营销广告系列的效果,以及向潜在客户进行再营销后吸引了多少客户重新与您的商家互动。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 value,则必须提供currency,这样才能准确计算收入指标。 | 
| value | number | 是* | 7.77 | 与事件相关的货币价值。 *为了生成有意义的报告,通常必须提供 value。如果您将事件标记为转化,则建议您设置value。*如果设置 value,则必须提供currency。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "generate_lead",
      "params": {
        "currency": "USD",
        "value": 99.99
      }
    }]
  })
});
join_group
在用户加入群组(例如公会、团队或家庭)时记录此事件。使用此事件可分析特定群组或社交功能的受欢迎程度。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| group_id | string | 否 | G_12345 | 群组的 ID。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events":[{
      "name":"join_group",
      "params":{
        "group_id":"G_12345"
      }
    }]
  })
});
level_up
此事件表示玩家在游戏中升级了。使用此事件可衡量用户群的等级分布情况,以及找出难以通过的关卡。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| level | number | 否 | 5 | 角色的等级。 | 
| character | string | 否 | 玩家 1 | 升级的角色。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "level_up",
      "params": {
        "level": 5,
        "character": "Player 1"
      }
    }]
  })
});
login
发送此事件即表示用户登录了您的网站或应用。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| method | string | 否 | 登录时所用的方法。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "login",
      "params": {
        "method": "Google"
      }
    }]
  })
});
post_score
在用户发布得分时发送此事件。使用此事件可了解用户在您游戏中的表现,并将最高得分与受众群体或行为关联起来。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| score | number | 是 | 10000 | 要发布的得分。 | 
| level | number | 否 | 5 | 得分对应的关卡。 | 
| character | string | 否 | 玩家 1 | 获得相应得分的角色。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "post_score",
      "params": {
        "score": 10000,
        "level": 5,
        "character": "Player 1"
      }
    }]
  })
});
purchase
此事件表示用户已购买一件或多件商品。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 value,则必须提供currency,这样才能准确计算收入指标。 | 
| transaction_id | string | 是 | T_12345 | 交易的唯一标识符。 transaction_id参数有助于避免出现重复的购买事件。 | 
| value | number | 是* | 12.21 | 与事件相关的货币价值。 *如需生成有意义的报告和填充“购买者”预测性受众群体,则必须提供 value。*如果设置 value,则必须提供currency。 | 
| 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "purchase",
      "params": {
        "currency": "USD",
        "transaction_id": "T_12345",
        "value": 12.21,
        "coupon": "SUMMER_FUN",
        "shipping": 3.33,
        "tax": 1.11,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
refund
此事件表示向用户退回一件或多件商品的款项。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 value,则必须提供currency,这样才能准确计算收入指标。 | 
| transaction_id | string | 是 | T_12345 | 交易的唯一标识符。 | 
| value | number | 是* | 7.77 | 与事件相关的货币价值。 *为了生成有意义的报告,通常必须提供 value。如果您将事件标记为转化,则建议您设置value。*如果设置 value,则必须提供currency。 | 
| 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "refund",
      "params": {
        "currency": "USD",
        "transaction_id": "T_12345",
        "value": 12.21,
        "coupon": "SUMMER_FUN",
        "shipping": 3.33,
        "tax": 1.11,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
remove_from_cart
此事件表示商品已从购物车中移除。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "remove_from_cart",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
search
记录此事件,以表明用户何时执行了搜索。您可以使用此事件来确定用户在您的网站或应用上搜索的内容。例如,如果用户在执行搜索后查看了搜索结果页,您就可以发送此事件。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| search_term | string | 是 | T 恤 | 搜索的字词。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "search",
      "params": {
        "search_term": "t-shirts"
      }
    }]
  })
});
select_content
此事件表示用户选择了某个类型的某些内容。此事件有助于您了解您网站或应用中的热门内容和内容类别。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| content_type | string | 否 | 产品 | 所选内容的类型。 | 
| content_id | string | 否 | C_12345 | 所选内容的标识符。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "select_content",
      "params": {
        "content_type": "product",
        "content_id": "C_12345"
      }
    }]
  })
});
select_item
此事件表示从列表中选择了商品。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| item_list_id | string | 否 | related_products | 商品向用户展示时所在列表的 ID。 如果在商品级别进行设置,系统会忽略此参数。 | 
| item_list_name | string | 否 | 相关商品 | 商品向用户展示时所在列表的名称。 如果在商品级别进行设置,系统会忽略此参数。 | 
| items | 
      Array<Item> | 是* | 与事件相关的商品。 * items数组应包含一个表示所选商品的元素。如果提供了多个元素,则仅使用items中的第一个元素。 | 
Item 参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| item_id | string | 是* | SKU_12345 | 商品的 ID。 
        *必须提供  | 
| item_name | string | 是* | Stan 和 Friends Tee | 商品的名称。 
        *必须提供  | 
| affiliation | string | 否 | Google 商店 | 用于指定供应公司或实体店面的商品关联商户。 注意:`affiliation` 仅适用于商品级范围。 | 
| coupon | string | 否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "select_item",
      "params": {
        "item_list_id": "related_products",
        "item_list_name": "Related products",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
select_promotion
此事件表示从列表中选择了推广活动。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| creative_name | string | 否 | summer_banner2 | 促销广告素材的名称。 如果在商品级别进行设置,系统会忽略此参数。 | 
| creative_slot | string | 否 | featured_app_1 | 与事件相关的促销广告素材投放到的广告位的名称。 如果在商品级别进行设置,系统会忽略此参数。 | 
| promotion_id | string | 否 | P_12345 | 与事件相关的促销活动的 ID。 如果在商品级别进行设置,系统会忽略此参数。 | 
| promotion_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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "select_promotion",
      "params": {
        "creative_name": "Summer Banner",
        "creative_slot": "featured_app_1",
        "promotion_id": "P_12345",
        "promotion_name": "Summer Sale",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "creative_name": "summer_banner2",
            "creative_slot": "featured_app_1",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "promotion_id": "P_12345",
            "promotion_name": "Summer Sale",
            "quantity": 1
          }
        ]
      }
    }]
  })
});
share
在用户分享了内容时使用此事件。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| method | string | 否 | 共享内容的方法。 | |
| content_type | string | 否 | 图片 | 共享内容的类型。 | 
| item_id | string | 否 | C_12345 | 共享内容的 ID。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "share",
      "params": {
        "method": "Twitter",
        "content_type": "image",
        "item_id": "C_12345"
      }
    }]
  })
});
sign_up
此事件表示用户已注册账号。使用此事件可了解登录用户和退出用户的不同行为。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| method | string | 否 | 注册时所用的方法。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "sign_up",
      "params": {
        "method": "Google"
      }
    }]
  })
});
spend_virtual_currency
此事件衡量的是应用内虚拟商品的销售情况,有助于您确定哪些虚拟商品最受欢迎。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| value | number | 是 | 5 | 虚拟货币的价值。 | 
| virtual_currency_name | string | 是 | 宝石 | 虚拟货币的名称。 | 
| item_name | string | 否 | 启动积分加倍活动 | 使用虚拟货币的商品的名称。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "spend_virtual_currency",
      "params": {
        "value": 5,
        "virtual_currency_name": "Gems",
        "item_name": "Starter Boost"
      }
    }]
  })
});
tutorial_begin
此事件表示新手入门流程已开始。在包含 tutorial_complete 的漏斗中使用此事件可了解有多少用户完成了教程。
参数
未针对此事件推荐任何参数。
此事件没有任何参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "tutorial_begin"
    }]
  })
});
tutorial_complete
此事件表示用户已完成新手入门流程。在包含 tutorial_begin 的漏斗中使用此事件可了解有多少用户完成了教程。
参数
未针对此事件推荐任何参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "tutorial_complete"
    }]
  })
});
unlock_achievement
在用户解锁成就时记录此事件。此事件有助于您了解用户在您游戏中的体验。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| achievement_id | string | 是 | A_12345 | 已解锁成就的 ID。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "unlock_achievement",
      "params": {
        "achievement_id": "A_12345"
      }
    }]
  })
});
view_cart
此事件表示用户查看了购物车。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_cart",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
view_item
此事件表示向用户展示了某些内容。使用此事件可了解用户查看了哪些最热门商品。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| currency | string | 是* | USD | 与事件相关的商品所用的币种(采用由 3 个字母表示的 ISO 4217 格式)。 *如果设置 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_item",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 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参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_item_list",
      "params": {
        "item_list_id": "related_products",
        "item_list_name": "Related products",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "quantity": 1
          }
        ]
      }
    }]
  })
});
view_promotion
此事件表示从列表查看了推广活动。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| creative_name | string | 否 | summer_banner2 | 促销广告素材的名称。 如果在商品级别进行设置,系统会忽略此参数。 | 
| creative_slot | string | 否 | featured_app_1 | 与事件相关的促销广告素材投放到的广告位的名称。 如果在商品级别进行设置,系统会忽略此参数。 | 
| promotion_id | string | 否 | P_12345 | 与事件相关的促销活动的 ID。 如果在商品级别进行设置,系统会忽略此参数。 | 
| promotion_name | string | 否 | 夏季促销 | 与事件相关的促销活动的名称。 如果在商品级别进行设置,系统会忽略此参数。 | 
| items | 
      Array<Item> | 是* | 与事件相关的商品。 * items数组应包含一个表示促销活动相关商品的元素。如果提供了多个元素,则仅使用items中的第一个元素。 | 
Item 参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| item_id | string | 是* | SKU_12345 | 商品的 ID。 
        *必须提供  | 
| item_name | string | 是* | Stan 和 Friends Tee | 商品的名称。 
        *必须提供  | 
| affiliation | string | 否 | Google 商店 | 用于指定供应公司或实体店面的商品关联商户。 注意:`affiliation` 仅适用于商品级范围。 | 
| coupon | string | 否 | SUMMER_FUN | 与商品相关的优惠券名称/代码。 事件级和商品级 coupon参数彼此独立。 | 
| 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 | 否 | ChIJIQBpAG2ahYAR_6128GcTUEo(旧金山对应的 Google 地点 ID) | 与商品关联的实际位置(例如实体店)。建议使用与相关商品对应的 Google 地点 ID,也可使用自定义地理位置 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 | 商品数量。 | 
items 数组中加入最多 27 个自定义参数。
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_promotion",
      "params": {
        "creative_name": "Summer Banner",
        "creative_slot": "featured_app_1",
        "promotion_id": "P_12345",
        "promotion_name": "Summer Sale",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "creative_name": "summer_banner2",
            "creative_slot": "featured_app_1",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 9.99,
            "promotion_id": "P_12345",
            "promotion_name": "Summer Sale",
            "quantity": 1
          }
        ]
      }
    }]
  })
});
view_search_results
向用户展示搜索结果时记录此事件。请注意,您可以通过 Google Analytics(分析)中的增强型事件衡量功能,实现 view_search_results 事件自动收集。
参数
| 名称 | 类型 | 是否必须提供 | 示例值 | 说明 | 
|---|---|---|---|---|
| search_term | string | 否 | 服饰 | 搜索时所用的字词。 | 
发送事件
const measurementId = `G-XXXXXXXXXX`;
const apiSecret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_search_results",
      "params": {
        "search_term": "Clothing"
      }
    }]
  })
});