Skip to content

Commit 94e35bf

Browse files
authored
Update API.md
1 parent 2904561 commit 94e35bf

File tree

1 file changed

+207
-0
lines changed

1 file changed

+207
-0
lines changed

docs/API.md

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,18 @@ The list of available methods for this plugin is described below.
5353
- [validateAndSendInAppPurchase](#validateAndSendInAppPurchase)
5454
- [registerUninstall](#registerUninstall)
5555
- [handleOpenUrl](#handleOpenUrl)
56+
- [IAppsFlyerConversionData](#IAppsFlyerConversionData)
57+
- [onConversionDataSuccess](#onConversionDataSuccess)
58+
- [onConversionDataFail](#onConversionDataFail)
59+
- [onAppOpenAttribution](#onAppOpenAttribution)
60+
- [onAppOpenAttributionFailure](#onAppOpenAttributionFailure)
61+
- [IAppsFlyerUserInvite](#IAppsFlyerUserInvite)
62+
- [onInviteLinkGenerated](#onInviteLinkGenerated)
63+
- [onInviteLinkGeneratedFailure](#onInviteLinkGeneratedFailure)
64+
- [onOpenStoreLinkGenerated](#onOpenStoreLinkGenerated)
65+
- [IAppsFlyerValidateReceipt](#IAppsFlyerValidateReceipt)
66+
- [didFinishValidateReceipt](#didFinishValidateReceipt)
67+
- [didFinishValidateReceiptWithError](#didFinishValidateReceiptWithError)
5668

5769
---
5870

@@ -1004,3 +1016,198 @@ Register uninstall - you should register for remote notification and provide App
10041016
```
10051017

10061018
---
1019+
1020+
## <a id="IAppsFlyerConversionData"> IAppsFlyerConversionData
1021+
1022+
##### <a id="onConversionDataSuccess"> **`public void onConversionDataSuccess(string conversionData)`**
1023+
1024+
ConversionData contains information about install.<br> Organic/non-organic, etc. See [here](https://support.appsflyer.com/hc/en-us/articles/360000726098-Conversion-Data-Scenarios#Introduction) for more info.
1025+
1026+
| parameter | type | description |
1027+
| ---------- |---------- |--------------------|
1028+
| `conversionData` | `string` | JSON string of the returned conversion data |
1029+
1030+
1031+
*Example:*
1032+
1033+
```c#
1034+
public void onConversionDataSuccess(string conversionData)
1035+
{
1036+
AppsFlyer.AFLog("onConversionDataSuccess", conversionData);
1037+
Dictionary<string, object> conversionDataDictionary = AppsFlyer.CallbackStringToDictionary(conversionData);
1038+
// add deferred deeplink logic here
1039+
}
1040+
```
1041+
1042+
---
1043+
1044+
##### <a id="onConversionDataFail"> **`public void onConversionDataFail(string error)`**
1045+
1046+
1047+
| parameter | type | description |
1048+
| ---------- |---------- |--------------------|
1049+
| `error` | `string` | A string describing the error |
1050+
1051+
1052+
*Example:*
1053+
1054+
```c#
1055+
public void onConversionDataFail(string error)
1056+
{
1057+
AppsFlyer.AFLog("onConversionDataFail", error);
1058+
}
1059+
```
1060+
1061+
---
1062+
1063+
##### <a id="onAppOpenAttribution"> **`public void onAppOpenAttribution(string attributionData)`**
1064+
1065+
attributionData contains information about OneLink, deeplink.
1066+
1067+
| parameter | type | description |
1068+
| ---------- |---------- |--------------------|
1069+
| `attributionData` | `string` | JSON string of the returned deeplink data |
1070+
1071+
1072+
*Example:*
1073+
1074+
```c#
1075+
public void onAppOpenAttribution(string attributionData)
1076+
{
1077+
AppsFlyer.AFLog("onAppOpenAttribution", attributionData);
1078+
Dictionary<string, object> attributionDataDictionary = AppsFlyer.CallbackStringToDictionary(attributionData);
1079+
// add direct deeplink logic here
1080+
}
1081+
```
1082+
1083+
---
1084+
1085+
##### <a id="onAppOpenAttributionFailure"> **`public void onAppOpenAttributionFailure(string error)`**
1086+
1087+
Any errors that occurred during the attribution request.
1088+
1089+
| parameter | type | description |
1090+
| ---------- |---------- |--------------------|
1091+
| `error` | `string` | string describing the error |
1092+
1093+
1094+
*Example:*
1095+
1096+
```c#
1097+
public void onAppOpenAttributionFailure(string error)
1098+
{
1099+
AppsFlyer.AFLog("onAppOpenAttributionFailure", error);
1100+
}
1101+
```
1102+
1103+
---
1104+
1105+
## <a id="IAppsFlyerUserInvite"> IAppsFlyerUserInvite
1106+
1107+
##### <a id="onInviteLinkGenerated"> **`public void onInviteLinkGenerated(string link)`**
1108+
1109+
The success callback for generating OneLink URLs.
1110+
1111+
| parameter | type | description |
1112+
| ---------- |---------- |--------------------|
1113+
| `link` | `string` | generated link |
1114+
1115+
1116+
*Example:*
1117+
1118+
```c#
1119+
public void onInviteLinkGenerated(string link)
1120+
{
1121+
1122+
}
1123+
```
1124+
1125+
---
1126+
1127+
##### <a id="onInviteLinkGeneratedFailure"> **`public void onInviteLinkGeneratedFailure(string error)`**
1128+
1129+
The error callback for generating OneLink URLs
1130+
1131+
| parameter | type | description |
1132+
| ---------- |---------- |--------------------|
1133+
| `error` | `string` | A string describing the error |
1134+
1135+
1136+
*Example:*
1137+
1138+
```c#
1139+
public void onInviteLinkGeneratedFailure(string error)
1140+
{
1141+
AppsFlyer.AFLog("onInviteLinkGeneratedFailure", error);
1142+
}
1143+
```
1144+
1145+
---
1146+
1147+
##### <a id="onOpenStoreLinkGenerated"> **`public void onOpenStoreLinkGenerated(string link)`**
1148+
1149+
1150+
(ios only) iOS allows you to utilize the StoreKit component to open
1151+
the App Store while remaining in the context of your app.<br>
1152+
More details at [here](https://support.appsflyer.com/hc/en-us/articles/115004481946-Cross-Promotion-Tracking#tracking-cross-promotion-impressions)
1153+
1154+
1155+
| parameter | type | description |
1156+
| ---------- |---------- |--------------------|
1157+
| `attributionData` | `string` | JSON string of the returned deeplink data |
1158+
1159+
1160+
*Example:*
1161+
1162+
```c#
1163+
public void onOpenStoreLinkGenerated(string link)
1164+
{
1165+
1166+
}
1167+
```
1168+
1169+
---
1170+
1171+
## <a id="IAppsFlyerValidateReceipt"> IAppsFlyerValidateReceipt
1172+
1173+
##### <a id="didFinishValidateReceipt"> **`public void didFinishValidateReceipt(string result)`**
1174+
1175+
The success callback for validateAndSendInAppPurchase API.<br>
1176+
For Android : the callback will return "Validate success".<br>
1177+
For iOS : the callback will return a JSON string from apples verifyReceipt API. <br>
1178+
1179+
| parameter | type | description |
1180+
| ---------- |---------- |--------------------|
1181+
| `result` | `string` | validate result |
1182+
1183+
1184+
*Example:*
1185+
1186+
```c#
1187+
public void didFinishValidateReceipt(string link)
1188+
{
1189+
1190+
}
1191+
```
1192+
1193+
---
1194+
1195+
##### <a id="didFinishValidateReceiptWithError"> **`public void didFinishValidateReceiptWithError(string error)`**
1196+
1197+
The error callback for validating receipts.<br>
1198+
1199+
| parameter | type | description |
1200+
| ---------- |---------- |--------------------|
1201+
| `error` | `string` | A string describing the error |
1202+
1203+
1204+
*Example:*
1205+
1206+
```c#
1207+
public void didFinishValidateReceiptWithError(string error)
1208+
{
1209+
1210+
}
1211+
```
1212+
1213+
---

0 commit comments

Comments
 (0)