Skip to content

Commit 5c712a9

Browse files
committed
- fix readme
1 parent ee9e0b5 commit 5c712a9

File tree

7 files changed

+201
-8
lines changed

7 files changed

+201
-8
lines changed

README.md

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,197 @@ for version `1.0.0`
2828
```csharp
2929
"com.wolf-package.tracking":"https://github.com/wolf-package/app-tracking-unity.git#1.0.0",
3030
```
31+
32+
## Use
33+
34+
#### Firebase Tracking
35+
36+
- Add define symbols `VIRTUESKY_FIREBASE_ANALYTIC` to use
37+
- Tracking event
38+
```csharp
39+
static void TrackEvent(string eventName)
40+
static void TrackEvent(string eventName, string parameterName, string parameterValue)
41+
static void TrackEvent(string eventName, Dictionary<string, string> dictParameters)
42+
static void TrackEvent(string eventName, Parameter[] parameters)
43+
```
44+
Example
45+
46+
```csharp
47+
void TrackNoParam()
48+
{
49+
FirebaseTracking.TrackEvent("WinGame");
50+
}
51+
52+
/// <summary>
53+
/// parameter_name: level
54+
/// parameter_value: level_1
55+
/// </summary>
56+
void TrackOneParam()
57+
{
58+
FirebaseTracking.TrackEvent("WinGame", "level", "level_1");
59+
}
60+
61+
void TrackHasPramDict()
62+
{
63+
Dictionary<string, string> dict = new Dictionary<string, string>();
64+
dict.Add("level", "level_1");
65+
dict.Add("level", "level_2");
66+
dict.Add("level", "level_3");
67+
FirebaseTracking.TrackEvent("WinGame", dict);
68+
}
69+
70+
void TrackHasPram()
71+
{
72+
Parameter[] parameters = new[]
73+
{
74+
new Parameter("level", "level_1"),
75+
new Parameter("level", "level_2"),
76+
new Parameter("level", "level_3")
77+
};
78+
FirebaseTracking.TrackEvent("WinGame", parameters);
79+
}
80+
```
81+
82+
- Tracking ads revenue
83+
84+
```csharp
85+
static void FirebaseAnalyticTrackRevenue(double value, string network, string unitId, string format, string adNetwork)
86+
```
87+
Example
88+
89+
```csharp
90+
void TrackingRevenue()
91+
{
92+
FirebaseAnalyticTrackingRevenue.FirebaseAnalyticTrackRevenue(...);
93+
}
94+
```
95+
96+
#### Adjust Tracking
97+
98+
- Add define symbol `VIRTUESKY_ADJUST` to use
99+
- Tracking event
100+
101+
```csharp
102+
static void TrackEvent(string eventToken)
103+
```
104+
105+
Example
106+
```csharp
107+
void TrackingEventAdjust()
108+
{
109+
AdjustTracking.TrackEvent("asdwdsfwa");
110+
}
111+
```
112+
113+
- Tracking ads revenue
114+
```csharp
115+
static void AdjustTrackRevenue(double value, string network, string unitId, string placement, string adNetwork)
116+
```
117+
Example
118+
119+
```csharp
120+
void TrackingRevenue()
121+
{
122+
AdjustTrackingRevenue.AdjustTrackRevenue(...);
123+
}
124+
```
125+
126+
#### AppsFlyer Tracking
127+
128+
- Add define symbol `VIRTUESKY_APPSFLYER` to use
129+
- Tracking event
130+
131+
```csharp
132+
static void TrackEvent(string eventName)
133+
static void TrackEvent(string eventName, string parameterName, string parameterValue)
134+
static void TrackEvent(string eventName, Dictionary<string, string> eventValues)
135+
```
136+
137+
Example
138+
139+
```csharp
140+
void TrackNoParam()
141+
{
142+
AppsFlyerTracking.TrackEvent("WinGame");
143+
}
144+
145+
/// <summary>
146+
/// parameter_name: level
147+
/// parameter_value: level_1
148+
/// </summary>
149+
void TrackOneParam()
150+
{
151+
AppsFlyerTracking.TrackEvent("WinGame", "level", "level_1");
152+
}
153+
154+
void TrackHasPramDict()
155+
{
156+
Dictionary<string, string> dict = new Dictionary<string, string>();
157+
dict.Add("level", "level_1");
158+
dict.Add("level", "level_2");
159+
dict.Add("level", "level_3");
160+
AppsFlyerTracking.TrackEvent("WinGame", dict);
161+
}
162+
```
163+
- Tracking ads revenue
164+
165+
```csharp
166+
static void AppsFlyerTrackRevenueAd(double value, string network, string unitId, string format, string adNetwork)
167+
```
168+
169+
Example
170+
171+
```csharp
172+
void TrackingRevenue()
173+
{
174+
AppsFlyerTrackingRevenue.AppsFlyerTrackRevenueAd(...);
175+
}
176+
```
177+
- Tracking iap revenue
178+
Add define symbol `VIRTUESKY_IAP` to use
179+
```csharp
180+
static void AppFlyerTrackingRevenueInAppPurchase(Product product)
181+
```
182+
183+
Example
184+
```csharp
185+
void TrackingRevenue(Product productIAP)
186+
{
187+
AppsFlyerTrackingRevenue.AppFlyerTrackingRevenueInAppPurchase(productIAP);
188+
}
189+
```
190+
#### App Tracking
191+
192+
- Tracking ad revenue (If calling `Track Revenue` through `App Tracking`, revenue will be tracked in all of Firebase Analytics, Adjust, and AppsFlyer)
193+
```csharp
194+
static void TrackRevenue(double value, string network, string unitId, string format, string adNetwork)
195+
```
196+
197+
Example
198+
199+
```csharp
200+
void TrackingRevenue()
201+
{
202+
AppTracking.TrackRevenue(...);
203+
}
204+
```
205+
206+
- Firebase tracking ATT Results IOS (App Tracking Transparency)
207+
- Require: `"com.unity.ads.ios-support": "1.2.0"`
208+
209+
```csharp
210+
static void FirebaseAnalyticTrackATTResult(int status)
211+
```
212+
213+
Example
214+
215+
```csharp
216+
void AppTrackingTransparency()
217+
{
218+
if (ATTrackingStatusBinding.GetAuthorizationTrackingStatus() ==
219+
ATTrackingStatusBinding.AuthorizationTrackingStatus.NOT_DETERMINED)
220+
{
221+
ATTrackingStatusBinding.RequestAuthorizationTracking(AppTracking.FirebaseAnalyticTrackATTResult);
222+
}
223+
}
224+
```

Runtime/AdjustTracking/AdjustTrackingRevenue.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ namespace VirtueSky.Tracking
66
{
77
public struct AdjustTrackingRevenue
88
{
9-
public static void AdjustTrackRevenue(double value, string network, string unitId,
10-
string placement, string adNetwork)
9+
public static void AdjustTrackRevenue(double value, string network, string unitId, string placement,
10+
string adNetwork)
1111
{
1212
#if VIRTUESKY_ADJUST
1313
var source = "";

Runtime/AppTracking.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ namespace VirtueSky.Tracking
77
{
88
public struct AppTracking
99
{
10-
public static void TrackRevenue(double value, string network, string unitId, string format,
11-
string adNetwork)
10+
public static void TrackRevenue(double value, string network, string unitId, string format, string adNetwork)
1211
{
1312
AdjustTrackingRevenue.AdjustTrackRevenue(value, network, unitId, format, adNetwork);
1413
FirebaseAnalyticTrackingRevenue.FirebaseAnalyticTrackRevenue(value, network, unitId,

Runtime/AppsFlyerTracking/AppsFlyerTrackingRevenue.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ namespace VirtueSky.Tracking
1313
{
1414
public struct AppsFlyerTrackingRevenue
1515
{
16-
public static void AppsFlyerTrackRevenueAd(double value, string network, string unitId,
17-
string format, string adNetwork)
16+
public static void AppsFlyerTrackRevenueAd(double value, string network, string unitId, string format,
17+
string adNetwork)
1818
{
1919
#if VIRTUESKY_APPSFLYER
2020
var mediationNetworks = AppsFlyerAdRevenueMediationNetworkType

Runtime/FirebaseTracking/FirebaseAnalyticTrackingRevenue.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ namespace VirtueSky.Tracking
66
{
77
public struct FirebaseAnalyticTrackingRevenue
88
{
9-
public static void FirebaseAnalyticTrackRevenue(double value, string network, string unitId,
10-
string format, string adNetwork)
9+
public static void FirebaseAnalyticTrackRevenue(double value, string network, string unitId, string format,
10+
string adNetwork)
1111
{
1212
#if VIRTUESKY_FIREBASE_ANALYTIC
1313
switch (adNetwork.ToLower())

0 commit comments

Comments
 (0)