브라우저 SDK 1.0에서 2.0으로 마이그레이션

Amplitude 브라우저 SDK 2.0(@amplitude/analytics-browser)은 자동 캡처, 향상된 마케팅 어트리뷰션 추적, 간소화된 인터페이스, 더 가벼운 패키지를 특징으로 합니다.

브라우저 SDK 2.0은 Amplitude 세션 리플레이와 호환됩니다.

용어

• @amplitude/analytics-browser@1: 브라우저 SDK 1.0
• @amplitude/analytics-browser@2: 브라우저 SDK 2.0

종속성

{
  "dependencies": {
-   "@amplitude/analytics-browser": "^1"
+   "@amplitude/analytics-browser": "^2"
  }
}

자동 캡처

브라우저 SDK 2.10.0부터 Amplitude는 기본적으로 자동 캡처를 활성화합니다. 자동 캡처는 Amplitude가 사용자를 대신하여 수행하는 암시적 추적으로, 페이지 조회수, 세션, 파일 다운로드, 양식 및 요소 상호작용, 마케팅 기여를 포함합니다.

기본 추적을 해제하려면 options.autocapture을 false로 설정하십시오.

amplitude.init(API_KEY, undefined, {
  autocapture: false,
});

또한 Amplitude가 추적할 이벤트를 선택할 수도 있습니다. 예를 들어 마케팅 속성 및 페이지 조회수에 대해서만 기본 추적을 활성화하려면 아래 코드를 사용하십시오.

amplitude.init(API_KEY, undefined, {
  autocapture: {
    attribution: true,
    pageViews: true,
    sessions: false,
    fileDownload: false,
    formInteractions: false,
    elementInteractions: false,
  },
});

마케팅 속성 추적

브라우저 SDK 2.0부터 Amplitude는 브라우저 SDK와 마케팅 분석 SDK를 제품 및 마케팅 분석 사용 사례 모두를 위한 단일 솔루션으로 통합합니다.

마케팅 속성 추적은 추천자와 동일한 루트 도메인의 모든 하위 도메인을 제외합니다. 기본적으로 Amplitude는 한 하위 도메인에서 다른 하위 도메인으로의 트래픽을 추적하지 않습니다(예: experiment.amplitude.com에서 analytics.amplitude.com로).

기본적으로 브라우저 SDK 1.0은 다른 하위 도메인을 참조자로 추적합니다. 이 동작을 유지하려면 아래 코드를 참조하십시오.

options.attribution.trackNewCampaigns 사용 중단

이 옵션은 Amplitude에서 구성 불가능한 기본 동작으로 채택했기 때문에 더 이상 지원되지 않습니다. Amplitude는 UTM, 리퍼러, 클릭 ID 매개변수를 포함한 캠페인 매개변수의 변경사항을 추적합니다.

options.attribution.trackPageViews 사용 중단

이 옵션은 더 이상 존재하지 않지만 페이지 보기 옵션을 사용하여 비슷하게 Amplitude를 구성할 수 있습니다.

amplitude.init(API_KEY, undefined, {
- attribution: {
-   trackPageViews: true,
- },
+ defaultTracking: {
+   pageViews: {
+     trackOn: 'attribution',
+   },
+ },
});

쿠키 옵션

브라우저 SDK 2.0부터 Amplitude는 쿠키 사용을 관리하는 옵션을 단순화했습니다. 기본적으로 Amplitude는 사용자 신원을 브라우저 쿠키에 저장합니다.

대체 스토리지 API 사용

amplitude.init(API_KEY, undefined, {
  disableCookies: true,
  identityStorage: "localStorage",
});

사용자 ID 지속성 비활성화

import { MemoryStorage } from "@amplitude/analytics-core";
amplitude.init(API_KEY, undefined, {
  cookieStorageProvider: new MemoryStorage(),
  identityStorage: "none",
});

쿠키 옵션 구성

쿠키 사용을 관리하는 옵션은 이제 더 찾기 쉬운 인터페이스를 위해 options.cookieOptions 아래에 중첩됩니다.

amplitude.init(API_KEY, undefined, {
  cookieExpiration: 365,
  cookieSameSite: "Lax",
  cookieSecure: false,
  cookieUpgrade: true,
  domain: "",
  cookieOptions: {
    expiration: 365,
    sameSite: "Lax",
    secure: false,
    upgrade: true,
    domain: "",
  },
});

사용자 에이전트 클라이언트 측 구문 분석을 사용하지 않음

브라우저 SDK 2.0부터 Amplitude는 사용자 에이전트 속성 보강을 클라이언트 측에서 서버 측으로 이동했습니다. 향상된 사용자 속성에는 os_name, os_version, device_model 및 이 device_manufacturer포함됩니다. 새로운 보강 전략은 더 정확한 결과를 산출하지만 브라우저 SDK 1.0과 약간 다른 결과를 산출하며 이러한 속성을 쿼리하는 기존 분석 차트에 영향을 줄 수 있습니다. 브라우저 SDK 1.0 동작을 유지하려면 @amplitude/plugin-user-agent-enrichment-browser를 설치하여 클라이언트측에서 이러한 사용자 속성을 보강하십시오. 자세한 내용은 NPM의 plugin-user-agent-enrichment-browser 패키지를 참조하십시오.

열거 없음

Amplitude는 더 이상 열거형 TransportType, ServerZone, PluginType을(를) 요구하지 않으며, 해당 리터럴 값을 허용합니다.

초기화 시 전송 공급자를 설정합니다.

import * as amplitude from "@amplitude/analytics-browser";
amplitude.init(API_KEY, USER_ID, {
  transport: amplitude.Types.TransportType.Fetch,
  transport: "fetch",
});

setTransport()를 사용하여 전송 공급자를 설정합니다.

import * as amplitude from "@amplitude/analytics-browser";
amplitude.setTransport(amplitude.Types.TransportProvider.Fetch);
amplitude.setTransport("fetch");

초기화 시 서버 영역을 설정합니다.

import * as amplitude from "@amplitude/analytics-browser";
amplitude.init(API_KEY, USER_ID, {
  serverZone: amplitude.Types.ServerZone.US,
  serverZone: "US",
});

단순화된 플러그인 인터페이스

Amplitude는 사용자 고유의 플러그인을 쉽게 만들 수 있도록 해줍니다. 따라서 더 빠른 제작을 위해 필요한 속성은 더 적습니다.

plugin.name [선택 사항]

이름 필드는 삭제할 플러그인을 참조할 수 있게 해주는 선택적 속성입니다. 이름을 제공하지 않으면 플러그인을 추가할 때 Amplitude는 임의의 이름을 지정합니다. 플러그인을 삭제할 계획이 없다면 이름 지정은 건너뛰어도 됩니다.

plugin.type [선택 사항]

유형 필드는 사용자가 만들 플러그인의 유형을 정의하는 선택적 속성입니다. 두 유형을 구별하려면 아래 execute() 함수를 참조하십시오. 유형을 정의하지 않은 경우 플러그인은 기본적으로 보강 유형을 사용합니다.

plugin.setup() [선택 사항]

설정 함수는 플러그인을 추가할 때 또는 첫 번째 초기화 시에 Amplitude가 호출하는 선택적 메서드입니다. 이 함수는 두 개의 매개변수를 받아들입니다.

1. Amplitude 구성입니다.
2. Amplitude 인스턴스입니다.

설정 함수는 Amplitude 구성 또는 인스턴스에 종속된 설정 작업 및 태스크에 유용합니다. 예를 들어 변수에 기준 값을 할당하고 이벤트 리스너를 설정하는 작업이 있습니다.

plugin.execute() enrichment 유형의 경우 는 [선택 사항입니다.]

인리치먼트 플러그인의 경우, execute 함수는 Amplitude가 각 이벤트에 대해 호출하는 선택적 메서드입니다. 이 함수는 새로운 이벤트를 반환해야 합니다. 그렇지 않으면 Amplitude는 전달된 이벤트를 대기열에서 삭제합니다. execute 함수는 이벤트에서 속성을 추가 또는 제거하거나, 이벤트를 필터링하거나, 추적되는 각 이벤트에 대해 작업을 수행해야 할 때 유용합니다.

목적지 플러그인의 경우, execute 함수는 Amplitude가 각 이벤트에 대해 호출하는 필수 메서드입니다. 이 함수는 event(BaseEvent), code(숫자) 및 message(문자열) 키를 가진 응답 객체를 반환해야 합니다. execute 함수는 이벤트를 타사 엔드포인트로 전송하는 데 유용합니다.

plugin.teardown() [선택 사항]

teardown 함수는 Amplitude가 다시 초기화될 때 Amplitude가 호출하는 선택적 메서드입니다. teardown 함수는 setup 또는 execute 메서드가 생성한 불필요한 영구 상태를 재설정하는 데 유용합니다. 예를 들어 이벤트 리스너 및 변이 관찰자를 제거하는 것이 있습니다.

웹 어트리뷰션 v2와 웹 어트리뷰션 v1

웹 어트리뷰션 V2:

• 기본적으로 활성화되어 있습니다.
• 세션 컨텍스트(신규 또는 기존)에 관계없이 새 캠페인을 통해 초기화 시 기여를 추적합니다. 구성할 수 없습니다.
• 모든 초기 터치 기여 속성의 기본값은 "EMPTY"입니다. config.initialEmptyValue를 사용하여 구성 가능합니다.
• 새로운 캠페인에 대해 새로운 세션을 시작하지 않습니다. config.resetSessionOnNewCampaign = true를 사용하여 구성 가능합니다.
• 광고 클릭 ID를 추적합니다.

웹 어트리뷰션 V1:

• 기본적으로 활성화되어 있습니다.
• 새 세션과 함께 초기화 시 어트리뷰션을 추적합니다. 구성할 수 없습니다.
• 새로운 캠페인을 시작할 때 초기화에 대한 어트리뷰션을 추적하지 않습니다. config.trackNewCampaigns를 사용하여 구성 가능합니다.
• 모든 초기 터치 기여 속성의 기본값은 "EMPTY"입니다. config.initialEmptyValue를 사용하여 구성 가능합니다.
• 새로운 캠페인에 대해 새로운 세션을 시작하지 않습니다. config.resetOnNewCampaign를 사용하여 구성 가능합니다.
• 광고 클릭 ID를 추적합니다.