Skip to content

Commit 0160379

Browse files
pwsegpwseg
committed
Remove automatic collection references
1 parent 78ccd4f commit 0160379

File tree

1 file changed

+10
-20
lines changed

1 file changed

+10
-20
lines changed

‎src/connections/spec/mobile.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ redirect_from:
66

77
One of the core components of the Segment [Spec](/docs/connections/spec/) is the [Track](/docs/connections/spec/track) method. It records any arbitrary event that the user has triggered. For Mobile tracking, in addition to Screen calls, you'll want to send **specific event names** that Segment recognizes semantically. That way, Segment can transform them correctly before sending them off to downstream destinations.
88

9-
By standardizing the events that comprise the core **mobile application lifecycle** and associated **mobile campaign and referral events**, Segment and its partners can, wherever possible, automatically collect and forward these events on your behalf and build downstream destinations which take full advantage of the semantic meaning associated with these events and their properties.
9+
By standardizing the events that comprise the core **mobile application lifecycle** and associated **mobile campaign and referral events**, Segment and its partners can, wherever possible, forward these events on your behalf and build downstream destinations that take full advantage of the semantic meaning associated with these events and their properties.
1010

1111
> info ""
1212
> If you're already collecting similar events, Segment recommends migrating to these event names so that you can take advantage of available features in Segment destinations that depend on the spec as they become available.
@@ -39,21 +39,13 @@ The Segment Native Mobile Spec includes the following semantic events:
3939

4040
Segment recommends using the above event names if you're going to be integrating the events yourself. This will ensure that they can be mapped effectively in downstream tools.
4141

42-
Additionally, though they're not formally part of the Native Mobile Spec, Segment also collects `Order Completed` from its ecommerce spec automatically upon in-app purchases on iOS and can collect screen views automatically in iOS and Android.
43-
4442
## Lifecycle events
4543

46-
Mobile applications live within a fairly bounded lifecycle. In order to understand and communicate effectively with your users, it's crucial to instrument the core flows associated with installing and opening your app. The following events, many of which Segment can capture automatically in the latest versions of Segment SDKs, allow you to get a picture of top-line metrics such as DAUs, MAUs, and Screen Views per session. Automatic tracking of lifecycle events is completely optional - you can learn how to enable and disable them in Segment's [iOS](https://segment.com/docs/connections/sources/catalog/libraries/mobile/ios/#step-2-install-the-sdk){:target="_blank"} and [Android](https://segment.com/docs/connections/sources/catalog/libraries/mobile/android/quickstart/#step-3-initialize-the-client){:target="_blank"} library docs.
47-
48-
The following events will be tracked automatically when lifecycle events are enabled:
49-
50-
- [Application Installed](#application-installed)
51-
- [Application Opened](#application-opened)
52-
- [Application Updated](#application-updated)
44+
Mobile applications live within a fairly bounded lifecycle. In order to understand and communicate effectively with your users, it's crucial to instrument the core flows associated with installing and opening your app. The following events, allow you to get a picture of top-line metrics such as DAUs, MAUs, and Screen Views per session. Automatic tracking of lifecycle events is completely optional - you can learn how to enable and disable them in Segment's [iOS](https://segment.com/docs/connections/sources/catalog/libraries/mobile/ios/#step-2-install-the-sdk){:target="_blank"} and [Android](https://segment.com/docs/connections/sources/catalog/libraries/mobile/android/quickstart/#step-3-initialize-the-client){:target="_blank"} library docs.
5345

5446
### Application Installed
5547

56-
This event fires when a user **first** opens your mobile application. Note, if the user never opens your app after installing, Segment will not be able to collect this event. This event doesn't wait for attribution or campaign information to be received, and is collected automatically by Segment's SDKs. Advertising providers like Facebook and Google require discrete install events to correctly attribute installs to ads served through their platform.
48+
This event fires when a user **first** opens your mobile application. Note, if the user never opens your app after installing, Segment will not be able to collect this event. This event doesn't wait for attribution or campaign information to be received. Advertising providers like Facebook and Google require discrete install events to correctly attribute installs to ads served through their platform.
5749

5850
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Application Installed", "properties": { "version": "1.2.3", "build": "1234" }}'}}} {% endcomment %}
5951

@@ -94,13 +86,13 @@ This event fires when a user launches or foregrounds your mobile application aft
9486
}
9587
```
9688

97-
| **Property** | **Type** | **Description** |
98-
| ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
89+
| **Property** | **Type** | **Description** |
90+
| ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9991
| `from_background` | Boolean | If application [transitioned](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/doc/uid/TP40006786-CH3-SW52){:target="_blank"} from "Background" to "Inactive" state prior to foregrounding (as opposed to from "Not Running" state). |
100-
| `url` | String | The value of `UIApplicationLaunchOptionsURLKey` from `launchOptions`. **Collected on iOS only**. |
101-
| `referring_application` | String | The value of `UIApplicationLaunchOptionsSourceApplicationKey` from `launchOptions`. **Automatically collected on iOS only**. |
102-
| `version` | String | The version installed. |
103-
| `build` | String | The build number of the installed app. |
92+
| `url` | String | The value of `UIApplicationLaunchOptionsURLKey` from `launchOptions`. **Collected on iOS only**. |
93+
| `referring_application` | String | The value of `UIApplicationLaunchOptionsSourceApplicationKey` from `launchOptions`. |
94+
| `version` | String | The version installed. |
95+
| `build` | String | The build number of the installed app. |
10496

10597

10698
### Application Backgrounded
@@ -120,7 +112,7 @@ This event should be sent when a user backgrounds the application upon [`applica
120112

121113
### Application Updated
122114

123-
This event fires when a user updates the application. Segment's SDK will automatically collect this event instead of an "Application Opened" event when Segment determines that the Open is first since an update.
115+
This event fires when a user updates the application.
124116

125117
{% comment %} api-example '{ "userId": "019mr8mf4r", "type": "track", "event": "Application Updated", "properties": { "previous_version": "1.1.2", "previous_build": 1234, "version": "1.2.0", "build": "1456" }}'}}} {% endcomment %}
126118

@@ -317,8 +309,6 @@ When your application is opened using a referring link, Segment or your packaged
317309

318310
This event is fired *in addition* to the associated `Application Opened` event.
319311

320-
Our [iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#automatic-deep-link-tracking) SDK can collect this event automatically if configured to do so.
321-
322312
{% comment %} api-example '{"userId": "019mr8mf4r", "type": "track", "event": "Deep Link Opened", "properties": {"provider": "Branch Metrics", "url": "app://landing" }}'}}} {% endcomment %}
323313

324314
```json

0 commit comments

Comments
 (0)