Analytics.screen

기능 설명

화면 진입 시점의 분석 로그를 남겨요. 페이지에 진입했을 때 호출하면 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" });