tagworks-sdk-v1-react 1.1.20 → 1.1.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +3 -1
- package/README.md +35 -552
- package/android/build.gradle +1 -1
- package/android/src/main/java/com/tagworkssdkv1/DataBundleModule.kt +340 -366
- package/android/src/main/java/com/tagworkssdkv1/OnCmsBannerViewManager.kt +15 -4
- package/android/src/main/java/com/tagworkssdkv1/TagWorksDeeplinkModule.kt +117 -0
- package/android/src/main/java/com/tagworkssdkv1/TagWorksModule.kt +417 -376
- package/android/src/main/java/com/tagworkssdkv1/TagWorksPopupModule.kt +22 -26
- package/android/src/main/java/com/tagworkssdkv1/TagworksSdkV1Package.kt +3 -2
- package/ios/DataBundleModule.swift +8 -8
- package/ios/OnCmsBannerViewManager.swift +6 -5
- package/ios/TagWorksDeeplinkModule.swift +64 -0
- package/ios/TagWorksDeeplinkModuleBridge.m +19 -0
- package/ios/TagWorksModule.swift +113 -27
- package/ios/TagWorksModuleBridge.m +20 -2
- package/ios/TagWorksPopupModule.swift +41 -18
- package/ios/TagWorksPopupModuleBridge.m +2 -0
- package/lib/commonjs/RegisterOnCmsBannerView.js +10 -0
- package/lib/commonjs/RegisterOnCmsBannerView.js.map +1 -0
- package/lib/commonjs/TagWorksDeeplink.js +48 -0
- package/lib/commonjs/TagWorksDeeplink.js.map +1 -0
- package/lib/commonjs/autoTrackers/ReactNavigationPageTracker.js +135 -0
- package/lib/commonjs/autoTrackers/ReactNavigationPageTracker.js.map +1 -0
- package/lib/commonjs/index.js +36 -10
- package/lib/commonjs/index.js.map +1 -1
- package/lib/module/RegisterOnCmsBannerView.js +6 -0
- package/lib/module/RegisterOnCmsBannerView.js.map +1 -0
- package/lib/module/TagWorksDeeplink.js +44 -0
- package/lib/module/TagWorksDeeplink.js.map +1 -0
- package/lib/module/autoTrackers/ReactNavigationPageTracker.js +131 -0
- package/lib/module/autoTrackers/ReactNavigationPageTracker.js.map +1 -0
- package/lib/module/index.js +15 -11
- package/lib/module/index.js.map +1 -1
- package/lib/typescript/commonjs/babel.config.d.ts +2 -0
- package/lib/typescript/commonjs/babel.config.d.ts.map +1 -0
- package/lib/typescript/commonjs/src/RegisterOnCmsBannerView.d.ts +3 -0
- package/lib/typescript/commonjs/src/RegisterOnCmsBannerView.d.ts.map +1 -0
- package/lib/typescript/commonjs/src/TagWorksDeeplink.d.ts +23 -0
- package/lib/typescript/commonjs/src/TagWorksDeeplink.d.ts.map +1 -0
- package/lib/typescript/commonjs/src/autoTrackers/ReactNavigationPageTracker.d.ts +12 -0
- package/lib/typescript/commonjs/src/autoTrackers/ReactNavigationPageTracker.d.ts.map +1 -0
- package/lib/typescript/commonjs/src/index.d.ts +9 -3
- package/lib/typescript/commonjs/src/index.d.ts.map +1 -1
- package/lib/typescript/module/babel.config.d.ts +2 -0
- package/lib/typescript/module/babel.config.d.ts.map +1 -0
- package/lib/typescript/module/src/RegisterOnCmsBannerView.d.ts +3 -0
- package/lib/typescript/module/src/RegisterOnCmsBannerView.d.ts.map +1 -0
- package/lib/typescript/module/src/TagWorksDeeplink.d.ts +23 -0
- package/lib/typescript/module/src/TagWorksDeeplink.d.ts.map +1 -0
- package/lib/typescript/module/src/autoTrackers/ReactNavigationPageTracker.d.ts +12 -0
- package/lib/typescript/module/src/autoTrackers/ReactNavigationPageTracker.d.ts.map +1 -0
- package/lib/typescript/module/src/index.d.ts +9 -3
- package/lib/typescript/module/src/index.d.ts.map +1 -1
- package/package.json +28 -8
- package/src/RegisterOnCmsBannerView.js +5 -0
- package/src/TagWorksDeeplink.js +45 -0
- package/src/autoTrackers/ReactNavigationPageTracker.js +137 -0
- package/src/index.js +48 -0
- package/tagworks-sdk-v1-react.podspec +9 -2
- package/android/src/main/java/com/tagworkssdkv1/TagworksSdkV1Module.kt +0 -25
- package/android/src/main/res/drawable/default_img.png +0 -0
- package/src/index.tsx +0 -27
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,578 +1,61 @@
|
|
|
1
|
-
<img src="https://capsule-render.vercel.app/api?type=Waving&color=A2A4A2&height=150§ion=header&text=TagWorks-SDK-React-Native&fontSize=45" />
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-

|
|
5
|
-

|
|
6
|
-

|
|
7
|
-

|
|
8
|
-
|
|
9
|
-
TagWorks SDK React Native Library
|
|
10
|
-
|
|
11
|
-
## 목차
|
|
12
|
-
- [Installation](#installation)
|
|
13
|
-
- [1. npm을 통한 설치](#1-npm을-통한-설치)
|
|
14
|
-
- [2. 직접 설치](#2-직접-설치)
|
|
15
|
-
- [SDK 초기화](#sdk-초기화)
|
|
16
|
-
- [클래스 선언](#클래스-선언)
|
|
17
|
-
- [초기화](#초기화)
|
|
18
|
-
- [사용자 설정](#사용자-설정)
|
|
19
|
-
- [데이터 구성](#데이터-구성)
|
|
20
|
-
- [Dimension](#dimension)
|
|
21
|
-
- [공용 Dimension](#공용-dimension)
|
|
22
|
-
- [Dimension 추가](#dimension-추가)
|
|
23
|
-
- [Dimension 가져오기](#dimension-가져오기)
|
|
24
|
-
- [Dimension 삭제](#dimension-삭제)
|
|
25
|
-
- [DataBundleModule](#databundlemodule)
|
|
26
|
-
- [DataBundleModule 클래스의 key 값으로 사용 가능한 파라미터](#databundlemodule-클래스의-key-값으로-사용-가능한-파라미터)
|
|
27
|
-
- [EVENT\_TAG\_NAME 에 대응하는 값으로 사용할 수 있는 Standard 태그](#event_tag_name-에-대응하는-값으로-사용할-수-있는-standard-태그)
|
|
28
|
-
- [DataBundleModule 초기화](#databundlemodule-초기화)
|
|
29
|
-
- [DataBundleModule 파라미터 설정](#databundlemodule-파라미터-설정)
|
|
30
|
-
- [DataBundleModule 개별 디멘젼 설정](#databundlemodule-개별-디멘젼-설정)
|
|
31
|
-
- [로그 전송](#로그-전송)
|
|
32
|
-
- [Web View 연동](#web-view-연동)
|
|
33
|
-
- [딥링크 (유입 경로 추적)](#딥링크-유입-경로-추적)
|
|
34
|
-
- [License](#license)
|
|
35
|
-
|
|
36
|
-
<br>
|
|
37
|
-
<br>
|
|
38
|
-
|
|
39
|
-
## Requirements
|
|
40
|
-
|
|
41
|
-
- 최소 iOS 지원 버전 : 15.1
|
|
42
|
-
- 최소 Android Sdk 버전 : 21
|
|
43
|
-
- 최소 Jdk 버전 : 11
|
|
44
|
-
- Kotlin 버전 : 1.7.0
|
|
45
|
-
- Build Gradle 버전 : 7.5
|
|
46
|
-
|
|
47
|
-
<br>
|
|
48
|
-
<br>
|
|
49
|
-
|
|
50
|
-
# Installation
|
|
51
|
-
|
|
52
|
-
## 1. npm을 통한 설치
|
|
53
|
-
|
|
54
|
-
- 해당 프로젝트의 루트 디렉토리에 설치
|
|
55
|
-
|
|
56
|
-
```sh
|
|
57
|
-
npm i tagworks-sdk-v1-react
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
- iOS Dependency 설치
|
|
61
|
-
|
|
62
|
-
iOS 폴더로 이동 후 podfile을 통해 Dependency 설치
|
|
63
|
-
|
|
64
|
-
```sh
|
|
65
|
-
cd ios
|
|
66
|
-
pod install
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
- Android Dependency 설치
|
|
70
|
-
|
|
71
|
-
Android Dependency는 Gradle을 통해 자동으로 설치되나, Dependency 연결을 위해 android 폴더 내부의 app/build.gradle 파일 내부 repositories에 maven 경로 추가
|
|
72
|
-
|
|
73
|
-
```groovy
|
|
74
|
-
repositories {
|
|
75
|
-
...
|
|
76
|
-
mavenCentral()
|
|
77
|
-
maven { url "https://support.obzen.com/nexus/repository/releases/" }
|
|
78
|
-
}
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
<br>
|
|
82
|
-
|
|
83
|
-
## 2. 직접 설치
|
|
84
|
-
|
|
85
|
-
별도의 iOS/Android 플랫폼별 SDK 설치 가이드 참조 (개발팀 문의)
|
|
86
|
-
|
|
87
|
-
<br>
|
|
88
|
-
<br>
|
|
89
|
-
|
|
90
|
-
# SDK 초기화
|
|
91
|
-
|
|
92
|
-
## 클래스 선언
|
|
93
|
-
NativeModules 를 이용하여, TagWorks SDK 사용을 위한 클래스 선언
|
|
94
|
-
|
|
95
|
-
> **JavaScript**
|
|
96
|
-
```js
|
|
97
|
-
import { NativeModules } from 'react-native';
|
|
98
|
-
...
|
|
99
|
-
const { TagWorksModule, DataBundleModule, StandardEventModule } = NativeModules;
|
|
100
|
-
```
|
|
101
|
-
<br>
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
## 초기화
|
|
105
|
-
|
|
106
|
-
- TagWorks SDK 인스턴스를 초기화 하기 이전에 SDK 설정값들을 지정합니다.
|
|
107
|
-
|
|
108
|
-
| 옵션 | 타입 | 기본값 | 설명 |
|
|
109
|
-
| ------------------ | ------- | ------ | ---------------------------------------------------------------------------- |
|
|
110
|
-
| siteId | string | null | 행동 정보 수집 대상 사이트 식별자 |
|
|
111
|
-
| baseUrl | string | null | 행동 정보 데이터 수집 서버 url 주소 |
|
|
112
|
-
| isUseIntervals | boolean | false | interval 사용 여부, false 일 경우 dispatchInterval 값이 무시되고 항상 즉시 발송된다. |
|
|
113
|
-
| dispatchInterval | long | 3 | 행동 정보 데이터 발송 주기 (초단위, <b>최소 3초, 최대 10초 설정) |
|
|
114
|
-
| sessionTimeOut | long | 5 | 행동 정보 데이터 수집 서버의 연결 대기 시간 (초단위, <b>최소 3초, 최대 60초 설정) |
|
|
115
|
-
| isManualDispatch | boolean | false | 행동 정보 데이터 수동 발송 여부 |
|
|
116
|
-
| appVersion | string | null | Application 버전 정보, 설정하지 않을 경우 내부 Application 버전 정보 전송 |
|
|
117
|
-
| appName | string | null | Application 이름, 설정하지 않을 경우 내부 Application 이름 전송 |
|
|
118
|
-
| isUseDynamicParameter | boolean | false | Dimension 동적 파라미터 사용 여부 (기본값 : false) |
|
|
119
|
-
|
|
|
120
|
-
|
|
121
|
-
- **siteId** 및 **baseUrl** 을 설정하지 않는 경우 SDK 초기화 과정에서 오류가 발생합니다.
|
|
122
|
-
- **isUseIntervals** 값을 false로 설정할 경우에는 dispatchInterval 값이 무시되고 항상 즉시 발송됩니다. <br>true로 설정할 경우에는 dispatchInterval 값에 지정된 초를 주기로 데이터를 발송합니다.
|
|
123
|
-
- **dispatchInterval** 은 큐에 저장된 행동 정보 데이터를 지정한 초만큼 주기로 발송하기 때문에, 지정한 시간 사이에 어플리케이션이 종료되는 경우 발송 할 수 없으니 적절한 시간으로 지정해야 합니다.
|
|
124
|
-
- isManualDispatch 값을 true 로 설정한 경우에는, 명시적으로 dispatch() 함수를 호출해야만 태깅 로그가 발송됩니다.
|
|
125
|
-
- **isUseDynamicParameter** 값을 true로 설정할 경우 Dimension의 key값을 문자형으로 사용하고, false로 설정할 경우 key값을 정수형으로 사용해야 합니다.
|
|
126
|
-
- **isUseDynamicParameter** 에 <span style="color:rgb(223, 95, 56)">설정한 값에 따른 해당 메소드와는 다른 Dimension 메소드를 사용 시 데이터가 올바르게 전송되지 않을 수 있습니다.</span>
|
|
127
|
-
- TagWorks SDK 인스턴스를 초기화 하기 위해서는 TagWorksModule 클래스를 이용합니다.
|
|
128
|
-
- TagWorks SDK 인스턴스는 **싱글톤 클래스**로 유지 되기 때문에 최초 초기화 한번으로 전역에서 호출 가능합니다.
|
|
129
|
-
<br>
|
|
130
|
-
|
|
131
|
-
> **JavaScript**
|
|
132
|
-
```js
|
|
133
|
-
TagWorksModule.initializeTagWorks(
|
|
134
|
-
'발급받은 사이트 ID', // siteId
|
|
135
|
-
'서버 URL', // baseUrl
|
|
136
|
-
false, // isUseIntervals
|
|
137
|
-
3, // dispatchInterval
|
|
138
|
-
5, // sessionTimeOut
|
|
139
|
-
false, // isManualDispatch
|
|
140
|
-
null, // appVersion
|
|
141
|
-
null, // appName
|
|
142
|
-
true // isUseDynamicParameter
|
|
143
|
-
);
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
<br/>
|
|
147
|
-
|
|
148
|
-
## 사용자 설정
|
|
149
|
-
|
|
150
|
-
- TagWorks SDK 초기화 이후 TagWorksModule 클래스를 통해 행동 데이터 수집 대상이 되는 사용자를 설정하고 수집 여부를 지정합니다.
|
|
151
|
-
|
|
152
|
-
| 옵션 | 타입 | 기본값 | 설명 |
|
|
153
|
-
| ---------- | ------- | --------------- | ------------------------------------------------------------------------- |
|
|
154
|
-
| userId | string | null | 수집 대상 고객 식별자 (사용자 계정) |
|
|
155
|
-
| adId | string | null | 수집 대상 광고 식별자 |
|
|
156
|
-
| optOut | boolean | false | 행동 정보 데이터 수집 여부 (true로 지정하면 수집하지 않음) |
|
|
157
|
-
| logLevel | int | 4 | 출력할 SDK 로그 레벨 설정 (2: VERBOSE, 3: DEBUG, 4: INFO, 5: WARN, 6: ERROR) |
|
|
158
|
-
|
|
159
|
-
<br/>
|
|
160
|
-
|
|
161
|
-
> **JavaScript**
|
|
162
|
-
```js
|
|
163
|
-
// SDK 디버그 용도 로그 출력
|
|
164
|
-
TagWorksModule.setLogLevel(3);
|
|
165
|
-
|
|
166
|
-
// 고객이 설정한 개인정보 수집 여부에 따라 수집 여부 지정
|
|
167
|
-
// 로그인을 완료한 사용자의 개인정보 수집여부를 판단하여 행동데이터의 수집 여부를 지정합니다.
|
|
168
|
-
// 태깅 로그 전송 제어 용도로도 사용 가능합니다.
|
|
169
|
-
TagWorksModule.setOptOut(false);
|
|
170
|
-
|
|
171
|
-
// 수집 대상자 고객 식별자 지정
|
|
172
|
-
// 고객 로그인 완료에 따라 수집 대상자 고객 식별자를 지정합니다.
|
|
173
|
-
TagWorksModule.setUserId(loginId);
|
|
174
|
-
|
|
175
|
-
// 수집 대상자 광고 식별자 지정
|
|
176
|
-
TagWorksModule.setAdId("광고식별자 UUID");
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
<br>
|
|
180
|
-
<br>
|
|
181
|
-
|
|
182
|
-
# 데이터 구성
|
|
183
|
-
서버로 전송할 태그 정의 데이터를 구성합니다.
|
|
184
|
-
|
|
185
|
-
## Dimension
|
|
186
|
-
|
|
187
|
-
- 디멘젼은 Tagworks SDK를 통해 로그 발송 시 사용자 행동 정보를 수집하는 데이터 정보입니다.
|
|
188
|
-
- <span style="color: #6ba455">공용 디멘젼</span>은 한번 설정하면 일반 디멘젼과 함께 로그 발송 시 전달이 되며, TagWorks SDK 인스턴스에 할당이 되어 삭제를 하지 않는 한 계속 정보를 가지고 있습니다.
|
|
189
|
-
- <span style="color: #6ba455">일반 디멘젼</span>은 로그 발송 시 파라미터로 전달이 되는 DataBundle 객체에 담기는 행동 정보로, 일반적으로 지역 변수로 처리 시 로그 전송 후 정보가 초기화되어 사라집니다.
|
|
190
|
-
- 로그 전송 시 <span style="color: #6ba455">항상 전달이 되어야 하는 정보들은 보통 공용 디멘젼에 할당을 하여 사용하며, 일회성으로 사용하는 정보들은 일반 디멘젼 사용 하시는 것을 권고</span>드립니다.
|
|
191
|
-
- 해당 디멘젼 관련 내용은 iOS/Android 동일합니다.
|
|
192
|
-
- 문자형과 숫자형 두 개의 타입 중 원하는 타입을 선택하여 사용할 수 있습니다. (숫자형은 수치데이터 정보를 이용한 통계 목적으로 사용 가능)
|
|
193
|
-
- key & value 형태로 값을 지정할 수 있으며, key 부분에는 <span style="color: #6ba455">숫자형 index</span>를 사용합니다.
|
|
194
|
-
- 입력하는 index 값은 TagManager 제품에서 정의된 값으로 프로젝트 진행시 전달받을 수 있습니다.
|
|
195
|
-
- index는 문자형과 숫자형에서 중복이 될 수는 있지만, 각각 타입에서 index가 중복으로 사용되면 기존 index에 값이 할당되니 유의하시기 바랍니다.
|
|
196
|
-
|
|
197
|
-
<br/>
|
|
198
|
-
|
|
199
|
-
## 공용 Dimension
|
|
200
|
-
|
|
201
|
-
- 공용 Dimension은 수집 로그 전송 시 공통적으로 전송해야 할 데이터를 설정하는 용도로 사용합니다.
|
|
202
|
-
- 공용 Dimension에서 사용된 index에 다른 Dimension을 덮어쓰지 않는 이상 한 번 설정된 공용 Dimension은 계속 유지됩니다.
|
|
203
|
-
- setCommonDimension() / setDynamicCommonDimension() 함수를 사용하여 공용 Dimension 항목을 계속 추가할 수 있습니다.
|
|
204
|
-
- getCommonDimension() / getDynamicCommonDimension() 함수를 사용하여 공용 Dimension 항목들을 가져올 수 있습니다.
|
|
205
|
-
|
|
206
|
-
<br/>
|
|
207
|
-
|
|
208
|
-
### Dimension 추가
|
|
209
|
-
|
|
210
|
-
> **TypeScript**
|
|
211
|
-
```js
|
|
212
|
-
//
|
|
213
|
-
// # Set
|
|
214
|
-
// index를 사용하여 설정 (SDK 초기화 설정 시 isUseDynamicParameter를 false로 설정한 경우 사용)
|
|
215
|
-
|
|
216
|
-
// Dimension - String Type
|
|
217
|
-
TagWorksModule.setCommonDimensionWithString(1, "계좌조회");
|
|
218
|
-
|
|
219
|
-
// Dimension - Numeric Type (Double형)
|
|
220
|
-
TagWorksModule.setCommonDimensionWithDouble(2, 30000.0);
|
|
221
|
-
```
|
|
222
|
-
|
|
223
|
-
```js
|
|
224
|
-
//
|
|
225
|
-
// # Set
|
|
226
|
-
// 동적 파라미터 key 값을 사용하여 설정 (SDK 초기화 설정 시 isUseDynamicParameter를 true로 설정한 경우 사용)
|
|
227
|
-
|
|
228
|
-
// Dimension - String Type
|
|
229
|
-
TagWorksModule.setDynamicCommonDimensionWithString("사용자행동01", '설정정보01');
|
|
2
|
+
<div>
|
|
230
3
|
|
|
231
|
-
|
|
232
|
-
TagWorksModule.setDynamicCommonDimensionWithDouble("사용자행동02", 10000.0);
|
|
233
|
-
```
|
|
4
|
+
<br><br><br><br><br><br><br><br><br>
|
|
234
5
|
|
|
235
|
-
|
|
6
|
+
<p align="center">
|
|
7
|
+
<strong style="font-size: 40px;">TagWorks SDK React-Native</strong><br><br>
|
|
8
|
+
<span style="font-size: 24px;">TagWorks SDK React Native Library</span><br><br>
|
|
9
|
+
<br><br>
|
|
10
|
+
ver. 1.1.21
|
|
11
|
+
</p>
|
|
236
12
|
|
|
237
|
-
```js
|
|
238
|
-
//
|
|
239
|
-
// # Get
|
|
240
|
-
// 타입과 index를 사용하여 가져오기 (SDK 초기화 설정 시 isUseDynamicParameter를 false로 설정한 경우 사용)
|
|
241
13
|
|
|
242
|
-
// 타입별로 index 키를 가지고 해당 값을 리턴
|
|
243
|
-
// - return : String or Double
|
|
244
|
-
TagWorksModule.getCommonDimensionWithString(1, (value: any) => {
|
|
245
|
-
console.log(value);
|
|
246
|
-
});
|
|
247
|
-
TagWorksModule.getCommonDimensionWithDouble(2, (value: any) => {
|
|
248
|
-
console.log(value);
|
|
249
|
-
});
|
|
250
14
|
|
|
251
|
-
|
|
252
|
-
// - return : JSONString
|
|
253
|
-
TagWorksModule.getCommonDimensions((jsonString: any) => {
|
|
254
|
-
console.log('Received CommonDimensions String:', jsonString);
|
|
255
|
-
});
|
|
15
|
+
<br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
|
|
256
16
|
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
const parsedData = JSON.parse(jsonString);
|
|
262
|
-
console.log('Received Dimensions ArrayIndex String:', parsedData);
|
|
263
|
-
});
|
|
264
|
-
```
|
|
17
|
+
<p align="center">
|
|
18
|
+
© obzen Inc.<br>
|
|
19
|
+
All rights reserved.
|
|
20
|
+
</p>
|
|
265
21
|
|
|
266
|
-
|
|
267
|
-
//
|
|
268
|
-
// # Get
|
|
269
|
-
// 동적 파라미터 key 값을 사용하여 가져오기 (SDK 초기화 설정 시 isUseDynamicParameter를 true로 설정한 경우 사용)
|
|
22
|
+
<br><br><br>
|
|
270
23
|
|
|
271
|
-
|
|
272
|
-
// - return : String or Double
|
|
273
|
-
TagWorksModule.getDynamicCommonDimension("사용자행동01", (value: any) => {
|
|
274
|
-
console.log(value);
|
|
275
|
-
});
|
|
24
|
+
</div>
|
|
276
25
|
|
|
277
|
-
|
|
278
|
-
// - return : JSONString
|
|
279
|
-
TagWorksModule.getDynamicCommonDimensions((jsonString: any) => {
|
|
280
|
-
console.log('Received CommonDimensions String:', jsonString);
|
|
281
|
-
});
|
|
26
|
+
<div style="page-break-after: always;"></div>
|
|
282
27
|
|
|
283
|
-
|
|
284
|
-
// - return : JSONString
|
|
285
|
-
TagWorksModule.getDynamicCommonDimensionsOfArrayIndex((jsonString: any) => {
|
|
286
|
-
// JSON 문자열을 객체로 파싱
|
|
287
|
-
const parsedData = JSON.parse(jsonString);
|
|
288
|
-
console.log('Received Dimensions ArrayIndex String:', parsedData);
|
|
289
|
-
});
|
|
290
|
-
```
|
|
28
|
+

|
|
291
29
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
// 타입과 index를 사용하여 삭제하기 (SDK 초기화 설정 시 isUseDynamicParameter를 false로 설정한 경우 사용)
|
|
298
|
-
|
|
299
|
-
// 타입별 index 키를 가지고 삭제
|
|
300
|
-
TagWorksModule.removeCommonDimensionInGeneralType(1);
|
|
301
|
-
TagWorksModule.removeCommonDimensionInFactType(2);
|
|
302
|
-
|
|
303
|
-
// 공용 Dimension 정보를 가지고 있는 Array의 Index를 이용해 삭제
|
|
304
|
-
TagWorksModule.removeCommonDimensionWithArrayIndex(0);
|
|
305
|
-
|
|
306
|
-
// 모든 공용 Dimension을 삭제
|
|
307
|
-
TagWorksModule.removeAllCommonDimension();
|
|
308
|
-
```
|
|
309
|
-
|
|
310
|
-
```js
|
|
311
|
-
//
|
|
312
|
-
// # Delete
|
|
313
|
-
// 동적 파라미터 key 값을 사용하여 삭제하기 (SDK 초기화 설정 시 isUseDynamicParameter를 true로 설정한 경우 사용)
|
|
314
|
-
|
|
315
|
-
// 키 값을 가지고 삭제
|
|
316
|
-
TagWorksModule.removeDynamicCommonDimension("사용자행동02")
|
|
317
|
-
|
|
318
|
-
// 공용 Dimension 정보를 가지고 있는 Array의 Index를 이용해 삭제
|
|
319
|
-
TagWorksModule.removeDynamicCommonDimensionWithArrayIndex(0);
|
|
320
|
-
|
|
321
|
-
// 모든 공용 Dimension을 삭제
|
|
322
|
-
TagWorksModule.removeAllDynamicCommonDimension();
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
<br/>
|
|
326
|
-
|
|
327
|
-
## DataBundleModule
|
|
328
|
-
- 수집 로그 전송을 하기 위해 필요한 정보들을 담는 클래스로 기본 파라미터 및 Dimension 정보를 쉽게 관리할 수 있습니다.
|
|
329
|
-
- DataBundleModule 클래스는 key와 value의 집합으로 구성된 컨테이너입니다.
|
|
330
|
-
- 태그명 Key에 대응하는 값으로는 DataBundle 클래스가 제공하는 기본 태그 값을 사용하거나, 사용자 정의 String 값을 직접 입력할 수 있습니다.
|
|
331
|
-
- <mark>기본적으로 EVENT_TAG_NAME 값을 설정하지 않는 경우, 로그 전송이 이루어지지 않습니다.</mark>
|
|
332
|
-
- putDimensions() 또는 putDynamicDimension() 메소드를 이용하여 Dimension 객체를 DataBundle 내부에 추가하여 개별 디멘젼으로 사용할 수 있습니다.
|
|
333
|
-
|
|
334
|
-
<br/>
|
|
335
|
-
|
|
336
|
-
### DataBundleModule 클래스의 key 값으로 사용 가능한 파라미터
|
|
337
|
-
|
|
338
|
-
| 파라미터 (키) | 타입 | 설명 |
|
|
339
|
-
| -------------------------------| ------ | ---------------------------------------- |
|
|
340
|
-
| EVENT_TAG_NAME | string | 태그명 |
|
|
341
|
-
| EVENT_TAG_PARAM_TITLE | string | 태그 화면 타이틀 |
|
|
342
|
-
| EVENT_TAG_PARAM_PAGE_PATH | string | 태그 화면 경로 |
|
|
343
|
-
| EVENT_TAG_PARAM_KEYWORD | string | 태그 검색어 |
|
|
344
|
-
| EVENT_TAG_PARAM_CUSTOM_PATH | string | 태그 사용자 정의 경로 - 추가 분석을 위한 경로 |
|
|
345
|
-
|
|
|
346
|
-
|
|
347
|
-
<br/>
|
|
348
|
-
|
|
349
|
-
### <span style="color: #6ba455">EVENT_TAG_NAME</span> 에 대응하는 값으로 사용할 수 있는 Standard 태그
|
|
350
|
-
|
|
351
|
-
| EVENT_TAG_NAME | 설명 |
|
|
352
|
-
| -------------- | -------------------- |
|
|
353
|
-
| PAGE_VIEW | 페이지뷰 태그 |
|
|
354
|
-
| CLICK | 클릭 태그 |
|
|
355
|
-
| SCROLL | 화면 스크롤 태그 |
|
|
356
|
-
| DOWNLOAD | 파일 다운로드 태그 |
|
|
357
|
-
| OUT_LINK | 링크 이동 태그 |
|
|
358
|
-
| SEARCH | 검색 태그 |
|
|
359
|
-
| ERROR | 오류 발생 태그 |
|
|
360
|
-
| REFERRER | 유입 경로 태그 |
|
|
361
|
-
|
|
|
362
|
-
|
|
363
|
-
<br/>
|
|
364
|
-
|
|
365
|
-
### DataBundleModule 초기화
|
|
366
|
-
|
|
367
|
-
> **JavaScript**
|
|
368
|
-
|
|
369
|
-
```js
|
|
370
|
-
// DataBundleModule을 사용하기 위해 필요한 초기화
|
|
371
|
-
DataBundleModule.initialize();
|
|
372
|
-
|
|
373
|
-
// JSON String을 이용해 초기화
|
|
374
|
-
// 기존의 DdataBundleModule의 설정 값을 JSON String으로 저장 후 해당 String을 이용해 빠르게 초기화 할때 사용
|
|
375
|
-
DataBundleModule.initDataBundle(bundleString);
|
|
376
|
-
```
|
|
377
|
-
|
|
378
|
-
<br>
|
|
379
|
-
|
|
380
|
-
### DataBundleModule 파라미터 설정
|
|
381
|
-
|
|
382
|
-
> **JavaScript**
|
|
383
|
-
|
|
384
|
-
```js
|
|
385
|
-
// 태그명 - Standard 태그 or 사용자 정의 태그명
|
|
386
|
-
DataBundleModule.putString(DataBundleModule.EVENT_TAG_NAME, StandardEventModule.PAGE_VIEW);
|
|
387
|
-
// 화면(뷰) 타이틀
|
|
388
|
-
DataBundleModule.putString(DataBundleModule.EVENT_TAG_PARAM_TITLE, "화면타이틀");
|
|
389
|
-
// 화면 경로
|
|
390
|
-
DataBundleModule.putString(DataBundleModule.EVENT_TAG_PARAM_PAGE_PATH, "/화면경로");
|
|
391
|
-
// 검색어
|
|
392
|
-
DataBundleModule.putString(DataBundleModule.EVENT_TAG_PARAM_KEYWORD, "검색어");
|
|
393
|
-
// 사용자 정의 url
|
|
394
|
-
DataBundleModule.putString(DataBundleModule.EVENT_TAG_PARAM_CUSTOM_PATH, "/사용자정의 경로");
|
|
395
|
-
```
|
|
396
|
-
|
|
397
|
-
<br>
|
|
398
|
-
|
|
399
|
-
### DataBundleModule 개별 디멘젼 설정
|
|
400
|
-
|
|
401
|
-
> **TypeScript**
|
|
402
|
-
```js
|
|
403
|
-
//
|
|
404
|
-
// # Set
|
|
405
|
-
// 타입과 index를 사용하여 Dimension 설정 (SDK 초기화 설정 시 isUseDynamicParameter를 false로 설정한 경우 사용)
|
|
406
|
-
|
|
407
|
-
// Dimension - String Type
|
|
408
|
-
DataBundleModule.putDimensionWithString(11, "나의계좌");
|
|
409
|
-
|
|
410
|
-
// Dimension - Numeric Type (Double형)
|
|
411
|
-
DataBundleModule.putDimensionWithDouble(12, 10000);
|
|
412
|
-
```
|
|
413
|
-
|
|
414
|
-
```js
|
|
415
|
-
//
|
|
416
|
-
// # Set
|
|
417
|
-
// 동적 파라미터 key 값을 사용하여 설정 (SDK 초기화 설정 시 isUseDynamicParameter를 true로 설정한 경우 사용)
|
|
418
|
-
|
|
419
|
-
// Dimension - String Type
|
|
420
|
-
DataBundleModule.putDynamicDimensionWithString("사용자행동01", '설정정보01');
|
|
421
|
-
|
|
422
|
-
// Dimension - Numeric Type (Double형)
|
|
423
|
-
DataBundleModule.putDynamicDimensionWithDouble("사용자행동02", 10000.0);
|
|
424
|
-
```
|
|
425
|
-
|
|
426
|
-
```js
|
|
427
|
-
//
|
|
428
|
-
// # Get
|
|
429
|
-
// 타입과 index를 사용하여 Dimension 가져오기 (SDK 초기화 설정 시 isUseDynamicParameter를 false로 설정한 경우 사용)
|
|
430
|
-
|
|
431
|
-
// 타입별로 index 키를 가지고 해당 값을 리턴
|
|
432
|
-
// - return : String or Double
|
|
433
|
-
DataBundleModule.getDimensionWithString(1, (value: any) => {
|
|
434
|
-
console.log(value);
|
|
435
|
-
});
|
|
436
|
-
DataBundleModule.getDimensionWithDouble(2, (value: any) => {
|
|
437
|
-
console.log(value);
|
|
438
|
-
});
|
|
439
|
-
|
|
440
|
-
// GeneralType(String)과 FactType(Double) 별로 리턴
|
|
441
|
-
// - return : JSONString
|
|
442
|
-
DataBundleModule.getDimensions((jsonString: any) => {
|
|
443
|
-
console.log('Received DataBundle Dimensions String:', jsonString);
|
|
444
|
-
});
|
|
445
|
-
|
|
446
|
-
// 개별 Dimension 정보를 가지고 있는 Array의 Index 순으로 리턴
|
|
447
|
-
// - return : JSONString
|
|
448
|
-
DataBundleModule.getDimensionsOfArrayIndex((jsonString: any) => {
|
|
449
|
-
// JSON 문자열을 객체로 파싱
|
|
450
|
-
const parsedData = JSON.parse(jsonString);
|
|
451
|
-
console.log('Received DataBundle Dimensions ArrayIndex String:', parsedData);
|
|
452
|
-
});
|
|
453
|
-
```
|
|
454
|
-
|
|
455
|
-
```js
|
|
456
|
-
//
|
|
457
|
-
// # Get
|
|
458
|
-
// 동적 파라미터 key 값을 사용하여 가져오기 (SDK 초기화 설정 시 isUseDynamicParameter를 true로 설정한 경우 사용)
|
|
459
|
-
|
|
460
|
-
// key 값을 가지고 해당 값을 리턴
|
|
461
|
-
// - return : String or Double
|
|
462
|
-
DataBundleModule.getDynamicDimension("사용자행동01", (value: any) => {
|
|
463
|
-
console.log(value);
|
|
464
|
-
});
|
|
465
|
-
|
|
466
|
-
// key 값 별로 리턴
|
|
467
|
-
// - return : JSONString
|
|
468
|
-
DataBundleModule.getDynamicDimensions((jsonString: any) => {
|
|
469
|
-
console.log('Received DataBundle Dimensions String:', jsonString);
|
|
470
|
-
});
|
|
471
|
-
|
|
472
|
-
// 개별 Dimension 정보를 가지고 있는 Array의 Index 순으로 리턴
|
|
473
|
-
// - return : JSONString
|
|
474
|
-
DataBundleModule.getDynamicDimensionsOfArrayIndex((jsonString: any) => {
|
|
475
|
-
// JSON 문자열을 객체로 파싱
|
|
476
|
-
const parsedData = JSON.parse(jsonString);
|
|
477
|
-
console.log('Received DataBundle Dimensions ArrayIndex String:', parsedData);
|
|
478
|
-
});
|
|
479
|
-
```
|
|
480
|
-
|
|
481
|
-
```js
|
|
482
|
-
//
|
|
483
|
-
// Delete
|
|
484
|
-
// 타입과 index를 사용하여 삭제하기 (SDK 초기화 설정 시 isUseDynamicParameter를 false로 설정한 경우 사용)
|
|
485
|
-
|
|
486
|
-
// 타입별 index 키를 가지고 삭제
|
|
487
|
-
DataBundleModule.removeDimensionInGeneralType(11);
|
|
488
|
-
DataBundleModule.removeDimensionInFactType(22);
|
|
489
|
-
|
|
490
|
-
// 개별 Dimension 정보를 가지고 있는 Array의 Index를 이용해 삭제
|
|
491
|
-
DataBundleModule.removeDimensionWithArrayIndex(0);
|
|
492
|
-
|
|
493
|
-
// 모든 개별 Dimension을 삭제
|
|
494
|
-
DataBundleModule.removeAllDimension();
|
|
495
|
-
```
|
|
496
|
-
|
|
497
|
-
```js
|
|
498
|
-
//
|
|
499
|
-
// Delete
|
|
500
|
-
// 동적 파라미터 key 값을 사용하여 삭제하기 (SDK 초기화 설정 시 isUseDynamicParameter를 true로 설정한 경우 사용)
|
|
501
|
-
|
|
502
|
-
// key 값을 가지고 삭제
|
|
503
|
-
DataBundleModule.removeDynamicDimension("사용자행동01");
|
|
504
|
-
|
|
505
|
-
// 개별 Dimension 정보를 가지고 있는 Array의 Index를 이용해 삭제
|
|
506
|
-
DataBundleModule.removeDynamicDimensionWithArrayIndex(0);
|
|
507
|
-
|
|
508
|
-
// 모든 개별 Dimension을 삭제
|
|
509
|
-
DataBundleModule.removeAllDynamicDimension();
|
|
510
|
-
```
|
|
511
|
-
<br>
|
|
512
|
-
<br>
|
|
30
|
+

|
|
31
|
+

|
|
32
|
+

|
|
33
|
+

|
|
34
|
+

|
|
513
35
|
|
|
514
|
-
|
|
36
|
+
TagWorks SDK React Native Library
|
|
515
37
|
|
|
516
|
-
|
|
517
|
-
-
|
|
518
|
-
-
|
|
519
|
-
|
|
520
|
-
-
|
|
521
|
-
- `EVENT_TAG_NAME 값이 StandardEvent.SEARCH 인 경우, EVENT_TAG_PARAM_KEYWORD 값은 필수 파라미터입니다.`
|
|
522
|
-
- 앞서 설정한 DataBundleModule 로부터 설정 상태를 JSON String으로 받아와 파라미터로 전송
|
|
38
|
+
## 목차
|
|
39
|
+
- [Mobile Tag 수집](#mobile-tag-수집)
|
|
40
|
+
- [InAppMessage](#inappmessage)
|
|
41
|
+
- [딥링크 서비스](#딥링크-서비스)
|
|
42
|
+
- [License](#license)
|
|
523
43
|
|
|
524
44
|
<br>
|
|
525
45
|
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
DataBundleModule.getDataBundle((bundleString: any) => {
|
|
529
|
-
console.log('Received Dictionary String:', bundleString);
|
|
46
|
+
# Mobile Tag 수집
|
|
47
|
+
- Mobile React-Native Framwork에서 OBZEN TagManager의 로그 수집을 하기 위한 용도의 SDK
|
|
530
48
|
|
|
531
|
-
TagWorksModule.logEvent(TagWorksModule.EVENT_TYPE_PAGE, bundleString, (result: any) => {
|
|
532
|
-
console.log(result)
|
|
533
|
-
});
|
|
534
|
-
});
|
|
535
|
-
```
|
|
536
|
-
|
|
537
|
-
<br>
|
|
538
49
|
<br>
|
|
539
50
|
|
|
540
|
-
#
|
|
541
|
-
|
|
542
|
-
- Web / App 연동을 위한 interface 를 제공합니다.
|
|
543
|
-
- 앱에서 Tag Manager Code Snippet 이 포함된 웹뷰를 실행하면, 웹뷰에서 발생된 태깅 로그는 SDK를 통하여 앱으로 전송됩니다.
|
|
544
|
-
- WebView의 onMessage 내부에 TagWorksModule의 webInterfaceDidReceive() 함수 호출이 필요합니다.
|
|
545
|
-
- 로그인 시 사용자 맵핑을 위해 로그인 시점에 userId 설정하는 부분과 App에서 설정한 Dimension 값을 WebView에서 사용하기 위해 쿠키를<br>
|
|
546
|
-
설정하는 부분에 있어 부분적인 대응 개발이 필요할 수 있습니다.
|
|
547
|
-
|
|
548
|
-
>**TypeScript**
|
|
549
|
-
```js
|
|
550
|
-
<WebView
|
|
551
|
-
...
|
|
552
|
-
onMessage={(event: any) => {
|
|
553
|
-
const message = event.nativeEvent.data;
|
|
554
|
-
console.log("Received message: ", message);
|
|
555
|
-
TagWorksModule.webInterfaceDidReceive(message);
|
|
556
|
-
}}
|
|
557
|
-
/>
|
|
558
|
-
```
|
|
51
|
+
# InAppMessage
|
|
52
|
+
- onCMS 연동을 통해 앱 내 팝업 및 배너를 노출
|
|
559
53
|
|
|
560
54
|
<br>
|
|
561
|
-
<br>
|
|
562
|
-
|
|
563
|
-
# 딥링크 (유입 경로 추적)
|
|
564
55
|
|
|
565
|
-
|
|
566
|
-
-
|
|
56
|
+
# 딥링크 서비스
|
|
57
|
+
- TagWorks Deeplink Service는 앱 설치 및 실행 시 딥링크를 처리하고, 지연된 딥링크(Deferred Deeplink)를 지원하는 고급 딥링크 처리 시스템
|
|
567
58
|
|
|
568
|
-
<br>
|
|
569
|
-
|
|
570
|
-
>**TypeScript**
|
|
571
|
-
```js
|
|
572
|
-
TagWorksModule.sendReferrerEventWithOpenUrlString(<referrerURL>);
|
|
573
|
-
```
|
|
574
|
-
|
|
575
|
-
<br>
|
|
576
59
|
<br>
|
|
577
60
|
|
|
578
61
|
# License
|
|
@@ -581,4 +64,4 @@ Apache 2.0
|
|
|
581
64
|
|
|
582
65
|
---
|
|
583
66
|
|
|
584
|
-
Made with [Obzen Inc.](https://www.obzen.com)
|
|
67
|
+
Made with [Obzen Inc.](https://www.obzen.com)
|
package/android/build.gradle
CHANGED
|
@@ -100,6 +100,6 @@ dependencies {
|
|
|
100
100
|
implementation "com.facebook.react:react-native:+"
|
|
101
101
|
// implementation "com.facebook.react:react-android:0.71.0"
|
|
102
102
|
implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
|
|
103
|
-
|
|
103
|
+
api "com.obzen.tagworks:tagworks-v1-kotlin:1.1.35"
|
|
104
104
|
}
|
|
105
105
|
|