Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adapp 16872 port unity documentation #266

Merged
merged 42 commits into from
Oct 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
194df4d
feat(docs): add Unity get started guide
Sporiff Oct 19, 2023
4bb1b59
feat(docs): Add ATT documentation for Unity
Sporiff Oct 19, 2023
de75635
feat(docs): Add background recording docs
Sporiff Oct 19, 2023
506048d
feat(docs): Add delay start documentation
Sporiff Oct 19, 2023
952cd79
feat(docs): Add disable SDK docs
Sporiff Oct 19, 2023
560db7a
feat(docs): Add external device ID documentation
Sporiff Oct 19, 2023
0d91006
feat(docs): add log level documentation
Sporiff Oct 19, 2023
8830311
feat(docs): Add more logging information
Sporiff Oct 19, 2023
674b426
feat(docs): Add preinstalled app documentation
Sporiff Oct 19, 2023
3702137
feat(docs): Add index page
Sporiff Oct 19, 2023
cf1f210
feat(docs): Add privacy configuration unity
Sporiff Oct 20, 2023
47f4823
feat(docs): Add push token docs
Sporiff Oct 20, 2023
7e1e78c
feat(docs): Add Unity SKAN config docs
Sporiff Oct 20, 2023
f69c10e
feat(docs): Add Unity deep linking docs
Sporiff Oct 20, 2023
fccbd00
feat(docs): Add IMEI plugin Unity
Sporiff Oct 20, 2023
6aea04c
feat(docs): Add OAID plugin docs Unity
Sporiff Oct 20, 2023
512bd1f
fix(docs): correct abbreviations
Sporiff Oct 20, 2023
b8842ab
feat(docs): add SDK integration docs
Sporiff Oct 20, 2023
b8c4c33
fix(docs): Correct platform
Sporiff Oct 20, 2023
bee8bda
fix(docs): Correct abbreviations
Sporiff Oct 20, 2023
7f75da9
feat(docs): Add ad revenue docs Unity
Sporiff Oct 20, 2023
68a9cd7
feat(docs): Add attribution docs Unity
Sporiff Oct 20, 2023
39da956
feat(docs): Add device ID article Unity
Sporiff Oct 20, 2023
acbf6f7
feat(docs): Add session parameter unity
Sporiff Oct 20, 2023
a241ad2
feat(docs): add Unity event recording
Sporiff Oct 22, 2023
23c4e90
feat(docs): Add feature overview page
Sporiff Oct 22, 2023
1b3ef9f
feat(docs): Add subscription docs Unity
Sporiff Oct 22, 2023
917a05c
feat(docs): Add callbacks article Unity
Sporiff Oct 22, 2023
204067e
feat(docs): Add ad revenue class ref Unity
Sporiff Oct 22, 2023
a0b0fc2
feat(docs): Add Attribution class ref Unity
Sporiff Oct 22, 2023
de0c8df
fix(docs): move attribution class reference
Sporiff Oct 22, 2023
21105ac
feat(docs): add event class ref Unity
Sporiff Oct 22, 2023
59a71c1
fix(docs): correct data types
Sporiff Oct 22, 2023
cd5ada7
fix(docs): move ad revenue file
Sporiff Oct 22, 2023
178658b
feat(docs): Add third party ref Unity
Sporiff Oct 22, 2023
9e192f3
feat(docs): Add adjustconfig reference Unity
Sporiff Oct 22, 2023
6669238
feat(docs): add Adjust class ref Unity
Sporiff Oct 22, 2023
85eb372
feat(docs): Add app store subscription ref Unity
Sporiff Oct 22, 2023
53fa412
feat(docs): add play store subscription ref Unity
Sporiff Oct 22, 2023
6551af4
fix(docs): fix import paths
Sporiff Oct 22, 2023
499a464
fix(docs): fix import path
Sporiff Oct 22, 2023
345c285
fix(docs): Fix broken import
Sporiff Oct 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/styles/Microsoft/HeadingAcronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ exceptions:
- CSV
- ATT
- CDN
- MSA
- HMS
5 changes: 5 additions & 0 deletions .vscode/markdown.code-snippets
Original file line number Diff line number Diff line change
Expand Up @@ -111,5 +111,10 @@
"</Tab>",
"</Tabs>"
]
},
"Abbreviation": {
"prefix": "abbreviation",
"description": "Insert an abbreviation",
"body": "<Abbr>${0:$TM_SELECTED_TEXT}</Abbr>"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.addSessionCallbackParameter("key", "value");
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.addSessionPartnerParameter("key", "value");
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.getAppTrackingAuthorizationStatus();
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.checkForNewAttStatus();
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.disableThirdPartySharing();
```
3 changes: 3 additions & 0 deletions src/content/docs/code-snippets/unity/Adjust/_gdprForgetMe.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.gdprForgetMe();
```
3 changes: 3 additions & 0 deletions src/content/docs/code-snippets/unity/Adjust/_getAdid.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
string adid = Adjust.getAdid();
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
string amazonAdId = Adjust.getAmazonAdId();
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
var attribution = Adjust.getAttribution();
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```c#
Adjust.getGoogleAdId((string googleAdId) => {
//...
}};
```
3 changes: 3 additions & 0 deletions src/content/docs/code-snippets/unity/Adjust/_getIdfa.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
string idfa = Adjust.getIdfa();
```
3 changes: 3 additions & 0 deletions src/content/docs/code-snippets/unity/Adjust/_isEnabled.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.isEnabled();
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.removeSessionCallbackParameter("key");
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.removeSessionPartnerParameter("key");
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
```c#
Adjust.requestTrackingAuthorizationWithCompletionHandler((status) =>
{
switch (status)
{
case 0:
// ATTrackingManagerAuthorizationStatusNotDetermined case
break;
case 1:
// ATTrackingManagerAuthorizationStatusRestricted case
break;
case 2:
// ATTrackingManagerAuthorizationStatusDenied case
break;
case 3:
// ATTrackingManagerAuthorizationStatusAuthorized case
break;
}
});
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.resetSessionCallbackParameters();
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.resetSessionPartnerParameters();
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.sendFirstPackages();
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.setDeviceToken("{YourDeviceToken}");
```
3 changes: 3 additions & 0 deletions src/content/docs/code-snippets/unity/Adjust/_setEnabled.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.setEnabled(false);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.setOfflineMode(true);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```c#
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
//...
Adjust.trackAdRevenue(adjustAdRevenue);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```c#
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
price,
currency,
transactionId,
receipt);
subscription.setTransactionDate(transactionDate);
subscription.setSalesRegion(salesRegion);
subscription.addCallbackParameter("key1", "value1");
subscription.addCallbackParameter("key2", "value2");
subscription.addPartnerParameter("key1", "value1");
subscription.addPartnerParameter("key2", "value2");

Adjust.trackAppStoreSubscription(subscription);
```
5 changes: 5 additions & 0 deletions src/content/docs/code-snippets/unity/Adjust/_trackEvent.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```c#
AdjustEvent adjustEvent = new AdjustEvent("abc123");
//...
Adjust.trackEvent(adjustEvent);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.trackMeasurementConsent(true);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```c#
AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription(
price,
currency,
sku,
orderId,
signature,
purchaseToken);
subscription.setPurchaseTime(purchaseTime);
subscription.addCallbackParameter("key1", "value1");
subscription.addCallbackParameter("key2", "value2");
subscription.addPartnerParameter("key1", "value1");
subscription.addPartnerParameter("key2", "value2");

Adjust.trackPlayStoreSubscription(subscription);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```c#
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
//...
Adjust.trackThirdPartySharing(adjustThirdPartySharing);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```c#
Adjust.updateConversionValue(6);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
//...
adjustAdRevenue.addCallbackParameter("key", "value");
//...
Adjust.trackAdRevenue(adjustAdRevenue);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
//...
adjustAdRevenue.addPartnerParameter("key", "value");
//...
Adjust.trackAdRevenue(adjustAdRevenue);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```c#
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
Adjust.trackAdRevenue(adjustAdRevenue);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
//...
adjustAdRevenue.setAdImpressionsCount(10);
//...
Adjust.trackAdRevenue(adjustAdRevenue);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
//...
adjustAdRevenue.setAdRevenueNetwork("network1");
//...
Adjust.trackAdRevenue(adjustAdRevenue);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
//...
adjustAdRevenue.setAdRevenuePlacement("banner");
//...
Adjust.trackAdRevenue(adjustAdRevenue);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
//...
adjustAdRevenue.setAdRevenueUnit("unit1");
//...
Adjust.trackAdRevenue(adjustAdRevenue);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
//...
adjustAdRevenue.setRevenue(1.00, "EUR");
//...
Adjust.trackAdRevenue(adjustAdRevenue);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
```c#
public void addPartnerParameter(string key, string value)
{
if (partnerList == null)
{
partnerList = new List<string>();
}
partnerList.Add(key);
partnerList.Add(value);
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
```c#
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
price,
currency,
transactionId,
receipt);
//...
subscription.addCallbackParameter("key1", "value1");
subscription.addCallbackParameter("key2", "value2");
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
```c#
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
price,
currency,
transactionId,
receipt);
//...
subscription.addPartnerParameter("key1", "value1");
subscription.addPartnerParameter("key2", "value2");
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
price,
currency,
transactionId,
receipt);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
```c#
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
price,
currency,
transactionId,
receipt);
//...
subscription.setSalesRegion(salesRegion);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
```c#
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
price,
currency,
transactionId,
receipt);
//...
subscription.setTransactionDate(transactionDate);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```c#
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
// ...
Adjust.start(adjustConfig);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true);
//...
adjustConfig.deactivateSKAdNetworkHandling();
//...
Adjust.start(adjustConfig);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
//...
adjustConfig.setSendInBackground(true);
//...
Adjust.start(adjustConfig);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
```c# {8, 13-16}
using com.adjust.sdk;

public class ExampleGUI : MonoBehaviour {
void OnGUI() {
if (GUI.Button(new Rect(0, 0, Screen.width, Screen.height), "callback")) {
AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironmentSandbox);
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);
adjustConfig.setAttributionChangedDelegate(this.attributionChangedDelegate);
Adjust.start(adjustConfig);
}
}

public void attributionChangedDelegate(AdjustAttribution attribution) {
Debug.Log("Attribution changed");
// ...
}
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true);
//...
adjustConfig.setConversionValueUpdatedDelegate(ConversionValueUpdatedCallback);
//...
Adjust.start(adjustConfig);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```c#
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
adjustConfig.setCoppaCompliantEnabled(true);
Adjust.start(adjustConfig);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
//...
adjustConfig.setDefaultTracker("{TrackerToken}");
//...
Adjust.start(adjustConfig);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
//...
adjustConfig.setDelayStart(5.5);
//...
Adjust.start(adjustConfig);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```c#
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
//...
adjustConfig.setEventBufferingEnabled(true);
//...
Adjust.start(adjustConfig);
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
```c# {3, 7-9}
AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox);
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);
adjustConfig.setEventFailureDelegate(EventFailureCallback);
//...
Adjust.start(adjustConfig);
//...
public void EventFailureCallback(AdjustEventFailure eventFailureData) {
//...
}
```
Loading
Loading