Flutter - Advanced

1. 계정 ID 설정

SDK 인스턴스는 랜덤의 UUID로 유저의 게스트ID로서 부여합니다. 게스트ID는 유저가 로그인하기 전의 유저 식별 ID로 사용됩니다. 단, 사전에 주의해야 할 것은, 계정 ID는 유저가 재설치할 때 변경됩니다.

1.1 게스트 ID 설정

::: 팁

일반적으로, 게스트 ID를 수동 설정할 필요는 없으며, 유저 식별 규칙을 확인한 후, 게스트 ID 설정을 진행해주세요.

:::

독자적으로 게스트 ID 관리 체계가 있는 경우는, identify를 호출하여, 게스트 ID를 설정해주세요

//set distinct ID as Thinker
TDAnalytics.identify("Thinker");

현재 게스트 ID를 얻고 싶은 경우는, GetDistinctId를 호출하여 얻을 수 있습니다.

//return distinct ID
String distinctId = await TDAnalytics.getDistinctId();

1.2 계정 ID 설정

유저 로그인 시, Login을 호출하여 계정 ID를 설정할 수 있습니다. TE는 계정 ID를 유저 신분의 식별 ID로 사용되고 있습니다. 한 번 설정된 계정 ID는 Logout을 호출하기 전까지 저장됩니다. Login을 여러 번 호출한 경우는, 그 앞의 계정 ID를 덮어씁니다.

// 유저의 로그인 고유 식별자, 데이터 트래킹에서의 #account_id에 해당합니다. #Account_id는 현재 TE입니다
TDAnalytics.login("TE");

이 방법으로는 로그인 이벤트로 전송되지 않습니다.

1.3 계정 ID 삭제

유저가 로그아웃 이벤트를 수행하기 전에, Logout을 호출하여 계정 ID를 삭제할 수 있습니다. 다시 Login을 호출하기 전까지 게스트 ID는 유저 신분의 식별 ID로 사용됩니다

TDAnalytics.logout();

유저가 계정을 삭제할 때, Logout을 호출하도록 설정해주세요.

로그아웃 이벤트로 전송되지 않습니다.

2. 이벤트 전송

SDK가 초기화 설정을 완료한 후, 데이터 트래킹 정책에 따라 트래킹 코드를 구현하고 유저의 행동 데이터를 수집할 수 있습니다. 일반적으로, 기본 이벤트 전송은 충분히 수집 가능하며, 실제 업무 상황에 따라 처음이나 업데이트 가능 등의 특수 이벤트를 수집할 수도 있습니다.

2.1 기본 이벤트

track을 호출하여, 데이터 플랜에 따라 이벤트의 속성을 설정한 위에, 데이터 전송할 수 있습니다.

예: 아이템 구매

TDAnalytics.track('pruoduct_buy', properties: <String, dynamic>{'product_name': '아이템명'});

2.2 첫 이벤트

첫 이벤트는 어떤 디바이스 혹은 다른 분석 대상의 ID마다, 처음 한 번만 기록되는 이벤트입니다.

예를 들어: 어떤 디바이스의 활성화 이벤트는 그 디바이스를 최초로 사용할 때 유용합니다.

var properties = {'key': 'value'};
var firstModel = TrackFirstEventModel('device_activation', '', properties);
TDAnalytics.trackEventModel(firstModel);

디바이스 외에 첫 이벤트를 판단하고 싶다면, first_check_id를 사용하여 첫 이벤트를 정의해주세요.

//set the user ID as the first_check_id of the first event to track the first initialization event of the user.
var properties = {'key': 'value'};
var firstModel = TrackFirstEventModel('account_activation', 'TE', properties);
TDAnalytics.trackEventModel(firstModel);

주의: 서버 측에서 첫 번째 이벤트인지 확인하기 위해, 첫 이벤트는 기본적으로 1시간 지연하여 저장됩니다.

2.3 갱신 가능 이벤트

일반적으로 이벤트는 데이터가 저장되면 갱신할 수 없게 되지만, 데이터 갱신을 하고 싶을 경우에는 갱신 가능 이벤트를 사용해 주세요. 갱신 가능 이벤트는 식별 이벤트의 ID가 필요하며, 생성 시에는 속성에 입력해 주세요. TE시스템은 이벤트 이름과 이벤트 ID를 식별 대상으로 하여 갱신 데이터를 확정합니다.

//The event property status is 3 after reporting, with the price being 100
var properties = {
  'status': 3,
  'price': 100
};
var updateModel = TrackUpdateEventModel('UPDATABLE_EVENT', 'test_event_id', properties);
TDAnalytics.trackEventModel(updateModel);

//The event property status is 5 after reporting, with the price remaining the same
var properties_new = {
  'status': 5
};
var updateModel_new = TrackUpdateEventModel('UPDATABLE_EVENT', 'test_event_id', properties_new);
TDAnalytics.trackEventModel(updateModel_new);

2.4 덮어쓰기 이벤트

덮어쓰기 이벤트는 갱신 가능 이벤트와 비슷하며, 덮어쓰기 이벤트는 과거 데이터를 최신 데이터로 덮어쓰기 때문에 이전 데이터를 삭제하고 새로운 데이터를 저장하는 것처럼 보입니다. TE 시스템은 이벤트 이름과 이벤트 ID를 식별 대상으로 하여 갱신 데이터를 확정합니다.

// The event property status is 3 after reporting, with the price being 100
var properties = {
    'status': 3,
    'price': 100
};
var overwriteModel = TrackOverwriteEventModel('OVERWRITABLE_EVENT', 'test_event_id', properties);
TDAnalytics.trackEventModel(overwriteModel);

// The event property status is 5 after reporting, with the price deleted
var properties_new = {
    'status': 5
};
var overwriteModel_new = TrackOverwriteEventModel('OVERWRITABLE_EVENT', 'test_event_id', properties_new);
TDAnalytics.trackEventModel(overwriteModel_new);

2.5 공통 이벤트 속성

공통 이벤트 속성은 모든 이벤트 전송 시 함께 포함되는 속성입니다. 속성의 업데이트 빈도에 따라, 공통 이벤트 속성은 정적 공통 이벤트 속성과 동적 공통 이벤트 속성으로 나뉩니다.

실제 업무 요구에 따라, 공통 이벤트 속성을 설정해주세요; 일반적으로는 이벤트 전송 전에 공통 이벤트 속성을 설정하는 것이 권장됩니다.

같은 이벤트에서, 공통 이벤트 속성, 이벤트 커스텀 속성, 프리셋 속성의 Key가 같은 경우, 다음의 우선 순위로 값이 설정됩니다. 커스텀 속성 > 동적 공통 이벤트 속성 > 정적 공통 이벤트 속성 > 프리셋 속성

2.5.1 정적 공통 속성

중요한 속성에 대해: 사용자의 채널, 닉네임, ID 등 모든 이벤트에 포함시키고 싶은 경우, setSuperProperties를 사용하여 정적 공통 이벤트 속성을 설정해 주세요.

Map<String, dynamic> superProperties = {
  'vip_level': 2
};
TDAnalytics.setSuperProperties(superProperties);

정적 공통 이벤트 속성은 캐시에 저장되므로 앱을 시작할 때마다 호출할 필요가 없습니다. 해당 속성이 이미 존재하는 경우 원래 값이 덮어쓰여집니다. 해당 속성이 이전에 존재하지 않았던 경우, 새로운 속성이 생성됩니다. 속성 설정 이외에도, 다른 API를 사용하여 정적 공통 이벤트 속성을 설정할 수 있습니다.

//특정 슈퍼 속성을 지움
TDAnalytics.unsetSuperProperty('SUPER_LIST');
//특정 슈퍼 속성들을 모두 지움
TDAnalytics.clearSuperProperties();
//모든 특정 슈퍼 속성을 얻음
TDAnalytics.getSuperProperties();

2.5.2 동적 퍼블릭 이벤트 속성

동적 공통 이벤트 속성은 높은 빈도로 변경되며 모든 이벤트에 속하는 속성입니다. (예: 코인의 수량) setDynamicSuperPropertiesTracker를 사용하여 동적 공통 이벤트 속성을 설정한 후, SDK는 이벤트 수집 시 자동으로 getDynamicSuperProperties의 속성을 가져와 이벤트에 전송됩니다.

TDAnalytics.setDynamicSuperProperties((){
  return <String, dynamic> {
    'DYNAMIC_DATE': DateTime.now().toUtc(),
  };
});

동적 공통 이벤트 속성은 자동 수집 이벤트에 대응되지 않습니다.

2.6 이벤트 시간 기록

이벤트의 경과 시간을 기록하고 싶은 경우, timeEvent를 호출하여 계산할 수 있습니다. 계산하고자 하는 이벤트 이름을 설정하고, 해당 이벤트가 전송될 때 자동으로 이벤트 속성에 #duration 속성이 추가되어 경과 시간이 기록됩니다. 단위는 초입니다.

주의: 하나의 이벤트에 대해서는 하나의 시간 경과 계산 작업만 설정할 수 있습니다.

//The following instance has recorded the time the user spent on a certain product page
//The user enters the product page and starts the timing
TDAnalytics.timeEvent('stay_shop');
// do some thing...
//the timing would end when the user leaves the product page. "stay_shop" event would carry#duration, a property representing event duration. 
TDAnalytics.track("stay_shop");

3. 유저 속성

TE에서 유저 속성을 설정하는 API는 userSet, userSetOnce, userAdd, userUnset, userDelete, userAppend, userUniqAppend입니다.

3.1 userSet

일반적으로 유저 속성 설정은 userSet을 사용하여 설정할 수 있습니다. 이 호출을 사용하면 원래 속성 값이 변경됩니다. 원래 속성 값이 없는 경우 새로 만들어집니다. 데이터 타입은 저장된 데이터 타입과 일치합니다. 다음은 예시입니다:

TDAnalytics.userSet(<String, dynamic>{'user_name': 'TA'});  //the username now is TA
TDAnalytics.userSet(<String, dynamic>{'user_name': 'TE'});  //the username now is TE

속성의 데이터 형식은 이벤트 속성과 일치해야 합니다.

3.2 userSetOnce

만약 유저 속성을 한 번 설정한 후 변경할 필요가 없는 경우, userSetOnce를 사용하여 설정할 수 있습니다. 이 호출은 값이 있을 때 변경하지 않습니다.

//first_payment_time is 2018-01-01 01:23:45.678
TDAnalytics.userSetOnce(<String, dynamic>{'first_payment_time': '2018-01-01 01:23:45.678'});
//first_payment_time is still 2018-01-01 01:23:45.678
TDAnalytics.userSetOnce(<String, dynamic>{'first_payment_time': '2018-12-31 01:23:45.678'});

3.3 userAdd

만약 숫자형 속성에 대해 누적 계산을 하고 싶은 경우, userAdd를 사용하여 설정할 수 있습니다. 이 호출은 값이 없을 경우 자동으로 0을 부여한 후 계산합니다. "-" 값으로 계산하는 것도 가능합니다. 예: 누적 결제 금액

//in this case, the total_revenue is 30
TDAnalytics.userAdd(<String, num>{ 'total_revenue': 30});
//in this case, the total_revenue is 678
TDAnalytics.userAdd(<String, num>{ 'total_revenue': 648});

3.4 userUnset

유저 속성을 리셋하고 싶다면, userUnset을 사용하여 설정할 수 있습니다. 이 속성이 클러스터 내에서 생성되지 않았다면, userUnset은 그 속성을 생성하지 않습니다.

TDAnalytics.userUnset('USER_INT');

전송되는 값은 삭제된 속성의 key값이 됩니다.

3.5 userDelete

유저를 삭제하고 싶은 경우 userDelete를 사용하여 설정할 수 있습니다. 삭제하면 해당 유저의 유저 속성은 조회할 수 없게 되지만, 해당 유저가 생성한 이벤트 데이터는 조회할 수 있습니다.

TDAnalytics.userDelete();

3.6 userAppend

userAppend을 사용하여 List 타입의 유저 속성을 추가할 수 있습니다.

TDAnalytics.userAppend(<String, List>{
  'USER_LIST': ['apple','ball'],
});

3.7 userUniqAppend

userUniqAppend을 이용하여 Array (List)형의 사용자 데이터에 유니크 요소를 추가할 수 있습니다. userUniqAppend 인터페이스는 추가된 유저 속성을 중복 제외되며, userAppend는 중복 제외하지 않으므로, 유저 속성은 중복될 가능성이 있습니다.

//이 경우, 사용자 목록의 속성 값은 ["apple"，"ball"]입니다
TDAnalytics.userAppend(<String, List>{ 'user_list': ['apple','ball']});
//in this case, the property value of user_list is ["apple","apple","ball","cube"]
TDAnalytics.userAppend(<String, List>{ 'user_list': ['apple','cube']});
//in this case, the 속성 값 of 사용자 목록 is ["apple"，"ball","cube"]
TDAnalytics.useUniqrAppend(<String, List>{ 'user_list': ['apple','cube']});

4. 암호화 기능

SDK는 암호화 기능을 지원하며, 클라이언트는 AES + RSA로 데이터를 암호화 처리한 후 서버 측에서 암호를 해독할 수 있습니다. 클라이언트와 서버 양쪽 작업이 있으며, 자세한 내용은 TD 스태프에게 문의하십시오. SDK 초기 설정 시, 데이터 전송 암호화 기능을 활성화할 수 있습니다.

var sKey = TASecretKey();
//버전 번호 및 공개 키와 같은 키 정보 구성
sKey.publicKey =
    "xxx";
sKey.version = 1;
sKey.symmetricEncryption = "AES";
sKey.asymmetricEncryption = "RSA";
ThinkingAnalyticsAPI.getInstance(
    'APP_ID',
    'server_url',
    enableEncrypt: true,
    secretKey: sKey);

5. 기타 기능

5.1 디바이스ID를 획득

SDK가 초기 설정을 완료하면, 자동으로 디바이스ID가 생성되어 로컬 캐시에 저장됩니다. 동일한 APP/game 내에서는, 한 대의 디바이스의 디바이스ID는 변하지 않으며 getDeviceId를 사용하여 디바이스ID의 획득이 가능합니다.

String deviceId = await TDAnalytics.getDeviceId();

5.2 시간대

SDK는 기본적으로 본 디바이스의 시간을 이벤트 발생 시간으로 사용합니다. 제품이 여러 시간대에서 출시된 경우, timeZone을 함께 전송하여 시간대를 설정할 수 있습니다. timeZone은 시간대 문자열로, UTC, Asia/Shanghai 등이 됩니다.

ThinkingAnalyticsAPI.getInstance('APP_ID','server_url',timeZone:'UTC');

시간대를 설정하면, 디바이스 본체의 시간대 정보가 무시됩니다. 디바이스 본체의 시간대를 유지하고 싶은 경우는, 이벤트에 속성 설정을 해두세요.

5.3 시간 교정

SDK는 기본적으로 본 디바이스의 시간을 이벤트 발생 시간으로 사용하지만, 유저가 수동으로 디바이스의 시간을 수정하게 되면 수정 후의 시간으로 전송되어 분석에 문제가 발생할 수 있습니다. 시간 교정을 사용하여, 이벤트 발생 시간의 정확성을 유지할 수 있습니다. TE 시스템은 timestamp와 NTP의 두 가지 시간 교정 방법을 지원합니다.

• 서버 측에서 동기화된 현재의 timestamp를 사용하여 SDK의 시간을 교정할 수 있습니다. 이후, 모든 시간 미지정 호출(이벤트 데이터 및 사용자 속성 설정)은 교정 후의 시간을 발생 시간으로 사용됩니다.

// 1585633785954는 현재 유닉스 타임 스탬프로, 단위는 도쿄 밀리초; 해당 한국 시간은 2020-03-31 13:49:45입니다
ThinkingAnalyticsAPI.calibrateTime(1585633785954);

• NTP 서버 주소 설정으로 SDK는 NTP 서비스의 현지 시간을 획득하여 사용합니다. 기본적으로 시간 초과(3초)하여 획득할 수 없는 경우는 로컬 시간으로 전송됩니다.

// Apple Inc의 NTP 서비스를 이용한 시간 교정 사용
ThinkingAnalyticsAPI.calibrateTimeWithNtp("time.apple.com");

1. NTP 서비스로 시간 교정을 수행할 때 불안정성이 있으므로, timestamp를 권장합니다.
2. NTP 서비스를 사용할 경우, 네트워크 환경이 좋고, 유저 디바이스가 서버 시간을 빠르게 획득할 수 있도록 유지해야 합니다.