Skip to content

Commit 37fd615

Browse files
authored
Proofreading
Very few changes made.
1 parent e001e8e commit 37fd615

File tree

1 file changed

+18
-23
lines changed

1 file changed

+18
-23
lines changed

README.md

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Edit the parameters of the Adjust script in the `Inspector menu` of the added pr
6464

6565
![][adjust_editor]
6666

67-
You have the possibility to set up following options on the Adjust prefab:
67+
You have the possibility to set up the following options on the Adjust prefab:
6868

6969
* [Start Manually](#start-manually)
7070
* [Event Buffering](#event-buffering)
@@ -75,7 +75,7 @@ You have the possibility to set up following options on the Adjust prefab:
7575
* [Log Level](#log-level)
7676
* [Environment](#environment)
7777

78-
<a id="app-token">Replace `{YourAppToken}` with your App Token. You can find in your [dashboard].
78+
<a id="app-token">Replace `{YourAppToken}` with your actual App Token. You can find in your [dashboard].
7979

8080
<a id="environment">Depending on whether or not you build your app for testing or for production you must change
8181
`Environment` with one of these values:
@@ -158,7 +158,7 @@ The iOS build script is located at `Assets/Editor/PostprocessBuildPlayer_AdjustP
158158

159159
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.
160160

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

163163
If you have a custom build that puts the Unity iOS generated project in a different location, inform the script by
164164
clicking on the menu `Assets → Adjust → Set iOS build path` and choosing the build path of the iOS project.
@@ -169,8 +169,8 @@ messages of the script run.
169169
#### <a id="build-script-android">Android build script
170170

171171
The Android build script is located at `Assets/Editor/PostprocessBuildPlayer_AdjustPostBuildAndroid.py`. It changes the
172-
`AndroidManifest.xml` file located at `Assets/Plugins/Android/`. The problem with this approach is that, the manifest file
173-
used for the Android package was the one before the build process ended.
172+
`AndroidManifest.xml` file located at `Assets/Plugins/Android/`. The problem with this approach is that the manifest file
173+
used for the Android package was the same one as before the build process ended.
174174

175175
To mitigate this, simply run the build again, using the manifest created or changed by the previous run, or click on the
176176
menu `Assets → Adjust → Fix AndroidManifest.xml` so the script can run before the build process. Either way, it is only
@@ -181,7 +181,7 @@ necessary to do this step once, as long the manifest file remains compatible wit
181181
If there is no `AndroidManifest.xml` file at `Assets/Plugins/Android/` it creates a copy from our compatible manifest file
182182
`AdjustAndroidManifest.xml`. If there is already an `AndroidManifest.xml` file, it checks and changes the following:
183183

184-
1. Adds the adjust broadcast receiver. For more details consult the official [Android SDK README][android] for more details.
184+
1. Adds the adjust broadcast receiver. For more details, consult the official [Android SDK README][android].
185185
Please, have in mind that if you are using your **own broadcast receiver** which handles `INSTALL_REFERRER` intent, you
186186
don't need the adjust broadcast receiver to be added in your manifest file. Remove it, but inside your own receiver add the
187187
call to the adjust broadcast receiver like described in [Android guide][android-custom-receiver].
@@ -199,7 +199,7 @@ Once you integrated the adjust SDK into your project, you can take advantage of
199199

200200
### <a id="event-tracking">Event tracking
201201

202-
You can tell adjust about any event you wish. Suppose you want to track every tap on a button. You would have to create a
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
203203
new Event Token in your [dashboard]. Let's say that Event Token is `abc123`. In your button's click handler method you could
204204
then add the following lines to track the click:
205205

@@ -211,7 +211,7 @@ Adjust.trackEvent (adjustEvent);
211211
#### <a id="revenue-tracking">Revenue tracking
212212

213213
If your users can generate revenue by tapping on advertisements or making In-App Purchases you can track those revenues with
214-
events. Lets say a tap is worth one Euro cent. You could then track the revenue event like this:
214+
events. Let's say a tap is worth one Euro cent. You could then track the revenue event like this:
215215

216216
```cs
217217
AdjustEvent adjustEvent = new AdjustEvent ("abc123");
@@ -247,7 +247,7 @@ receipt verification tool, then check out our `Unity purchase SDK` and read more
247247
#### <a id="callback-parameters">Callback parameters
248248

249249
You can also register a callback URL for that event in your [dashboard] and we will send a GET request to that URL whenever
250-
the event gets tracked. In that case you can also put some key-value-pairs in an object and pass it to the `trackEvent`
250+
the event gets tracked. In that case you can also put some key-value pairs in an object and pass it to the `trackEvent`
251251
method. We will then append these named parameters to your callback URL.
252252

253253
For example, suppose you have registered the URL `http://www.adjust.com/callback` for your event with Event Token `abc123`
@@ -268,9 +268,9 @@ In that case we would track the event and send a request to:
268268
http://www.adjust.com/callback?key=value&foo=bar
269269
```
270270

271-
It should be mentioned that we support a variety of placeholders like `{idfa}` for iOS or `{android_id}` for Android that
271+
It should be mentioned that we support a variety of placeholders like `{idfa}` for iOS or `{gps_adid}` for Android that
272272
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 `{android_id}` would be replaced with the AndroidID of the current device
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
274274
for Android. Also note that we don't store any of your custom parameters, but only append them to your callbacks. If you
275275
haven't registered a callback for an event, these parameters won't even be read.
276276

@@ -296,7 +296,7 @@ You can read more about special partners and these integrations in our [guide to
296296
### <a id="attribution-callback">Attribution callback
297297

298298
You can register a callback to be notified of tracker attribution changes. Due to the different sources considered for
299-
attribution, this information can not by provided synchronously. Follow these steps to implement the optional callback in
299+
attribution, this information cannot be provided synchronously. Follow these steps to implement the optional callback in
300300
your application:
301301

302302
Please make sure to consider [applicable attribution data policies][attribution_data].
@@ -351,7 +351,7 @@ public class ExampleGUI : MonoBehaviour {
351351

352352
### <a id="session-event-callbacks">Session and event callbacks
353353

354-
You can register a callback to be notified of successful and failed tracked events and/or sessions.
354+
You can register a callback to be notified of successful and failed events and/or sessions.
355355

356356
Follow the same steps to implement the following callback function for successful tracked events:
357357

@@ -461,8 +461,7 @@ adjust SDK by invoking `setEnabled` with the `enabled` parameter set to `true`.
461461
### <a id="offline-mode">Offline mode
462462

463463
You can put the adjust SDK in offline mode to suspend transmission to our servers, while retaining tracked data to be sent
464-
later. While in offline mode, all information is saved in a file, so be careful not to trigger too many events while in
465-
offline mode.
464+
later. When in offline mode, all information is saved in a file, so be careful not to trigger too many events.
466465

467466
You can activate offline mode by calling `setOfflineMode` with the parameter `true`.
468467

@@ -473,7 +472,7 @@ Adjust.setOfflineMode(true);
473472
Conversely, you can deactivate offline mode by calling `setOfflineMode` with `false`. When the adjust SDK is put back in
474473
online mode, all saved information is send to our servers with the correct time information.
475474

476-
Unlike disabling tracking, **this setting is not remembered** bettween sessions. This means that the SDK is in online mode
475+
Unlike disabling tracking, **this setting is not remembered** between sessions. This means that the SDK is in online mode
477476
whenever it is started, even if the app was terminated in offline mode.
478477

479478
### <a id="event-buffering">Event buffering
@@ -489,11 +488,11 @@ adjustConfig.setEventBufferingEnabled (true);
489488
Adjust.start (adjustConfig);
490489
```
491490

492-
If nothing set, event buffering is **disabled by default**.
491+
If nothing is set, event buffering is **disabled by default**.
493492

494493
### <a id="background-tracking">Background tracking
495494

496-
The default behaviour of the adjust SDK is to **pause sending HTTP requests while the app is on the background**. You can
495+
The default behaviour of the adjust SDK is to **pause sending HTTP requests while the app is in the background**. You can
497496
change this in your `AdjustConfig` instance:
498497

499498
```csharp
@@ -535,11 +534,7 @@ Adjust.getIdfa ()
535534

536535
**Deep linking is supported only on iOS and Android platforms.**
537536

538-
If you are using the adjust tracker URL with an option to deep link into your app from the URL, the adjust SDK offers you
539-
the possibility to get info about the deep link URL and its content. Since hitting the URL can happen if your user has your
540-
app already installed (standard deep linking scenario) or if they don't have the app on their device (deferred deep linking
541-
scenario), the adjust SDK offers you two methods for getting the URL content, based on the deep linking scenario that
542-
happened.
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.
543538

544539
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).
545540

0 commit comments

Comments
 (0)