고급 가이드

최근 업데이트 2026. 10. 05.

1. 이벤트 전송

SDK 초기화가 완료되면 데이터 트래킹을 진행하여 유저의 행동 정보를 수집할 수 있습니다. 일반적으로 일반 이벤트로 비즈니스 시나리오의 요구 사항을 충족할 수 있으며, 실제 비즈니스 시나리오에 따라 최초 이벤트, 업데이트 가능 이벤트 등을 사용할 수도 있습니다.

1.1 일반 이벤트

track을 호출하여 이벤트를 전송할 수 있습니다. 앞서 정리한 문서에 따라 이벤트 속성과 이벤트 전송 조건을 설정하는 것을 권장합니다. 여기서는 유저가 어떤 상품을 구매하는 경우를 예로 듭니다:

--이벤트 속성 설정
local properties = {}
--이벤트 발생 시간을 설정합니다. 설정하지 않으면 기본적으로 현재 시간을 사용합니다
properties["#time"] = os.date("%Y-%m-%d %H:%M:%S")

--유저의 IP 주소를 설정합니다. AE 시스템은 IP 주소를 기반으로 유저의 지리적 위치 정보를 분석하며, 설정하지 않으면 기본적으로 전송하지 않습니다
properties["#ip"] = "192.168.1.1"

properties["Product_Name"] = "card"
properties["Price"] = 30
properties["OrderId"] = "abc_123"
--이벤트를 전송합니다. 유저의 게스트 ID와 계정 ID를 포함하며, 계정 ID와 게스트 ID의 순서에 주의하십시오
sdk:track("accountId", "distinctId", "payment", properties)

1.2 최초 이벤트

최초 이벤트는 특정 디바이스 또는 기타 차원의 ID에 대해 한 번만 기록되는 이벤트입니다. 예를 들어 특정 디바이스의 활성화 이벤트를 기록하려는 경우 최초 이벤트로 데이터를 전송할 수 있습니다.

local properties = {}
--first_check_id 값을 설정해야 합니다
sdk:trackFirst("accountId", "distinctId", "device_activation", "first_check_id", properties)

주의: 최초 여부 검증은 서버 측에서 이루어지므로 최초 이벤트는 기본적으로 1시간 지연되어 저장됩니다.

1.3 업데이트 가능 이벤트

업데이트 가능 이벤트를 사용하면 특정 시나리오에서 이벤트 데이터를 수정해야 하는 요구를 충족할 수 있습니다. 업데이트 가능 이벤트는 해당 이벤트를 식별하는 ID를 지정해야 하며, 업데이트 가능 이벤트 객체를 생성할 때 전달합니다. AE 백엔드는 이벤트 이름과 이벤트 ID를 기준으로 업데이트할 데이터를 결정합니다.

-- "price" is 80, "count" is 3
local properties = {}
properties["price"] = 80
properties["count"] = 3
sdk:trackUpdate("accountId", "distinctId", "eventName", "eventId", properties)

-- The "price" is still 80, The "count" has changed to 5
local newProperties = {}
newProperties["count"] = 5
sdk:trackUpdate("accountId", "distinctId", "eventName", "eventId", newProperties)

1.4 덮어쓰기 가능 이벤트

덮어쓰기 가능 이벤트는 업데이트 가능 이벤트와 비슷하지만, 최신 데이터로 과거 데이터를 완전히 덮어쓴다는 점이 다릅니다. 효과 면에서는 이전 데이터를 삭제하고 최신 데이터를 저장하는 것과 같습니다. AE 백엔드는 이벤트 이름과 이벤트 ID를 기준으로 업데이트할 데이터를 결정합니다.

-- "price" is 80, "count" is 3
local properties = {}
properties["price"] = 80
properties["count"] = 3
sdk:trackOverwrite("accountId", "distinctId", "eventName", "eventId", properties)

-- The "count" has changed to 5，The "price" will be deleted
local newProperties = {}
newProperties["count"] = 5
sdk:trackOverwrite("accountId", "distinctId", "eventName", "eventId", newProperties)

2. 유저 속성

AE 플랫폼에서 지원하는 유저 속성 설정 API는 다음과 같습니다: userSet, userSetOnce, userAdd, userUnset, userDel, userAppend, userUniqueAppend.

2.1 userSet

일반적인 유저 속성은 userSet을 호출하여 설정할 수 있습니다. 이 인터페이스로 업로드한 속성은 원래 속성 값을 덮어쓰며, 이전에 해당 유저 속성이 없었다면 새로 생성하고 타입은 전달된 속성의 타입과 같습니다. 여기서는 사용자 이름 설정을 예로 듭니다:

local userSetProperties = {}
userSetProperties["user_name"] = "ABC"
userSetProperties["#time"] = os.date("%Y-%m-%d %H:%M:%S")
--유저 속성 전송
sdk:userSet("accountId", "distinctId", userSetProperties)

userSetProperties = {}
userSetProperties["user_name"] = "abc"
userSetProperties["#time"] = os.date("%Y-%m-%d %H:%M:%S")
--유저 속성을 다시 전송합니다. 이때 "user_name"의 값은 "abc"로 덮어쓰입니다
sdk:userSet("accountId", "distinctId", userSetProperties)

2.2 userSetOnce

업로드할 유저 속성을 한 번만 설정하면 되는 경우 userSetOnce를 호출하여 설정할 수 있습니다. 해당 속성에 이미 값이 있으면 이 정보는 무시됩니다. 다시 사용자 이름 설정을 예로 들면 다음과 같습니다:

local userSetOnceProperties = {}
userSetOnceProperties["user_name"] = "ABC"
userSetOnceProperties["#time"] = os.date("%Y-%m-%d %H:%M:%S")
--유저 속성을 전송합니다. "user_name"을 새로 생성하며 값은 "ABC"입니다
sdk:userSetOnce("accountId", "distinctId", userSetOnceProperties)

userSetOnceProperties = {}
userSetOnceProperties["user_name"] = "abc"
userSetOnceProperties["user_age"] = 18
userSetOnceProperties["#time"] = os.date("%Y-%m-%d %H:%M:%S")
--유저 속성을 다시 전송합니다. 이때 "user_name"의 값은 덮어쓰이지 않고 여전히 "ABC"이며, "user_age"의 값은 18입니다
sdk:userSetOnce("accountId", "distinctId", userSetOnceProperties)

2.3 userAdd

숫자형 속성을 업로드할 때 userAdd를 호출하여 해당 속성을 누적할 수 있습니다. 해당 속성이 아직 설정되지 않았으면 0을 할당한 후 계산합니다. 음수를 전달할 수도 있으며, 이는 빼기 연산과 같습니다. 여기서는 누적 결제 금액을 예로 듭니다.

local userAddProperties = {}
userAddProperties["total_revenue"] = 30
userAddProperties["#time"] = os.date("%Y-%m-%d %H:%M:%S")
--유저 속성을 전송합니다. 이때 "total_revenue"의 값은 30입니다
sdk:userAdd("accountId", "distinctId", userAddProperties)

userAddProperties = {}
userAddProperties["total_revenue"] = 60
userAddProperties["#time"] = os.date("%Y-%m-%d %H:%M:%S")
--유저 속성을 다시 전송합니다. 이때 "total_revenue"의 값은 누적되어 90이 됩니다
sdk:userAdd("accountId", "distinctId", userAddProperties)

설정하는 속성 key는 문자열이며, Value는 숫자만 허용됩니다.

2.4 userAppend

userAppend를 호출하여 배열 타입의 유저 속성에 요소를 추가할 수 있습니다.

local equips = {}
equips[1] = "weapon"
equips[2] = "hat"
local userAppendProperties = {}
userAppendProperties["equips"] = equips
userAppendProperties["#time"] = os.date("%Y-%m-%d %H:%M:%S")
--유저 속성을 전송합니다. 이때 "equips"의 값은 ["weapon", "hat"]입니다
sdk:userAppend("accountId", "distinctId", userAppendProperties)

equips = {}
equips[1] = "clothes"
userAppendProperties = {}
userAppendProperties["equips"] = equips
userAppendProperties["#time"] = os.date("%Y-%m-%d %H:%M:%S")
--유저 속성을 다시 전송합니다. 이때 "equips"의 값에 "clothes"가 하나 추가됩니다: ["weapon", "hat", "clothes"]
sdk:userAppend("accountId", "distinctId", userAppendProperties)

2.5 userUniqueAppend

userUniqueAppend를 호출하여 배열 타입의 유저 속성에 요소를 추가할 수 있습니다. userUniqueAppend 인터페이스는 추가한 유저 속성의 중복을 제거하며, userAppend 인터페이스는 중복을 제거하지 않으므로 유저 속성에 중복이 있을 수 있습니다.

local profiles_append = {}
--실행 후 유저 속성 append는 ["test_append"]입니다
profiles_append["append"] = { "test_append" }
sdk:userAppend("accountId", "distinctId", profiles_append)

local profiles_uniq_append = {}
--실행 후 유저 속성 append는 ["test_append", "test_append1"]입니다
profiles_uniq_append["append"] = {"test_append", "test_append1"}
sdk:userUniqueAppend("accountId", "distinctId", profiles_uniq_append)

2.6 userUnset

유저의 유저 속성 값을 비우려면 userUnset을 호출하여 지정한 속성을 비울 수 있습니다. 해당 속성이 아직 클러스터에 생성되지 않았다면 userUnset은 해당 속성을 생성하지 않습니다

local userUnsetProperties = {}
userUnsetProperties[1] = "total_revenue"
userUnsetProperties[2] = "equips"
--유저 속성을 전송합니다. 이때 "total_revenue"와 "equips" 두 속성이 초기화됩니다
sdk:userUnset("accountId", "distinctId", userUnsetProperties)

userUnset에 전달하는 값은 비울 속성의 Key 값입니다.

2.7 userDel

유저를 삭제하려면 userDel을 호출하여 해당 유저를 삭제할 수 있습니다. 삭제 후에는 해당 유저의 유저 속성을 더 이상 조회할 수 없지만, 해당 유저가 생성한 이벤트는 계속 조회할 수 있습니다. 이 작업은 되돌릴 수 없는 결과를 초래할 수 있으므로 신중하게 사용하십시오

sdk:userDel("accountId", "distinctId")

3. 기타 기능

3.1 TDBatchConsumer

주의

데이터양이 너무 많거나 네트워크에 이상이 있으면 데이터가 유실될 위험이 있으므로 운영 환경에서는 사용하지 않는 것을 권장합니다

데이터를 AE 서버로 실시간 일괄 전송하며, 별도의 전송 도구가 필요하지 않습니다.

local tdAnalytics = require "ThinkingDataSdk"
local consumer = tdAnalytics.TDBatchConsumer("SERVER_URL", "APP_ID")
local sdk = tdAnalytics(consumer)

파라미터 설명:

• APP_ID: 프로젝트의 APP ID이며, AE 백엔드의 프로젝트 관리 페이지에서 확인할 수 있습니다

• SERVER_URL: 데이터 전송 URL

  • 클라우드 서비스를 사용하는 경우 다음을 입력합니다: https://global-receiver-ta.thinkingdata.cn
  • 프라이빗 배포 버전을 사용하는 경우 데이터 수집 주소에 도메인을 바인딩하고 HTTPS 인증서를 설정하십시오: https://데이터 수집 주소에 바인딩한 도메인