传输用户参数

重要

使用 JavaScript API 需要了解 HTML 和 JavaScript。如果您不了解这些语言，请联系您的网站开发人员或站长。

大多数会话数据由 Yandex Metrica 计数器自动收集。您可以通过会话参数发送您自己的数据来进行补充。但是，您可能会发现有关用户本身的信息比会话统计数据更有用。

Yandex Metrica 允许您发送任何自定义数据，这些数据称为_用户参数_。对于用户参数，我们建议传输不会因会话而改变且不包含用户姓名等个人数据的用户特征。有关会话参数和用户参数之间的区别的更多信息，请参阅处理和存储数据。

如果您希望传递的参数反映在报表中，Yandex Metrica 应该将它们链接到网站用户。为此，使用以下特殊 ID：ClientID 和 UserID。参数会链接到数据发送到 Yandex Metrica 之前 90 天内访问过该网站的用户的会话。

备注

当传输指定 ClientID 和 UserID 的用户参数时，由于 UserID 与 ClientID 的绑定方式，Yandex Metrica 报表中的用户总数可能与传递的 ID 数量不同。

报表会在几个小时内更新新信息。要查看统计数据，请使用User parameters report。您还可以使用此数据为 Yandex Direct 或 Yandex Audience 中的再营销列表创建细分（请参阅示例）。

备注

发送到 Yandex Metrica 的参数将在上次上传后存储两年。存储期结束后，报表将不再显示数据。

何时传输 ClientID

您不需要在报表中获取自己的 ID，我们建议在传输数据中使用 ClientID。

何时传输 UserID

例如，如果您的网站已有用户 ID 系统，并且您需要获取显示这些 ID 的报表，我们建议使用 UserID。

您可以通过多种方式将用户参数发送到 Yandex Metrica：

在网站会话期间。
随时使用 CSV 文件。

在网站会话期间传递数据

当您根据用户查看网站时收到的数据生成报表时，此方法非常有用。

用户参数通过 JavaScript API 传输到 Yandex Metrica。使用此方法发送的信息无法从 Yandex Metrica 中删除。

要在任何其他时间传输参数，请使用 userParams 方法。要在计数器初始化期间传输参数，请在 userParams 参数中指定数据。该信息作为 JavaScript 对象进行传输并按如下方式进行处理。

根据字段值的类型，按如下方式处理字段值：

object —— 为每个对象键创建一个新的树分支，并为每个值递归调用算法。
string —— 计算字符串中每个不同值出现的次数。
number —— 计算所有数字的总值和与平均值。
true、false 或 null —— 计算每个值出现的次数。

仅当在用户会话期间调用 userParams 方法才会将数据绑定到 ClientID。要获得更完整的统计数据，请等待大量数据传输到 Yandex Metrica。

示例

让我们看一下有两种类型客户的在线商店：“普通”和“VIP”。客户状态数据存储在网站自己的数据库中。用户登录网站后，会在每个页面的 Sign in 链接处看到自己的用户名。如果用户具有特殊身份，该身份会显示在用户名旁边：Jane / VIP。除了状态之外，您还可以传输存储在数据库中的用户 ID。

要向 Yandex Metrica 发送数据，请在网站的所有页面中添加调用 userParams 方法的代码。

为发送有关具有特殊状态的用户的数据，代码将如下所示：
随时

初始化计数器时
ym(XXXXXX, 'userParams', {
    vip_status: true,
    child: 1,
    child_age: 13,
    UserID: 12345
});
ym(XXXXXX, 'init', {
    clickmap: true,
    webvisor: true,
    userParams: {
        vip_status: true,
        child: 1,
        child_age: 13,
        UserID: 12345
    }
});
如果正在传输有关某个“普通”用户的信息，代码将如下所示：
随时

初始化计数器时
ym(XXXXXX, 'userParams', {
    vip_status: false,
    child: 1,
    child_age: 13,
    UserID: 12345
});
ym(XXXXXX, 'init', {
    clickmap: true,
    webvisor: true,
    userParams: {
        vip_status: false,
        child: 1,
        child_age: 13,
        UserID: 12345
    }
});
其中 XXXXXX 是您的计数器编号。

如果一个普通客户获得 VIP 身份，userParams 方法会在该用户下次登录您的网站时将新数据发送到 Yandex Metrica。此新状态将应用于该用户会话的整个历史记录，就好像客户始终是 VIP 一样。