Google Analytics 建议的事件

以下是推荐事件的列表。您还可以创建和发送自己的自定义事件。

重要提示： 对于发送到应用数据流的事件，请使用 app_instance_id 而不是 client_id。

创建自定义事件名称时，您必须：

1. 遵循事件命名规则。
2. 避免使用预留的名称和前缀。
3. 遵守事件收集限制，例如事件和参数名称的 40 个字符限制。

如需了解详情，请参阅使用入门。

如果您要从 Measurement Protocol 升级，请参阅从 Measurement Protocol 升级以了解相关说明。

所有媒体资源

ad_impression

此事件仅适用于应用数据流。

当用户看到广告展示时，使用此事件。

• 使用 Measurement Protocol 发送的 ad_impression 将不会包含在导出到其他广告平台（例如 Google Ads）的数据中。
• 如果您已为关联的 Google 广告产品配置代码植入或 SDK，使用 Measurement Protocol 发送 ad_impression 事件可能会导致展示次数重复统计。仅当标记或 SDK 未捕获到 ad_impression 事件时，才使用 Measurement Protocol 发送该事件。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	否	美元	与事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 *如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	否	3.99 欧元	广告展示的价值。 * 为了生成有意义的报告，通常必须提供 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。

参数

名称	类型	是否必须提供	示例值	说明
ad_platform	string	否	MoPub	广告平台。
ad_source	string	否	AdColony	广告来源。
ad_format	string	否	横幅	广告格式。
ad_unit_name	string	否	Banner_03	广告单元名称。

示例

以下示例展示了如何使用 Data Manager API 发送 ad_impression 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "FIREBASE_APP_ID"
    }
  ],
  "events": [
    {
      "eventName": "ad_impression",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "APP",
      "appInstanceId": "APP_INSTANCE_ID",
      "currency": "USD",
      "conversionValue": 3.99,
      "additionalEventParameters": [
        {
          "parameterName": "ad_platform",
          "value": "MoPub"
        },
        {
          "parameterName": "ad_source",
          "value": "AdColony"
        },
        {
          "parameterName": "ad_format",
          "value": "Banner"
        },
        {
          "parameterName": "ad_unit_name",
          "value": "Banner_03"
        }
      ]
    }
  ]
}

Measurement Protocol

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({
    "app_instance_id": "app_instance_id",
    "events": [{
      "name": "ad_impression",
      "params": {
        "ad_platform": "MoPub",
        "ad_source": "AdColony",
        "ad_format": "Banner",
        "ad_unit_name": "Banner_03",
        "currency": "USD",
        "value": 3.99
      }
    }]
  })
});

earn_virtual_currency

此事件将衡量用户在游戏中获得虚拟货币的情况。请在记录此事件时一同记录 spend_virtual_currency 事件，以便更好地了解您的虚拟经济情况。

事件字段

名称	类型	是否必须提供	示例值	说明
conversion_value	number	否	5	虚拟货币的价值。

参数

名称	类型	是否必须提供	示例值	说明
virtual_currency_name	string	否	宝石	虚拟货币的名称。

示例

以下示例展示了如何使用 Data Manager API 发送 earn_virtual_currency 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "earn_virtual_currency",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "conversionValue": 5,
      "additionalEventParameters": [
        {
          "parameterName": "virtual_currency_name",
          "value": "Gems"
        }
      ]
    }
  ]
}

Measurement Protocol

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
      }
    }]
  })
});

join_group

在用户加入群组（例如公会、团队或家庭）时记录此事件。使用此事件可分析特定群组或社交功能的受欢迎程度。

参数

名称	类型	是否必须提供	示例值	说明
group_id	string	否	G_12345	群组的 ID。

示例

以下示例展示了如何使用 Data Manager API 发送 join_group 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "join_group",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "group_id",
          "value": "G_12345"
        }
      ]
    }
  ]
}

Measurement Protocol

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"
      }
    }]
  })
});

login

发送此事件即表示用户登录了您的网站或应用。

参数

名称	类型	是否必须提供	示例值	说明
method	string	否	Google	登录时所用的方法。

示例

以下示例展示了如何使用 Data Manager API 发送 login 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "login",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "method",
          "value": "Google"
        }
      ]
    }
  ]
}

Measurement Protocol

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"
      }
    }]
  })
});

screen_view

此事件仅适用于应用数据流。

使用此事件表示发生了屏幕转换。

参数

名称	类型	是否必须提供	示例值	说明
screen_class	string	否	MainActivity	屏幕的类别。
screen_name	string	否	About	屏幕名称。

示例

以下示例展示了如何使用 Data Manager API 发送 screen_view 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "FIREBASE_APP_ID"
    }
  ],
  "events": [
    {
      "eventName": "screen_view",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "APP",
      "appInstanceId": "APP_INSTANCE_ID",
      "additionalEventParameters": [
        {
          "parameterName": "screen_class",
          "value": "MainActivity"
        },
        {
          "parameterName": "screen_name",
          "value": "About"
        }
      ]
    }
  ]
}

Measurement Protocol

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({
    "app_instance_id": "app_instance_id",
    "events": [{
      "name": "screen_view",
      "params": {
        "screen_class": "MainActivity",
        "screen_name": "About"
      }
    }]
  })
});

search

记录此事件，以表明用户何时执行了搜索。您可以使用此事件来确定用户在您的网站或应用上搜索的内容。例如，如果用户在执行搜索后查看了搜索结果页，您就可以发送此事件。

参数

名称	类型	是否必须提供	示例值	说明
search_term	string	是	T 恤	搜索的字词。

示例

以下示例展示了如何使用 Data Manager API 发送 search 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "search",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "search_term",
          "value": "t-shirts"
        }
      ]
    }
  ]
}

Measurement Protocol

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	所选内容的标识符。该值必须包含至少一个非数字字符。

示例

以下示例展示了如何使用 Data Manager API 发送 select_content 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "select_content",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "content_type",
          "value": "product"
        },
        {
          "parameterName": "content_id",
          "value": "C_12345"
        }
      ]
    }
  ]
}

Measurement Protocol

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"
      }
    }]
  })
});

share

在用户分享了内容时使用此事件。

事件字段

名称	类型	是否必须提供	示例值	说明
cart_data.items	Item[]	否		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

参数

名称	类型	是否必须提供	示例值	说明
method	string	否	Twitter	共享内容的方法。
content_type	string	否	图片	共享内容的类型。

示例

以下示例展示了如何使用 Data Manager API 发送 share 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "share",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "cartData": {
        "items": [
          {
            "itemId": "C_12345",
            "quantity": 1,
            "unitPrice": 27.67
          }
        ]
      },
      "additionalEventParameters": [
        {
          "parameterName": "method",
          "value": "Twitter"
        },
        {
          "parameterName": "content_type",
          "value": "image"
        }
      ]
    }
  ]
}

Measurement Protocol

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	否	Google	注册时所用的方法。

示例

以下示例展示了如何使用 Data Manager API 发送 sign_up 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "sign_up",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "method",
          "value": "Google"
        }
      ]
    }
  ]
}

Measurement Protocol

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

此事件衡量的是应用内虚拟商品的销售情况，有助于您确定哪些虚拟商品最受欢迎。

事件字段

名称	类型	是否必须提供	示例值	说明
conversion_value	number	是	5	虚拟货币的价值。
cart_data.items	Item[]	否		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

商品参数

名称	类型	是否必须提供	示例值	说明
item_name	string	否	启动积分加倍活动	使用虚拟货币的商品的名称。

参数

名称	类型	是否必须提供	示例值	说明
virtual_currency_name	string	是	宝石	虚拟货币的名称。

示例

以下示例展示了如何使用 Data Manager API 发送 spend_virtual_currency 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "spend_virtual_currency",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "cartData": {
        "items": [
          {
            "itemId": "I_12345",
            "quantity": 1,
            "unitPrice": 27.67,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Starter Boost"
              }
            ]
          }
        ]
      },
      "conversionValue": 5,
      "additionalEventParameters": [
        {
          "parameterName": "virtual_currency_name",
          "value": "Gems"
        }
      ]
    }
  ]
}

Measurement Protocol

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 的漏斗中使用此事件可了解有多少用户完成了教程。

参数

未针对此事件推荐任何参数。

示例

以下示例展示了如何使用 Data Manager API 发送 tutorial_begin 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "tutorial_begin",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID"
    }
  ]
}

Measurement Protocol

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 的漏斗中使用此事件可了解有多少用户完成了教程。

参数

未针对此事件推荐任何参数。

示例

以下示例展示了如何使用 Data Manager API 发送 tutorial_complete 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "tutorial_complete",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID"
    }
  ]
}

Measurement Protocol

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"
    }]
  })
});

view_search_results

向用户展示搜索结果时记录此事件。请注意，您可以通过 Google Analytics 中的增强型事件衡量功能，实现 view_search_results 事件自动收集。

参数

名称	类型	是否必须提供	示例值	说明
search_term	string	否	服饰	搜索时所用的字词。

注意：如果搜索字词在当前会话中是唯一的，则 view_search_results 事件将会发送值为 1 的 unique_search_term 参数。如果搜索字词已在当前会话中提交，则该参数的值为 0。

示例

以下示例展示了如何使用 Data Manager API 发送 view_search_results 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_search_results",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "search_term",
          "value": "Clothing"
        }
      ]
    }
  ]
}

Measurement Protocol

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"
      }
    }]
  })
});

campaign_details

使用此事件发送将应用于时间戳晚于或等于 campaign_details 事件时间戳的事件的广告系列详情。

注意 ：campaign_details 事件不会显示在 Google Analytics 报告或 DebugView 中。如果您已启用 BigQuery Export，则此事件将显示在您的 BigQuery 事件导出数据中。

参数

名称	类型	是否必须提供	示例值	说明
campaign_id	string	否	google_1234	广告系列 ID。
campaign	string	否	Summer_fun	用于标识具体的促销活动或战略性广告系列的名称。
source	string	否	google	广告系列流量来源（例如 Google、电子邮件等）。
medium	string	否	cpc	广告系列媒介（例如电子邮件、每次点击费用等）。
term	string	否	summer+travel	广告系列字词，用于付费搜索，为广告提供关键字。
content	string	否	logolink	广告系列内容，用于 A/B 测试和内容定位广告，以区分指向相同网址的不同广告或链接。

示例

以下示例展示了如何使用 Data Manager API 发送 campaign_details 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "campaign_details",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "campaign_id",
          "value": "google_1234"
        },
        {
          "parameterName": "campaign",
          "value": "Summer_fun"
        },
        {
          "parameterName": "source",
          "value": "google"
        },
        {
          "parameterName": "medium",
          "value": "cpc"
        },
        {
          "parameterName": "term",
          "value": "summer+travel"
        },
        {
          "parameterName": "content",
          "value": "logolink"
        }
      ]
    }
  ]
}

Measurement Protocol

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"
      }
    }]
  })
});

线上销售

add_payment_info

此事件表示用户在电子商务结账流程中提交了自己的付款信息。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。
cart_data.coupon_codes	string[]	否	SUMMER_FUN	与活动关联的优惠券代码。 在 CartData 对象上设置 coupon_codes 字段。 * 此列表中只能提供一个优惠券代码。 * 这与商品级优惠券代码无关。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

参数

名称	类型	是否必须提供	示例值	说明
payment_type	string	否	信用卡	选定的付款方式。

示例

以下示例展示了如何使用 Data Manager API 发送 add_payment_info 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "add_payment_info",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "payment_type",
          "value": "Credit Card"
        }
      ],
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 30.03,
        "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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

add_shipping_info

此事件表示用户在电子商务结账流程中提交了自己的配送信息。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。
cart_data.coupon_codes	string[]	否	SUMMER_FUN	与活动关联的优惠券代码。 在 CartData 对象上设置 coupon_codes 字段。 * 此列表中只能提供一个优惠券代码。 * 这与商品级优惠券代码无关。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

参数

名称	类型	是否必须提供	示例值	说明
shipping_tier	string	否	Ground	用户为所购商品选择的配送级别（例如 Ground、Air 和 Next-day）。

示例

以下示例展示了如何使用 Data Manager API 发送 add_shipping_info 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "add_shipping_info",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "shipping_tier",
          "value": "Ground"
        }
      ],
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 30.03,
        "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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

add_to_cart

此事件表示商品已添加到购物车，可供购买。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

商品参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 add_to_cart 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "add_to_cart",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 30.03,
        "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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

add_to_wishlist

此事件表示商品已添加到心愿单。使用此事件可找出您应用中的热门礼品。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

商品参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 add_to_wishlist 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "add_to_wishlist",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 30.03,
        "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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

begin_checkout

此事件表示用户已开始结账流程。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。
cart_data.coupon_codes	string[]	否	SUMMER_FUN	与活动关联的优惠券代码。 在 CartData 对象上设置 coupon_codes 字段。 * 此列表中只能提供一个优惠券代码。 * 这与商品级优惠券代码无关。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

Item 参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 begin_checkout 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "begin_checkout",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 30.03,
        "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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

in_app_purchase

此事件仅适用于应用数据流。

在用户进行应用内购买时使用此事件。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	相应活动的 conversion_value 所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 *为了生成有意义的报告，通常必须提供 conversion_value。如果您将事件标记为关键事件，则建议您设置 conversion_value。 *如果设置 conversion_value，则必须提供 currency。
cart_data.items	Item[]	否		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

参数

名称	类型	是否必须提供	示例值	说明
product_id	string	否	ABC123456789	商品的 ID。
subscription	boolean	否	true	指示相应购买交易是否为订阅。 如果未设置，则默认为 false。
free_trial	boolean	否	true	指示相应事件是否与订阅的免费试用有关。 如果未设置，则默认为 false。
price_is_discounted	boolean	否	false	指示 price 是否有折扣。 如果未设置，则默认为 false。

示例

以下示例展示了如何使用 Data Manager API 发送 in_app_purchase 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "FIREBASE_APP_ID"
    }
  ],
  "events": [
    {
      "eventName": "in_app_purchase",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "APP",
      "appInstanceId": "APP_INSTANCE_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "cartData": {
        "items": [
          {
            "itemId": "ABC123456789",
            "quantity": 3,
            "unitPrice": 10.01
          }
        ]
      },
      "additionalEventParameters": [
        {
          "parameterName": "subscription",
          "value": true
        },
        {
          "parameterName": "free_trial",
          "value": false
        },
        {
          "parameterName": "price_is_discounted",
          "value": false
        }
      ]
    }
  ]
}

Measurement Protocol

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({
    "app_instance_id": "app_instance_id",
    "events":[{
      "name":"in_app_purchase",
      "params":{
        "currency": "USD",
        "value": 30.03,
        "quantity": 3,
        "product_id": "ABC123456789",
        "subscription": true,
        "free_trial": false,
        "price_is_discounted": false
      }
    }]
  })
});

purchase

此事件表示用户已购买一件或多件商品。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
transaction_id	string	是	T_12345	交易的唯一标识符。 transaction_id 参数有助于避免出现重复的购买事件。在 Event 对象上设置 transaction_id 字段。
user_properties.customer_type	CustomerType	否	NEW	转化是否来自 NEW 或 RETURNING 客户。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。
cart_data.coupon_codes	string[]	否	SUMMER_FUN	与活动关联的优惠券代码。 在 CartData 对象上设置 coupon_codes 字段。 * 此列表中只能提供一个优惠券代码。 * 这与商品级优惠券代码无关。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

参数

名称	类型	是否必须提供	示例值	说明
shipping	number	否	3.33	与交易相关的运费。
tax	number	否	1.11	与交易相关的税费。

Item 参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 purchase 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "purchase",
      "transactionId": "TRANSACTION_ID",
      "conversionValue": 83.99,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "userProperties": {
        "customerType": "RETURNING"
      },
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 3,
            "unitPrice": 10.01,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Stan and Friends Tee"
              },
              {
                "parameterName": "affiliation",
                "value": "Google Merchandise Store"
              },
              {
                "parameterName": "discount",
                "value": "2.22"
              },
              {
                "parameterName": "index",
                "value": "0"
              },
              {
                "parameterName": "item_brand",
                "value": "Google"
              },
              {
                "parameterName": "item_category",
                "value": "Apparel"
              },
              {
                "parameterName": "item_category2",
                "value": "Adult"
              },
              {
                "parameterName": "item_category3",
                "value": "Shirts"
              },
              {
                "parameterName": "item_category4",
                "value": "Crew"
              },
              {
                "parameterName": "item_category5",
                "value": "Short sleeve"
              },
              {
                "parameterName": "item_list_id",
                "value": "related_products"
              },
              {
                "parameterName": "item_list_name",
                "value": "Related Products"
              },
              {
                "parameterName": "item_variant",
                "value": "green"
              },
              {
                "parameterName": "location_id",
                "value": "ChIJIQBpAG2ahYAR_6128GcTUEo"
              },
              {
                "parameterName": "google_business_vertical",
                "value": "retail"
              }
            ]
          }
        ]
      },
      "additionalEventParameters": [
        {
          "parameterName": "shipping",
          "value": "3.33"
        },
        {
          "parameterName": "tax",
          "value": "1.11"
        }
      ]
    }
  ]
}

Measurement Protocol

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": 30.03,
        "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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

refund

此事件表示向用户退回一件或多件商品的款项。

注意：我们建议您在 refund 事件中添加商品信息，以便在 Analytics 中查看商品级退款指标。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
transaction_id	string	是	T_12345	交易的唯一标识符。
cart_data.items	Item[]	否		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。
cart_data.coupon_codes	string[]	否	SUMMER_FUN	与活动关联的优惠券代码。 在 CartData 对象上设置 coupon_codes 字段。 * 此列表中只能提供一个优惠券代码。 * 这与商品级优惠券代码无关。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

参数

名称	类型	是否必须提供	示例值	说明
shipping	number	否	3.33	与交易相关的运费。
tax	number	否	1.11	与交易相关的税费。

Item 参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 refund 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "refund",
      "conversionValue": 30.03,
      "currency": "USD",
      "transactionId": "T_12345",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "shipping",
          "value": 3.33
        },
        {
          "parameterName": "tax",
          "value": 1.11
        }
      ],
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 30.03,
        "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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

remove_from_cart

此事件表示商品已从购物车中移除。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

商品参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 remove_from_cart 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "remove_from_cart",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 30.03,
        "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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

select_item

此事件表示从列表中选择了商品。

事件字段

名称	类型	是否必须提供	示例值	说明
cart_data.items	Item[]	是*		与事件相关的商品。 *items 数组应包含一个表示所选商品的元素。如果提供了多个元素，则仅使用 items 中的第一个元素。 设置 Event 对象上的 cart_data.items 字段。

参数

名称	类型	是否必须提供	示例值	说明
item_list_id	string	否	related_products	商品向用户展示时所在列表的 ID。 如果在商品级别进行设置，系统会忽略此参数。
item_list_name	string	否	相关商品	商品向用户展示时所在列表的名称。 如果在商品级别进行设置，系统会忽略此参数。

Item 参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 select_item 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "select_item",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "item_list_id",
          "value": "related_products"
        },
        {
          "parameterName": "item_list_name",
          "value": "Related products"
        }
      ],
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

select_promotion

此事件表示从列表中选择了推广活动。

事件字段

名称	类型	是否必须提供	示例值	说明
cart_data.items	Item[]	否		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

参数

名称	类型	是否必须提供	示例值	说明
creative_name	string	否	summer_banner2	促销广告素材的名称。
creative_slot	string	否	featured_app_1	与事件相关的促销广告素材投放到的广告位的名称。
promotion_id	string	否	P_12345	与事件相关的促销活动的 ID。
promotion_name	string	否	夏季促销	与事件相关的促销活动的名称。

为了在 Google Analytics 报告中填充商品级范围的促销维度（例如“商品促销 ID”或“商品促销名称”），Google Analytics 首先会在电子商务事件的 items 数组中查找每个特定对象内的相应促销参数（promotion_id、promotion_name、creative_name 和 creative_slot）。如果在商品对象中未找到相应参数，Google Analytics 随后会使用 *事件级* 参数中的值（如果提供了该参数）。如果特定商品的商品级范围的促销维度在商品对象和事件级参数中都缺少相关参数，则只会报告为“(not set)”。商品级参数始终优先于事件级参数。

商品参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
creative_name	string	否	summer_banner2	促销广告素材的名称。 如果未设置，则默认为事件级 creative_name。
creative_slot	string	否	featured_app_1	与商品相关的促销广告素材投放到的广告位的名称。 如果未设置，则默认为事件级 creative_slot。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。
promotion_id	string	否	P_12345	与商品相关的促销活动的 ID。 如果未设置，则默认为事件级 promotion_id。
promotion_name	string	否	夏季促销	与商品相关的促销活动的名称。 如果未设置，则默认为事件级 promotion_name。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 select_promotion 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "select_promotion",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "creative_name",
          "value": "Summer Banner"
        },
        {
          "parameterName": "creative_slot",
          "value": "featured_app_1"
        },
        {
          "parameterName": "promotion_id",
          "value": "P_12345"
        },
        {
          "parameterName": "promotion_name",
          "value": "Summer Sale"
        }
      ],
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 10.01,
            "promotion_id": "P_12345",
            "promotion_name": "Summer Sale",
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

view_cart

此事件表示用户查看了购物车。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

商品参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 view_cart 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_cart",
      "conversionValue": 7.77,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          },
          {
            "itemId": "SKU_67890",
            "quantity": 2,
            "unitPrice": 24.00,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Google Red Team Hat"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

view_item

此事件表示向用户展示了某些内容。使用此事件可了解用户查看了哪些最热门商品。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 * 将 conversion_value 设置为 items 中所有商品的 (price * quantity) 之和。请勿包含 shipping 或 tax。 * 为了生成有意义的报告，通常必须提供 conversion_value。 如果您将事件标记为关键事件，则建议您设置 conversion_value。 * 如果设置 conversion_value，则必须提供 currency。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

商品参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 view_item 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_item",
      "conversionValue": 7.77,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          },
          {
            "itemId": "SKU_67890",
            "quantity": 2,
            "unitPrice": 24.00,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Google Red Team Hat"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ],
      }
    }]
  })
});

view_item_list

向用户展示某类商品的列表时记录此事件。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	与该事件相关的商品所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * view_item 事件的价值指标不计入收入 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
cart_data.items	Item[]	是		与事件相关的商品。 在 Event 对象上设置 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

商品参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 view_item_list 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_item_list",
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "item_list_id",
          "value": "related_products"
        },
        {
          "parameterName": "item_list_name",
          "value": "Related products"
        }
      ],
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

view_promotion

此事件表示从列表查看了推广活动。

事件字段

名称	类型	是否必须提供	示例值	说明
cart_data.items	Item[]	是*		与事件相关的商品。 *items 数组应包含一个表示促销活动相关商品的元素。如果提供了多个元素，则仅使用 items 中的第一个元素。 设置 Event 对象上的 cart_data.items 字段。

商品字段

名称	类型	是否必须提供	示例值	说明
item_id	string	是	I_12345	商品的唯一标识符。在 Item 对象上设置 item_id 字段。
unit_price	number	是	27.67	相应商品的单价（不含税、运费和事件级 [交易级] 折扣）。 如果商品有商品级折扣，请使用折扣后的单价。例如，如果某商品的单价为 27.67，单位折扣为 6.66，则将 unitPrice 设置为 21.01。
quantity	number	是	1	购买的相应商品的数量。

参数

名称	类型	是否必须提供	示例值	说明
creative_name	string	否	summer_banner2	促销广告素材的名称。
creative_slot	string	否	featured_app_1	与事件相关的促销广告素材投放到的广告位的名称。
promotion_id	string	否	P_12345	与事件相关的促销活动的 ID。
promotion_name	string	否	夏季促销	与事件相关的促销活动的名称。

为了在 Google Analytics 报告中填充商品级范围的促销维度（例如“商品促销 ID”或“商品促销名称”），Google Analytics 会先在电子商务事件的 items 数组中查找每个特定对象内的相应促销参数（promotion_id、promotion_name、creative_name 和 creative_slot）。如果在商品对象中未找到相应参数，Google Analytics 随后会使用 *事件级* 参数中的值（如果提供了该参数）。如果商品对象和事件级参数中都缺少相关参数，特定商品的商品级范围的促销维度才会报告为“(not set)”。商品级参数始终优先于事件级参数。

商品参数

名称	类型	是否必须提供	示例值	说明
item_name	string	是*	Stan 和 Friends Tee	商品的名称。 *必须提供 item_id 或 item_name 中的一个。
affiliation	string	否	Google 商店	用于指定供应公司或实体店面的商品关联商户。 注意：affiliation 仅适用于商品级范围。
coupon	string	否	SUMMER_FUN	与商品相关的优惠券名称/代码。 事件级和商品级 coupon 参数彼此独立。
creative_name	string	否	summer_banner2	促销广告素材的名称。 如果未设置，则默认为事件级 creative_name。
creative_slot	string	否	featured_app_1	与商品相关的促销广告素材投放到的广告位的名称。 如果未设置，则默认为事件级 creative_slot。
discount	number	否	2.22	与相应商品相关的单位折扣值（金额形式）。
index	number	否	5	列表中商品的索引/商品在列表中的位置。
item_brand	string	否	Google	商品所属品牌。
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 仅适用于商品级范围。
promotion_id	string	否	P_12345	与商品相关的促销活动的 ID。 如果未设置，则默认为事件级 promotion_id。
promotion_name	string	否	夏季促销	与商品相关的促销活动的名称。 如果未设置，则默认为事件级 promotion_name。

除这些指定参数外，您还可以在 items 数组中加入最多 27 个自定义参数。

示例

以下示例展示了如何使用 Data Manager API 发送 view_promotion 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_promotion",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "creative_name",
          "value": "Summer Banner"
        },
        {
          "parameterName": "creative_slot",
          "value": "featured_app_1"
        },
        {
          "parameterName": "promotion_id",
          "value": "P_12345"
        },
        {
          "parameterName": "promotion_name",
          "value": "Summer Sale"
        }
      ],
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

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": 10.01,
            "promotion_id": "P_12345",
            "promotion_name": "Summer Sale",
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

游戏

level_up

此事件表示玩家在游戏中升级了。使用此事件可衡量用户群的等级分布情况，以及找出难以通过的关卡。

参数

名称	类型	是否必须提供	示例值	说明
level	number	否	5	角色的等级。
character	string	否	玩家 1	升级的角色。

示例

以下示例展示了如何使用 Data Manager API 发送 level_up 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "level_up",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "level",
          "value": 5
        },
        {
          "parameterName": "character",
          "value": "Player 1"
        }
      ]
    }
  ]
}

Measurement Protocol

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"
      }
    }]
  })
});

post_score

在用户发布得分时发送此事件。使用此事件可了解用户在您游戏中的表现，并将最高得分与受众群体或行为关联起来。

参数

名称	类型	是否必须提供	示例值	说明
score	number	是	10000	要发布的得分。
level	number	否	5	得分对应的关卡。
character	string	否	玩家 1	获得相应得分的角色。

示例

以下示例展示了如何使用 Data Manager API 发送 post_score 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "post_score",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "score",
          "value": 10000
        },
        {
          "parameterName": "level",
          "value": 5
        },
        {
          "parameterName": "character",
          "value": "Player 1"
        }
      ]
    }
  ]
}

Measurement Protocol

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"
      }
    }]
  })
});

unlock_achievement

在用户解锁成就时记录此事件。此事件有助于您了解用户在您游戏中的体验。

参数

名称	类型	是否必须提供	示例值	说明
achievement_id	string	是	A_12345	已解锁成就的 ID。

示例

以下示例展示了如何使用 Data Manager API 发送 unlock_achievement 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "unlock_achievement",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "achievement_id",
          "value": "A_12345"
        }
      ]
    }
  ]
}

Measurement Protocol

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"
      }
    }]
  })
});

潜在客户发掘

close_convert_lead

当符合条件的潜在客户成功转化为客户时，记录此事件。 这通常表示潜在客户培养流程结束，例如签署合同、开始付费订阅或完成最终销售交易。

• 注意：如需跟踪初始潜在客户获取情况（例如表单提交、简报订阅或演示申请），请使用 generate_lead 事件。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	相应活动的 conversion_value 所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 *为了生成有意义的报告，通常必须提供 conversion_value。如果您将事件标记为关键事件，则建议您设置 conversion_value。 *如果设置 conversion_value，则必须提供 currency。

示例

以下示例展示了如何使用 Data Manager API 发送 close_convert_lead 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "close_convert_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03
    }
  ]
}

Measurement Protocol

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": "close_convert_lead",
      "params": {
        "currency": "USD",
        "value": 30.03
      }
    }]
  })
});

close_unconvert_lead

此事件衡量的是用户被标记为未成为完成转化的潜在客户的情况，以及相应的原因。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	相应活动的 conversion_value 所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 *为了生成有意义的报告，通常必须提供 conversion_value。如果您将事件标记为关键事件，则建议您设置 conversion_value。 *如果设置 conversion_value，则必须提供 currency。

参数

名称	类型	是否必须提供	示例值	说明
unconvert_lead_reason	string	否	从未回复	潜在客户未完成转化的原因。

示例

以下示例展示了如何使用 Data Manager API 发送 close_unconvert_lead 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "close_unconvert_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "additionalEventParameters": [
        {
          "parameterName": "unconvert_lead_reason",
          "value": "Never responded"
        }
      ]
    }
  ]
}

Measurement Protocol

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": "close_unconvert_lead",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "unconvert_lead_reason": "Never responded"
      }
    }]
  })
});

disqualify_lead

此事件衡量的是用户被标记为不符合条件，无法成为潜在客户的情况，以及不符合条件的原因。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	相应活动的 conversion_value 所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 *为了生成有意义的报告，通常必须提供 conversion_value。如果您将事件标记为关键事件，则建议您设置 conversion_value。 *如果设置 conversion_value，则必须提供 currency。

参数

名称	类型	是否必须提供	示例值	说明
disqualified_lead_reason	string	否	不打算购买	潜在客户被标记为不符合条件的原因。

示例

以下示例展示了如何使用 Data Manager API 发送 disqualify_lead 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "disqualify_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "additionalEventParameters": [
        {
          "parameterName": "disqualified_lead_reason",
          "value": "Not looking to buy"
        }
      ]
    }
  ]
}

Measurement Protocol

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": "disqualify_lead",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "disqualified_lead_reason": "Not looking to buy"
      }
    }]
  })
});

generate_lead

此事件将衡量带来潜在客户的情况（例如，通过表单）。请记录此事件，以了解营销广告系列的效果，以及向潜在客户进行再营销后吸引了多少客户重新与您的商家互动。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	相应活动的 conversion_value 所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 *为了生成有意义的报告，通常必须提供 conversion_value。如果您将事件标记为关键事件，则建议您设置 conversion_value。 *如果设置 conversion_value，则必须提供 currency。

参数

名称	类型	是否必须提供	示例值	说明
lead_source	string	否	贸易展会	潜在客户的来源。

示例

以下示例展示了如何使用 Data Manager API 发送 generate_lead 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "generate_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "additionalEventParameters": [
        {
          "parameterName": "lead_source",
          "value": "Trade show"
        }
      ]
    }
  ]
}

Measurement Protocol

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": 30.03,
        "lead_source": "Trade show"
      }
    }]
  })
});

qualify_lead

此事件衡量的是用户被标记为符合成为符合条件的潜在客户的条件的情况。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	相应活动的 conversion_value 所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 *为了生成有意义的报告，通常必须提供 conversion_value。如果您将事件标记为关键事件，则建议您设置 conversion_value。 *如果设置 conversion_value，则必须提供 currency。

示例

以下示例展示了如何使用 Data Manager API 发送 qualify_lead 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "qualify_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03
    }
  ]
}

Measurement Protocol

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": "qualify_lead",
      "params": {
        "currency": "USD",
        "value": 30.03
      }
    }]
  })
});

working_lead

此事件衡量的是用户联系代表或代表联系用户这一操作。

事件字段

名称	类型	是否必须提供	示例值	说明
currency	string	是*	美元	相应活动的 conversion_value 所用的币种（采用由 3 个字母表示的 ISO 4217 格式）。 * 如果设置 conversion_value，则必须提供 currency，这样才能准确计算收入指标。
conversion_value	number	是*	30.03	与事件相关的货币价值。 *为了生成有意义的报告，通常必须提供 conversion_value。如果您将事件标记为关键事件，则建议您设置 conversion_value。 *如果设置 conversion_value，则必须提供 currency。

参数

名称	类型	是否必须提供	示例值	说明
lead_status	string	否	已开始的对话	潜在客户的状态。

示例

以下示例展示了如何使用 Data Manager API 发送 working_lead 事件。如果您要从 Measurement Protocol 升级，请使用相应标签页将请求迁移到 Data Manager API。

Data Manager API

{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "working_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "additionalEventParameters": [
        {
          "parameterName": "lead_status",
          "value": "Started conversations"
        }
      ]
    }
  ]
}

Measurement Protocol

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": "working_lead",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "lead_status": "Started conversations"
      }
    }]
  })
});