Analytics.impression

功能说明

当元素被曝光时会记录分析日志。用于想在滚动下方的元素实际出现在屏幕上时记录曝光日志的情况。 event 类型的日志中 event_type: 'impression' 参数会一并记录。

log_name如果不指定，则会基于当前路径 <pathname>::impression 格式的名称会自动使用。除传入的值外，日志参数还会自动包含当前页面的查询字符串(search）、进入路径(referrer）、部署信息(deployment_id, deployment_timestamp）也会自动包含。

当前页面 URL https如果不是，就不会发送日志。

类型

Analytics.impression(params?: { log_name?: string } & { [key: string]: LogParam }): Promise<void> | undefined;

Params

// 除 log_name 之外的键也会作为日志参数一并记录。
type LogParam = string | number | boolean | null | undefined;

Response

当前页面 URL https如果不是，则不会发送日志。 undefined则返回。

示例代码

JavaScript

import { Analytics } from "@apps-in-toss/web-framework";

const banner = document.querySelector("#promo-banner");

const observer = new IntersectionObserver((entries) => {
  entries.forEach((entry) => {
    if (entry.isIntersecting) {
      Analytics.impression({ log_name: "banner", text: "促销横幅" });
      observer.unobserve(entry.target);
    }
  });
});

observer.observe(banner);