고급 가이드
1. 이벤트 전송
SDK 초기화가 완료되면 데이터 트래킹을 진행하여 유저의 행동 정보를 수집할 수 있습니다. 일반적으로 일반 이벤트로 비즈니스 시나리오의 요구 사항을 충족할 수 있으며, 실제 비즈니스 시나리오에 따라 최초 이벤트, 업데이트 가능 이벤트 등을 사용할 수도 있습니다.
1.1 일반 이벤트
track_instance를 호출하여 이벤트를 업로드할 수 있습니다. 앞서 정리한 문서에 따라 이벤트 속성과 이벤트 전송 조건을 설정하는 것을 권장합니다. 여기서는 유저가 상품을 조회하는 경우를 예로 듭니다:
%% 주의: account_id와 distinct_id 중 하나 이상을 반드시 설정해야 함
%% 유저의 ip 주소 설정. AE 시스템은 IP 주소를 해석하여 유저의 지리적 위치 정보를 얻으며, 설정하지 않으면 기본적으로 전송하지 않음
%% 이벤트 발생 시간 설정. 설정하지 않으면 기본적으로 현재 시간을 사용함. 주의: #time의 타입은 반드시 timestamp() 타입이어야 함
%% 이벤트 전송
td_analytics:track_instance(TE_SDK, "account_id_Erlang", "distinct_logbus", "ViewProduct", #{"#ip" => "192.168.1.1", "#time" => os:timestamp(), "key_1" => "🚓🦽🦼🚲🚜🚜🦽", "key_2" => 2.2, "key_array" => ["🚌", "🏍", "😚😊"]}),
1.2 최초 이벤트
최초 이벤트는 특정 디바이스 또는 기타 차원의 ID에 대해 한 번만 기록되는 이벤트입니다. 예를 들어 특정 디바이스의 활성화 이벤트를 기록하려는 경우 최초 이벤트로 데이터를 전송할 수 있습니다.
FirstCheckId = "first_check_id",
%% 최초 이벤트
td_analytics:track_first_instance(TE_SDK, "account_id_Erlang", "distinct_id", "first_login", FirstCheckId, #{"key1" => "value1", "key2" => "value2"}),
주의: 최초 여부 검증은 서버 측에서 이루어지므로 최초 이벤트는 기본적으로 1시간 지연되어 저장됩니다.
1.3 업데이트 가능 이벤트
업데이트 가능 이벤트를 사용하면 특정 시나리오에서 이벤트 데이터를 수정해야 하는 요구를 충족할 수 있습니다. 업데이트 가능 이벤트는 해당 이벤트를 식별하는 ID를 지정해야 하며, 업데이트 가능 이벤트 객체를 생성할 때 전달합니다. AE 백엔드는 이벤트 이름과 이벤트 ID를 기준으로 업데이트할 데이터를 결정합니다.
EventName = "event_name",
EventId = "event_id",
%% 전송 후 이벤트 속성 status는 3, price는 100
td_analytics:track_update_instance(TE_SDK, "account_id_Erlang", "distinct_id", EventName, EventId, #{"price" => 100, "status" => 3}),
%% 전송 후 이벤트 속성 status는 5, price는 100으로 변경되지 않음
td_analytics:track_update_instance(TE_SDK, "account_id_Erlang", "distinct_id", EventName, EventId, #{"status" => 5}),
1.4 덮어쓰기 가능 이벤트
덮어쓰기 가능 이벤트는 업데이트 가능 이벤트와 비슷하지만, 최신 데이터로 과거 데이터를 완전히 덮어쓴다는 점이 다릅니다. 효과 면에서는 이전 데이터를 삭제하고 최신 데이터를 저장하는 것과 같습니다. AE 백엔드는 이벤트 이름과 이벤트 ID를 기준으로 업데이트할 데이터를 결정합니다.
EventName = "overWrite_event",
EventId = "event_id",
%% 전송 후 이벤트 속성 price는 100, status는 5
td_analytics:track_overwrite_instance(TE_SDK, "account_id_Erlang", "distinct_id", EventName, EventId, #{"price" => 100, "status" => 5}),
%% 전송 후 이벤트 속성 price는 20, status 속성은 삭제됨
td_analytics:track_overwrite_instance(TE_SDK, "account_id_Erlang", "distinct_id", EventName, EventId, #{"price" => 20}),
2. 유저 속성
AE 플랫폼에서 지원하는 유저 속성 설정 API는 다음과 같습니다: user_set_instance, user_set_once_instance, user_add_instance, user_unset_instance, user_del_instance, user_append_instance, user_unique_append_instance.
2.1 user_set_instance
일반적인 유저 속성은 user_set_instance를 호출하여 설정할 수 있습니다. 이 인터페이스로 업로드한 속성은 원래 속성 값을 덮어쓰며, 이전에 해당 유저 속성이 없었다면 새로 생성하고 타입은 전달된 속성의 타입과 같습니다. 여기서는 사용자 이름 설정을 예로 듭니다.
%% "name" is "A"
td_analytics:user_set_instance(TE_SDK, "account_id", "distinct_id", #{"name" => "A", "abc" => ["a", "b", "c"]}),
%% "name" is "B"
td_analytics:user_set_instance(TE_SDK, "account_id", "distinct_id", #{"name" => "B", "abc" => ["a", "b", "c"]}),
2.2 user_set_once_instance
업로드하려는 유저 속성을 한 번만 설정하면 되는 경우 user_set_once_instance를 호출하여 설정할 수 있습니다. 해당 속성에 이미 값이 있으면 이 정보는 무시됩니다. 여기서도 사용자 이름 설정을 예로 듭니다.
%% "name" is "A"
td_analytics:user_set_once_instance(TE_SDK, "account_id", "distinct_id", #{"name" => "A"}),
%% "name" is still "A"
td_analytics:user_set_once_instance(TE_SDK, "account_id", "distinct_id", #{"name" => "B"}),
2.3 user_add_instance
숫자형 속성을 업로드할 때 user_add를 호출하여 해당 속성을 누적할 수 있습니다. 해당 속성이 아직 설정되지 않았으면 0을 할당한 후 계산합니다. 음수를 전달할 수도 있으며, 이는 빼기 연산과 같습니다. 여기서는 누적 결제 금액을 예로 듭니다:
%% "amount" is 30
td_analytics:user_add_instance(TE_SDK, "account_id", "distinct_id", #{"amount" => 30}),
%% "amount" is 90
td_analytics:user_add_instance(TE_SDK, "account_id", "distinct_id", #{"amount" => 60}),
설정하는 속성 key는 문자열이며, Value는 숫자만 허용됩니다.
2.4 user_append_instance
user_append_instance를 호출하여 배열 타입의 유저 속성에 요소를 추가할 수 있습니다.
%% "array" is ["arr1", "arr3"]
td_analytics:user_append_instance(TE_SDK, "account_id", "distinct_id", #{"array" => ["arr1", "arr3"]}),
%% "array" is ["arr1", "arr3", "arr2", "arr3"]
td_analytics:user_append_instance(TE_SDK, "account_id", "distinct_id", #{"array" => ["arr2", "arr3"]}),
2.5 user_unique_append_instance
user_unique_append_instance를 호출하여 배열 타입의 유저 속성에 요소를 추가할 수 있습니다. user_unique_append_instance 인터페이스를 호출하면 추가하는 유저 속성의 중복을 제거합니다. user_append_instance 인터페이스는 중복을 제거하지 않으므로 유저 속성에 중복이 있을 수 있습니다.
%% "array" is ["arr1", "arr3"]
td_analytics:user_unique_append_instance(TE_SDK, "account_id", "distinct_id", #{"array" => ["arr1", "arr3"]}),
%% "array" is ["arr1", "arr3", "arr2"]
td_analytics:user_unique_append_instance(TE_SDK, "account_id", "distinct_id", #{"array" => ["arr2", "arr3"]}),
2.6 user_unset_instance
유저의 유저 속성 값을 비우려면 user_unset_instance를 호출하여 지정한 속성을 비울 수 있습니다. 해당 속성이 아직 클러스터에 생성되지 않았다면 user_unset_instance는 해당 속성을 생성하지 않습니다
td_analytics:user_unset_instance(TE_SDK, "account_id", "distinct_id", ["age", "abc"]),
user_unset_instance의 전달 값은 비울 속성의 Key 값입니다.
2.7 user_del_instance
유저를 삭제하려면 user_del_instance를 호출하여 해당 유저를 삭제할 수 있습니다. 이후 해당 유저의 유저 속성은 더 이상 조회할 수 없지만, 해당 유저가 생성한 이벤트는 계속 조회할 수 있습니다. 이 작업은 되돌릴 수 없는 결과를 초래할 수 있으므로 신중하게 사용하십시오
td_analytics:user_del_instance(TE_SDK, "account_id", "distinct_id"),