싱글 언리얼 엔진 SDK |
|
---|---|
다운로드 |
싱글 언리얼 엔진 SDK 버전 2.4.0 |
호환성 | 언리얼 엔진 4.23 이상 |
통합 가이드 |
프로젝트에 SDK 추가하기
프로젝트에 싱글 SDK를 추가하려면 다음과 같이 하세요:
- 다운로드한 SDK 아카이브에 SDK 플러그인이 포함된 SingularSDK 폴더가 포함되어 있습니다. 앱의 플러그인 폴더에 SingularSDK 폴더를 복사합니다.
-
앱의 Build.cs 파일(<YOUR_APP>.Build.cs)의 PublicDependencyModuleNames 배열에 SingularSDK를 종속 요소로 추가합니다:
PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "SingularSDK" });
SDK 초기화
참고: 싱글 SDK를 구현할 때 GDPR, CCPA, COPPA를 포함하되 이에 국한되지 않는 비즈니스를 수행하는 지역에서 제정된 다양한 개인정보 보호법을 준수해야 합니다. 자세한 내용은 SDK 옵트인 및 옵트아웃 사례를 참조하세요.
SDK 초기화 코드는 앱을 열 때마다 호출되어야합니다. 이는 모든 싱귤러 어트리뷰션 기능의 전제 조건이며, 사용자 리텐션을 계산하는 데 사용되는 새 세션을싱귤러로 전송하기도 합니다. 앱 실행 시 가능한 한 빨리 SDK를 초기화하는 것이 좋습니다.
SDK를 초기화하려면 SingularSDKBPLibrary 클래스에서 Initialize 메서드를 호출합니다:
초기화 메서드 | |
---|---|
설명 | 싱귤러 SDK를 초기화하고 사용자 세션을 싱귤러 서버로 보냅니다. |
서명 |
|
사용 예시 |
|
메서드 매개변수
파라미터 | 필수? | 설명 | Default |
sdkKey | 이러한 키를 얻으려면 Singular 계정에 로그인하여 "개발자 도구 > SDK 통합 > SDK 키"로 이동하세요. | ||
sdkSecret | |||
sessionTimeout |
사용자 지정 세션 시간 제한(초)을 설정합니다. | 60 | |
customUserId | 사용자 ID를 Singular로 보냅니다. 아래에서 자세히 알아보세요. | ||
waitForTrackingAuthorization WithTimeoutInterval | (iOS) 사용자가 기기 식별자 데이터 공유에 동의하거나 거부할 때까지 세션/이벤트 전송을 Singular로 연기합니다. 아래에서 자세히 알아보세요. | False | |
skAdNetworkEnabled | (iOS) 싱귤러가 사용자의 전환 값을 추적하도록 하려면 True로 설정합니다. 자세한 내용은 싱귤러의 SK애드네트워크 솔루션 소개를참조하세요. | False | |
manualSkanConversion Management | (iOS) SKAdNetwork 전환 값을 수동으로 관리하려면 True로 설정합니다(코드에서 직접 설정 및 업데이트). 자세한 내용은싱귤러의 SKAdNetwork 솔루션 소개를 참조하세요 . | False | |
oaidCollection | (안드로이드) 디바이스의 OAID를 수집하려면 true로 설정합니다. | False |
싱귤러에 사용자 ID 보내기(선택 사항)
싱귤러 SDK 방법을 사용하여 내부 사용자 ID를 싱귤러에 전송할 수 있습니다.
참고: 싱귤러의 크로스 디바이스 솔루션을 사용하는 경우, 모든 플랫폼에서 사용자 ID를 수집해야 합니다.
- 사용자 ID는 모든 식별자가 될 수 있으며 PII(개인 식별 정보)를 노출해서는 안 됩니다. 예를 들어 사용자의 이메일 주소, 사용자 이름 또는 전화번호를 사용해서는 안 됩니다. 싱귤러는 퍼스트 파티 데이터에만 고유한 해시값을 사용할 것을 권장합니다.
- 또한 Singular에 전달되는 사용자 ID 값은 모든 플랫폼(웹/모바일/PC/콘솔/오프라인)에서 캡처한 내부 사용자 ID와 동일해야 합니다.
- Singular는 사용자 수준 내보내기, ETL 및 내부 BI 포스트백(구성된 경우)에 사용자 ID를 포함합니다. 사용자 ID는 퍼스트 파티 데이터이며, Singular는 이를 다른 당사자와 공유하지 않습니다.
- 싱귤러 SDK 메서드로 설정한 사용자 ID 값은 UnsetCustomUserId 메서드를 사용하여 설정 해제하거나 앱을 제거할 때까지 지속됩니다. 앱을 닫거나 다시 시작해도 사용자 ID는 설정이 해제되지 않습니다.
사용자 ID를 설정하려면 SetCustomUserId 메서드를 사용합니다. 설정을 해제하려면(예: 사용자가 계정에서 '로그아웃'하는 경우) UnsetCustomUserId 으로 전화하세요.
참고: 여러 사용자가 하나의 디바이스를 사용하는 경우 로그인 및 로그아웃할 때마다 사용자 ID를 설정하고 설정 해제하는 로그아웃 플로우를 구현하는 것이 좋습니다.
앱이 열릴 때 사용자 ID를 이미 알고 있는 경우 Singular SDK를 초기화하기 전에 SetCustomUserId 으로 전화하세요. 이렇게 하면 싱귤러가 첫 번째 세션부터 사용자 ID를 가질 수 있습니다. 그러나 일반적으로 사용자가 등록하거나 로그인을 수행할 때까지 사용자 ID를 사용할 수 없습니다. 이 경우 등록 절차가 완료된 후 SetCustomUserId 으로 전화하세요.
싱귤러SDK 설정 사용자 아이디 메서드 | |
---|---|
설명 | 사용자 ID를 Singular로 보냅니다. |
Signature | 정적 void SetCustomUserId(FString customUserId) |
사용 예제 |
|
SingularSDK 언셋 커스텀 유저 아이디 메서드 | |
설명 | Singular 로 전송된 사용자 ID 를 설정 해제합니다. |
Signature | 정적 void UnsetCustomUserId() |
사용 예제 |
|
중요: 이 고급 엔터프라이즈 기능은 예외적인 경우에만 사용할 수 있습니다.이 기능을 구현하기 전에 싱귤러의 솔루션 엔지니어와 상담하세요.
싱귤러는 서버 간 연동을 통해 추가 모바일 이벤트 추적 데이터를 수신할 수 있습니다. 이 기능을 활용하려면 사용자 ID를 Singular의 모바일 디바이스 추적 식별자에 매핑해야 합니다.
참고: 이 메서드는 싱귤러 SDK를 초기화한 후 또는 사용자 ID를 확보한 후 가능한 한 빨리 호출하세요.
싱귤러 SDK 설정 커스텀 유저 아이디 메서드 | |
---|---|
설명 | 사용자 지정 사용자 ID를 로그인과 동일하게 설정하고 이를 싱귤러의 추적 식별자에 매핑합니다. |
서명 | static void SetDeviceCustomUserId(FString customUserId) |
사용 예시 |
|
선택 사항입니다: iOS 14+ 앱 추적 투명성 지원
iOS 14+에서 앱은 디바이스의 IDFA 값을 사용하는 것을 포함하여 사용자 데이터를 공유하기 전에 사용자 동의를 요청해야 합니다( 앱 추적 투명성 참조). 싱귤러는 디바이스를 식별하고 인스톨 어트리뷰션을 수행하기 위해 IDFA를 사용하는 것이 큰 도움이 됩니다. 따라서, 싱귤러 SDK가 사용자 세션과 사용자 이벤트를 싱귤러 서버로 전송하기 전에 사용자 동의를 요청해야 합니다.
SDK가 세션을 전송하면, 해당 시점에 싱귤러가 사용할 수 있는 데이터만을 기반으로 싱귤러의 인스톨 어트리뷰션 프로세스가 트리거됩니다.
SDK가 사용자 세션과 사용자 이벤트를 전송하는 것을 지연시키려면 waitForTrackingAuthorizationWithTimeoutInterval 파라미터를 사용하여 Singular SDK를 초기화합니다. 그렇게 하면
- SDK가 초기화되고 세션과 사용자 이벤트를 기록하기 시작하지만 아직 Singular 서버로 전송하지는 않습니다.
- 앱 추적 투명성 동의가 승인/거부되거나 설정된 시간 제한이 경과하는 즉시, SDK는 세션과 대기 중인 모든 이벤트를 (IDFA를 사용하거나 사용하지 않고) Singular 서버로 전송합니다.
- 그러면 싱귤러가 어트리뷰션 프로세스를 시작하여 사용 가능한 경우 IDFA를 활용합니다.
자세한 내용은 iOS 14 준비하기를 참조하세요.
싱귤러 언리얼 엔진 SDK |
|
---|---|
연동 가이드 |