Browser Unified SDK 참조
이 참조는 버전 1.1.43에 대해 확인된 @amplitude/unified의 모든 공개 내보내기와 initAll()로 전달할 수 있는 모든 옵션을 설명합니다. 이 버전은 브라우저 SDK 2.48.1(@amplitude/analytics-browser)을 번들로 제공하므로 모든 분석 메서드가 브라우저 SDK 2 참조에 설명된 대로 작동합니다. 버전 간 변경 사항은 @amplitude/unified변경 로그로 이동하십시오.
import * as amplitude from "@amplitude/unified";
최상위 함수는 기본 인스턴스에서 작동합니다. createInstance()의 각 인스턴스에는 동일한 메서드와 init()이 있습니다.
내보내기
| 내보내기 | 설명 |
|---|---|
initAll, experiment, sessionReplay, createInstance | Unified SDK 전용입니다. 이 페이지에 문서화되어 있습니다. |
track, logEvent, identify, groupIdentify, setGroup, revenue, flush, add, remove, setTransport, getUserId, setUserId, getDeviceId, setDeviceId, getIdentity, setIdentity, getSessionId, setSessionId, extendSession, reset, getOptOut, setOptOut | 브라우저 SDK 2 메서드. 브라우저 SDK 2 참조로 이동합니다. |
Identify, Revenue, Types | Browser SDK 2에서 다시 내보냈습니다. Identify, Revenue 및 Types로 이동합니다. |
UnifiedOptions, UnifiedSharedOptions, UnifiedClient | TypeScript 유형만 표시되며 런타임 값은 없습니다. UnifiedOptions 및 UnifiedClient로 이동합니다. |
최상위 모듈은 init()를 내보내지 않습니다. 대신 initAll()호출하십시오.
설정
initAll
분석을 초기화한 다음 세션 리플레이, 기능 실험, 가이드 및 설문조사를 추가합니다. 각 페이지 로드 시 인스턴스당 한 번씩 호출하십시오.
initAll(apiKey: string, unifiedOptions?: UnifiedOptions): Promise<void>
| 매개 변수 | 유형 | 설명 |
|---|---|---|
apiKey | string | Amplitude 프로젝트 API 키입니다. |
unifiedOptions | UnifiedOptions | 선택 사항입니다. UnifiedOptions로 이동합니다. |
initAll()는 AmplitudeReturn가 아닌 일반 Promise를 반환하므로 직접 await하십시오. 모든 제품의 설정이 완료된 후 해결됩니다. 해결되기 전에 수행된 호출은 대기열에서 대기하고 이후 순서대로 실행됩니다.
이전 호출이 아직 보류 중인 상태에서 수행된 호출은 동일한 Promise를 반환합니다initAll(). 이전 호출이 해결된 후 수행된 호출은 전체 설정을 다시 실행합니다initAll(). repeat 호출은 분석을 다시 초기화하고, 페이지 뷰 추적이 켜져 있는 경우 다른 페이지 보기를 추적한 다음 세션 리플레이를 다시 시작합니다. 또한 Plugin with name @amplitude/unified-library-plugin already exists, skipping registration를 기록합니다.
await amplitude.initAll("YOUR_API_KEY", {
serverZone: "EU",
sessionReplay: { sampleRate: 0.1 },
});
실험
기능 실험 클라이언트를 반환하거나 추가하기 undefined전에 initAll()반환합니다.
experiment(): IExperimentClient | undefined
클라이언트는 실험 JavaScript SDK 클라이언트입니다. 클라이언트는 initAll()동안 플래그를 가져오지 않습니다.fetch() 전에 variant()을 호출하세요.
const experiment = amplitude.experiment();
await experiment?.fetch();
const variant = experiment?.variant("checkout-redesign");
sessionReplay
세션 리플레이 클라이언트를 반환하거나, 전에 initAll() 추가합니다.undefined
sessionReplay(): AmplitudeSessionReplay | undefined
| 메서드 | 설명 |
|---|---|
start(): AmplitudeReturn<void> | 녹화를 시작하거나 재개합니다. 녹화는 여전히 샘플링 속도, 타겟팅, 옵트아웃 및 원격 캡처 설정을 준수합니다. |
stop(): void | SDK를 분리하지 않고 녹화를 일시 중지합니다. 재개하려면 start()를 호출하십시오. |
shutdown(): void | 녹화를 중지하고 이벤트 리스너를 제거합니다. |
flush(useRetry: boolean): Promise<void> | 녹화된 데이터를 지금 업로드합니다. 실패한 업로드를 재시도하려면 truePass를 전달하십시오. |
getSessionReplayProperties(): { [key: string]: boolean | string | null } | 세션 리플레이가 세션을 기록하는 동안 { "[Amplitude] Session Replay ID": "..." } 반환하며, 그렇지 않으면 {} 반환합니다. |
getSessionId(): string | number | undefined | 세션 리플레이가 기록하는 대상 세션 ID를 반환합니다. |
setSessionId(sessionId: string | number, deviceId?: string): AmplitudeReturn<void> | 세션 리플레이가 기록하는 대상 세션 ID를 설정합니다. |
init, evaluateTargetingAndCapture | 플러그인은 설정 중에 호출합니다. 직접 호출하지 마십시오. |
const replay = amplitude.sessionReplay();
replay?.stop();
레코딩 옵션을 보려면 세션 리플레이 플러그인으로 이동하십시오.
createInstance
자체적인 분석 구성, ID, 대기열 및 플러그인을 사용하여 독립적인 인스턴스를 생성합니다.
createInstance(): UnifiedClient
const marketing = amplitude.createInstance();
await marketing.initAll("MARKETING_API_KEY", { instanceName: "marketing" });
marketing.track("Signup Completed");
가이드 및 설문조사는 페이지당 한 번씩 초기화됩니다. 첫 번째 인스턴스 initAll()후에 호출하는 인스턴스는 해당 engagement옵션을 무시합니다.
UnifiedClient
기본 인스턴스가 구현하고 createInstance() 반환하는 인터페이스입니다. 이 멤버들을 포함하여 브라우저 SDK 2BrowserClient를 확장합니다.
| 회원 | 설명 |
|---|---|
initAll | initAll을 참조하십시오. |
experiment | 실험을 참조하십시오. |
sessionReplay | sessionReplay를 참조하십시오. |
init | 브라우저 SDK 2init()와 마찬가지로 분석 기능만 초기화합니다. createInstance()의 인스턴스에서 사용할 수 있으며 최상위 내보내기로는 사용할 수 없습니다. |
UnifiedOptions
initAll()에 전달하는 옵션 객체입니다. 모든 옵션은 선택 사항입니다.
공유 옵션
initAll()는 이러한 옵션을 모든 제품에 전달하고 각 제품 블록의 동일한 이름의 옵션에 병합합니다. 설정되지 않은 공유 옵션은 여전히 같은 이름의 제품 옵션을 undefined로 덮어씁니다.
| 옵션 | 유형 | 기본값 | 설명 |
|---|---|---|---|
serverZone | "US" 또는 "EU" | "US" | 모든 제품의 데이터 센터입니다. 이곳에 설정하세요. analytics 에 설정하지 마세요. |
instanceName | string | "$default_instance" | 모든 제품의 인스턴스 이름입니다. 각 인스턴스에 대해 고유한 이름을 사용하십시오createInstance(). |
제품 옵션
| 옵션 | 유형 | 기본값 | 설명 |
|---|---|---|---|
analytics | BrowserOptions | {} | Browser SDK 2 옵션. 구성 옵션으로 이동합니다. |
sessionReplay | SessionReplayOptions, 공유 옵션 없이 | {} | 세션 리플레이 플러그인 옵션입니다. 0 기본값은 sampleRate로 이며, 이는 아무것도 기록하지 않습니다. 세션 리플레이 플러그인으로 이동합니다. |
experiment | ExperimentPluginConfig, 공유 옵션 없이 | {} | 실험 JavaScript SDK 옵션, Plus deploymentKey. 실험 옵션으로 이동합니다. |
engagement | 공유 옵션 없이 가이드 및 설문조사InitOptions | {} | 가이드 및 설문조사 옵션, Plus skip. 참여 옵션으로 이동합니다. |
실험 옵션
| 옵션 | 유형 | 기본값 | 설명 |
|---|---|---|---|
deploymentKey | string | 프로젝트 API 키 | 실험 클라이언트 배포 키입니다. |
| 기타 옵션 | 변동 | 변동 | 모든 실험 JavaScript SDK 옵션입니다. 버전 1.1.43에는 베타 릴리즈 @amplitude/plugin-experiment-browser1.0.0-beta.51이 포함되어 있습니다. |
참여 옵션
| 옵션 | 유형 | 기본값 | 설명 |
|---|---|---|---|
skip | boolean | false | true인 경우, 가이드 및 설문조사는 아무 것도 다운로드하지 않으며, 요청을 수행하지 않으며, 스토리지에 아무 것도 기록하지 않습니다. @amplitude/unified1.1.11 이상이 필요합니다. |
| 기타 옵션 | 변동 | 변동 | 모든 가이드 및 설문조사 옵션. |
이 내용이 도움이 되었나요?
For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.