Analytics.screen

功能说明

在页面进入时记录分析日志。进入页面时调用的话 屏幕 类型的日志会发送。

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

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

类型

Analytics.screen(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";

// 在页面进入时调用一次。
Analytics.screen({ entry_point: "home" });