Unity - Advanced

1. 계정 ID 설정

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

1.1 게스트 ID 설정

::: 팁

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

만약 게스트 ID를 변경하고 싶다면, SDK를 초기 설정한 후 바로 호출하도록 설정해 주세요.

:::

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

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

현재의 게스트 ID를 얻고 싶다면, GetDistinctId를 호출하여 얻을 수 있습니다.

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

1.2 계정 ID 설정

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

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

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

1.3 계정 ID 삭제

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

TDAnalytics.Logout();

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

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

2. 이벤트 전송

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

2.1 기본 이벤트

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

예: 아이템 구매

Dictionary<string, object> properties = new Dictionary<string, object>(){
    {"product_name", "product name"}
};
TDAnalytics.Track("product_buy", properties);

2.2 첫 이벤트

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

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

Dictionary<string, object> properties = new Dictionary<string, object>(){
{"key", "value"}
};
TDAnalytics.Track(new TDFirstEvent("device_activation", properties));

디바이스 외에 첫 이벤트를 판단하고 싶다면, 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.
Dictionary<string, object> properties = new Dictionary<string, object>(){
    {"key", "value"}
};
TDFirstEvent firstEvent = new TDFirstEvent("account_activation", properties);
firstEvent.SetFirstCheckId("TE");
TDAnalytics.Track(firstEvent);

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

2.3 갱신 가능 이벤트

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

//보고 후 이벤트 속성 상태는 3이며, 가격은 100입니다
TDUpdatableEvent updatableEvent = new TDUpdatableEvent("UPDATABLE_EVENT", new Dictionary<string, object>{
{"status", 3},
{"price", 100}
}, "test_event_id");
TDAnalytics.Track(updatableEvent);

//보고 후 이벤트 속성 상태는 5이며, 가격은 동일합니다
TDUpdatableEvent updatableEvent_new = new TDUpdatableEvent("UPDATABLE_EVENT", new Dictionary<string, object>{
{"status", 5}
}, "test_event_id");
TDAnalytics.Track(updatableEvent_new);

2.4 덮어쓰기 이벤트

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

// 인스턴스: 갱신 가능 이벤트를 보고할 때 이벤트 이름이 OVERWRITE_EVENT라고 가정합니다
// 보고 후 이벤트 속성 상태는 3이며, 가격은 100입니다
TDOverWritableEvent overWritableEvent = new TDOverWritableEvent("OVERWRITABLE_EVENT", new Dictionary<string, object>{
{"status", 3},
{"price", 100}
}, "test_event_id");
TDAnalytics.Track(overWritableEvent);

// 보고 후 이벤트 속성 상태는 5이며, 가격은 삭제됩니다
TDOverWritableEvent overWritableEvent_new = new TDOverWritableEvent("OVERWRITABLE_EVENT", new Dictionary<string, object>{
{"status", 5}
}, "test_event_id");
TDAnalytics.Track(overWritableEvent_new);

2.5 공통 이벤트 속성

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

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

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

2.5.1 정적 공통 이벤트 속성

정적 공통 이벤트 속성은 낮은 빈도로 변경되며 모든 이벤트에 속하는 속성입니다: 예를 들어 VIP 레벨. setSuperProperties를 사용하여 정적 공통 이벤트 속성을 설정하면, SDK는 이벤트 수집 시 설정된 공통 이벤트 속성을 해당 이벤트의 속성으로 사용됩니다.

Dictionary<string, object> superProperties = new Dictionary<string, object>(){
    {"vip_level", 2}
};
TDAnalytics.SetSuperProperties(superProperties);

정적 공통 이벤트 속성은 캐시에 저장되므로, 앱을 시작할 때마다 호출할 필요가 없습니다. 만약 그 속성이 이미 존재한다면, 새로 설정하는 속성은 원래의 속성 값을 덮어씁니다; 만약 이전에 그 속성이 존재하지 않았다면, 새로운 속성으로 생성됩니다. 속성 설정 외에 API를 사용하여 정적 공통 이벤트 속성을 관리할 수 있습니다.

//clear super property named 'CHANNEL'
TDAnalytics.UnsetSuperProperty("CHANNEL");
//clear all super properties
TDAnalytics.ClearSuperProperties();
//get all super properties
TDAnalytics.GetSuperProperties();

2.5.2 동적 공통 이벤트 속성

동적 공통 이벤트 속성은 높은 빈도로 변경되며 모든 이벤트에 속하는 속성입니다. (예: 코인의 수량)

동적 공통 이벤트 속성을 설정하려면, 새로운 동적 공통 이벤트 속성 클래스 IDynamicSuperProperties를 생성하고, public Dictionary<string, object> GetDynamicSuperProperties() 메소드를 복사합니다. 이 메소드의 반환 값은 설정이 필요한 동적 공통 이벤트 속성입니다. SetDynamicSuperProperties를 호출하여 공통 속성 객체를 넣습니다.

// 1. 동적 속성 인터페이스 구현, 이것은 금화의 동적 변화를 설정하는 예입니다.
public class DynamicProp : IDynamicSuperProperties
{
    int coin = 0;
    public Dictionary<string, object> GetDynamicSuperProperties()
    {
         coin++;
         return new Dictionary<string, object>() {
             {"coin",coin}
         };
    }
}
// 2. 동적 속성 설정
TDAnalytics.SetDynamicSuperProperties(new DynamicProp());

2.6 이벤트 시간 기록

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

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

//다음 인스턴스는 유저가 특정 제품 페이지에서 보낸 시간을 기록했습니다
//유저가 제품 페이지에 들어가면 타이밍이 시작됩니다
TDAnalytics.TimeEvent("stay_shop");
/**do someting
.......
**/
//유저가 제품 페이지를 떠날 때 타이밍이 끝납니다. "stay_shop" 이벤트는 이벤트 지속 시간을 나타내는 #duration 속성을 가집니다.
TDAnalytics.Track("stay_shop");

3. 유저 속성

TE에서 유저 속성을 설정하는 API는 userSet, userSetOnce, userAdd, userUnset, userDel, userAppend, userUniqAppend

3.1 UserSet

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

//현재 유저 이름은 TA입니다
TDAnalytics.UserSet(new Dictionary<string, object>(){{"user_name", "TA"}});
//현재 유저 이름은 TE입니다
TDAnalytics.UserSet(new Dictionary<string, object>(){{"user_name", "TE"}});

3.2 UserSetOnce

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

//first_payment_time is '2018-01-01 01:23:45.678'
TDAnalytics.UserSetOnce(new Dictionary<string, object>(){
    {"first_payment_time","2018-01-01 01:23:45.678"}
});
 //first_payment_time is '2018-01-01 01:23:45.678' as before
TDAnalytics.UserSetOnce(new Dictionary<string, object>(){
    {"first_payment_time","2018-12-31 01:23:45.678"}
});

3.3 UserAdd

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

//current total_revenue is 30
TDAnalytics.UserAdd(new Dictionary<string, object>(){
    {"total_revenue",30}
});
//current total_revenue is 678
TDAnalytics.UserAdd(new Dictionary<string, object>(){
    {"total_revenue",648}
})

속성 Key는 문자열이며, Value는 숫자만 가능합니다.

3.4 UserUnset

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

// 'userPropertyName'이라는 이름의 유저 속성을 삭제합니다
TDAnalytics.UserUnset("userPropertyName");
// 목록으로 여러 유저 속성을 삭제합니다
List<string> listProps = new List<string>();
listProps.Add("aaa");
listProps.Add("bbb");
listProps.Add("ccc");

TDAnalytics.UserUnset(listProps);

전송 값은 지워진 속성의 key 값이 됩니다

3.5 UserDelete

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

TDAnalytics.UserDelete();

3.6 UserAppend

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

List<string> stringList = new List<string>();
stringList.Add("apple");
stringList.Add("ball");
// UserAppend를 호출하여 유저 목록 유저 속성에 요소를 추가합니다. 이 경우, 존재하지 않는 요소는 새로 생성됩니다
TDAnalytics.UserAppend(new Dictionary<string, object>{
    {"user_list", stringList }
});

3.7 UserUniqAppend

UserUniqAppend를 사용하여 list형의 유저 속성을 추가할 수 있습니다.

UserUniqAppend는 중복을 제외하고 유저 속성을 추가하지만, UserAppend는 중복을 제외하지 않습니다.

//the property value of user_list is ["apple"，"ball"]
List<string> stringList = new List<string>();
stringList.Add("apple");
stringList.Add("ball");
TDAnalytics.UserAppend(new Dictionary<string, object>{
    {"user_list", stringList}
});

List<string> stringList1 = new List<string>();
stringList1.Add("apple");
stringList1.Add("cube");
//the property value of user_list is ["apple","apple","ball","cube"]
TDAnalytics.UserAppend(new Dictionary<string, object>{
    {"user_list", stringList1}
});
//the property value of user_list is ["apple","ball","cube"]
TDAnalytics.UserUniqAppend(new Dictionary<string, object>{
    {"user_list", stringList1}
});

4. 암호화 기능

v2.4.0 이후 버전은 SDK 데이터 전송에 AES+RSA 암호화를 지원하게 되었습니다. 데이터의 암호화 처리는 클라이언트와 서버가 함께 처리하며, 자세한 내용은 당사 담당 직원에게 문의하십시오.

Token 객체의 enableEncrypt 속성을 true로 설정하고, 기본 버전 번호와 공개 키를 설정합니다.

TDAnalytics.Token 토큰 = new TDAnalytics.Token(appId, serverUrl);
토큰.enableEncrypt = true;
토큰.encryptVersion = 1;
토큰.encryptPublicKey = "YOUR_ENCRYPT_PUBLIC_KEY";
TDAnalytics.StartThinkingAnalytics(토큰);

5. 기타 기능

5.1 디바이스 ID 얻기

GetDeviceId를 호출하여 디바이스ID를 획득할 수 있습니다:

TDAnalytics.GetDeviceId();

5.2 기본 표준 시간대 설정

기본적으로 SDK는 이벤트가 발생한 시간으로 디바이스의 표시 시간을 전송합니다. 기본 표준 시간대를 지정할 수도 있습니다.

TDAnalytics.Token 토큰 = new TDAnalytics.Token(appId, serverUrl);
토큰.timezone = TDAnalytics.TATimeZone.UTC;
TDAnalytics.StartThinkingAnalytics(토큰);

표준 시간대를 지정하면, 디바이스의 표준 시간대 데이터가 폐기됩니다. 디바이스의 표준 시간대를 유지하려면, 별도로 이벤트에 유저 정의 속성을 추가하십시오.

5.3 시간 교정

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

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

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

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

// 애플의 NTP 서비스를 사용하여 시간을 교정합니다
TDAnalytics.calibrateTimeWithNtp("time.apple.com");

1. NTP 서비스를 사용한 시간 교정에는 불안정성이 있으며, timestamp를 권장합니다.
2. NTP 서비스를 사용할 경우, 네트워크 환경이 양호하고, 유저 디바이스가 서버 시간을 신속하게 획득할 수 있도록 유지해야 합니다.

5.4 즉시 데이터 전송

일반적으로는 일정 시간 간격으로, 또는 일정한 데이터 양을 쌓은 후 데이터 전송이 이루어지지만, 특정 이벤트 데이터를 즉시 데이터 전송하고 싶은 경우 flush를 사용하여 설정할 수 있습니다.

TDAnalytics.Flush();

5.5 국가/지역 코드 획득

국가/지역 코드를 획득하고자 할 경우, getLocalRegion을 사용하여 얻을 수 있습니다. 특정 비즈니스 시나리오에서, 유저 기기의 국가/지역 코드를 알아야 할 필요가 있다면, GetLocalRegion을 통해 획득할 수 있습니다.

TDAnalytics.GetLocalRegion();