Skip to content

Commit 64b6729

Browse files
authored
Merge pull request #72 from adjust/readme_update
Readme update
2 parents fcf257a + b9aa43a commit 64b6729

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

README.md

+24-15
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ You have the possibility to set up the following options on the Adjust prefab:
7070
* [Event Buffering](#event-buffering)
7171
* [Print Attribution](#attribution-callback)
7272
* [Send In Background](#background-tracking)
73-
* [Launch Deferred Deep Link](#deferred-deeplink-callback)
73+
* [Launch Deferred Deep Link](#deeplinking-deferred-open)
7474
* [App Token](#app-token)
75-
* [Log Level](#log-level)
75+
* [Log Level](#adjust-logging)
7676
* [Environment](#environment)
7777

7878
<a id="app-token">Replace `{YourAppToken}` with your actual App Token. You can find in your [dashboard].
@@ -156,7 +156,8 @@ Press the same button to re-enable it.
156156

157157
The iOS build script is located at `Assets/Editor/PostprocessBuildPlayer_AdjustPostBuildiOS.py`. It changes the Unity iOS generated project in the following ways:
158158

159-
1. Adds the `iAd.framework` and `AdSupport.framework` to the project. This is required by the adjust SDK - check out the official [iOS SDK README][ios] for more details.
159+
1. Adds the `iAd.framework` and `AdSupport.framework` to the project. This is required by the adjust SDK - check out the
160+
official [iOS SDK README][ios] for more details.
160161

161162
2. Adds the other linker flag `-ObjC`. This allows the adjust Objective-C categories to be recognized during build time.
162163

@@ -199,9 +200,9 @@ Once you integrated the adjust SDK into your project, you can take advantage of
199200

200201
### <a id="event-tracking">Event tracking
201202

202-
You can tell adjust about any event you wish. Suppose you want to track every tap on a button. You would just need to create a
203-
new Event Token in your [dashboard]. Let's say that Event Token is `abc123`. In your button's click handler method you could
204-
then add the following lines to track the click:
203+
You can tell adjust about any event you wish. Suppose you want to track every tap on a button. You would just need to create
204+
a new Event Token in your [dashboard]. Let's say that Event Token is `abc123`. In your button's click handler method you
205+
could then add the following lines to track the click:
205206

206207
```cs
207208
AdjustEvent adjustEvent = new AdjustEvent ("abc123");
@@ -270,9 +271,9 @@ http://www.adjust.com/callback?key=value&foo=bar
270271

271272
It should be mentioned that we support a variety of placeholders like `{idfa}` for iOS or `{gps_adid}` for Android that
272273
can be used as parameter values. In the resulting callback the `{idfa}` placeholder would be replaced with the ID for
273-
Advertisers of the current device for iOS and the `{gps_adid}` would be replaced with the Google Play Services ID of the current device
274-
for Android. Also note that we don't store any of your custom parameters, but only append them to your callbacks. If you
275-
haven't registered a callback for an event, these parameters won't even be read.
274+
Advertisers of the current device for iOS and the `{gps_adid}` would be replaced with the Google Play Services ID of the
275+
current device for Android. Also note that we don't store any of your custom parameters, but only append them to your
276+
callbacks. If you haven't registered a callback for an event, these parameters won't even be read.
276277

277278
#### <a id="partner-parameters">Partner parameters
278279

@@ -534,14 +535,21 @@ Adjust.getIdfa ()
534535

535536
**Deep linking is supported only on iOS and Android platforms.**
536537

537-
If you are using the adjust tracker URL with an option to deep link into your app from the URL, there is the possibility to get info about the deep link URL and its content. Hitting the URL can happen when the user has your app already installed (standard deep linking scenario) or if they don't have the app on their device (deferred deep linking scenario). In the standard deep linking scenario, Android platform natively offers the possibility for you to get the info about the deep link content. Deferred deep linking scenario is something which Android platform doesn't support out of box and for this case, the adjust SDK will offer you the mechanism to get the info about the deep link content.
538+
If you are using the adjust tracker URL with an option to deep link into your app from the URL, there is the possibility to
539+
get info about the deep link URL and its content. Hitting the URL can happen when the user has your app already installed
540+
(standard deep linking scenario) or if they don't have the app on their device (deferred deep linking scenario). In the
541+
standard deep linking scenario, Android platform natively offers the possibility for you to get the info about the deep link
542+
content. Deferred deep linking scenario is something which Android platform doesn't support out of box and for this case,
543+
the adjust SDK will offer you the mechanism to get the info about the deep link content.
538544

539-
You need to set up deep linking handling in your app **on native level** - in your generated Xcode project (for iOS) and Android Studio / Eclipse project (for Android).
545+
You need to set up deep linking handling in your app **on native level** - in your generated Xcode project (for iOS) and
546+
Android Studio / Eclipse project (for Android).
540547

541548
#### <a id="deeplinking-standard">Standard deep linking scenario
542549

543550
Unfortunatelly, in this scenario the information about the deep link can not be delivered to you in your Unity C# code.
544-
Once you enable your app to handle deep linking, you will get information about the deep link on native level. For more information check our chapters below on how to enable deep linking for Android and iOS apps.
551+
Once you enable your app to handle deep linking, you will get information about the deep link on native level. For more
552+
information check our chapters below on how to enable deep linking for Android and iOS apps.
545553

546554
#### <a id="deeplinking-deferred">Deferred deep linking scenario
547555

@@ -566,9 +574,10 @@ adjustConfig.setDeferredDeeplinkDelegate (DeferredDeeplinkCallback);
566574
Adjust.start (adjustConfig);
567575
```
568576

569-
In deferred deep linking scenario, there is one additional setting which can be set on the `AdjustConfig` object. Once the
570-
adjust SDK gets the deferred deep link info, we are offering you the possibility to choose whether our SDK should open this
571-
URL or not. You can choose to set this option by calling the `setLaunchDeferredDeeplink` method on the config object:
577+
<a id="deeplinking-deferred-open">In deferred deep linking scenario, there is one additional setting which can be set on the
578+
`AdjustConfig` object. Once the adjust SDK gets the deferred deep link info, we are offering you the possibility to choose
579+
whether our SDK should open this URL or not. You can choose to set this option by calling the `setLaunchDeferredDeeplink`
580+
method on the config object:
572581

573582
```cs
574583
// ...

0 commit comments

Comments
 (0)