Skip to content

Commit c9e5cf1

Browse files
Merge pull request #8017 from lopenchi/develop
Small fixes - Batch 2.4
2 parents 182b976 + 7bafafa commit c9e5cf1

File tree

8 files changed

+57
-35
lines changed

8 files changed

+57
-35
lines changed

src/connections/sources/catalog/cloud-apps/wootric/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Below is a table of events that InMoment sends to Segment. These events will sho
2424

2525

2626
| Event Name | Description |
27-
| ------------------------------- | --------------------------------------- | |
27+
| ------------------------------- | --------------------------------------- |
2828
| Wootric survey response created | A survey response was created |
2929
| Wootric survey response updated | An existing survey response was updated |
3030

@@ -33,7 +33,7 @@ Below is a table of events that InMoment sends to Segment. These events will sho
3333
Below are tables outlining the properties included in the events listed above.
3434

3535
| Property Name | Description |
36-
| ------------- | --------------------------------------------------------------------- | |
36+
| ------------- | --------------------------------------------------------------------- |
3737
| channel | The channel from which the survey was responded like ‘web' or ‘email' |
3838
| created_at | The timestamp of when the response was created |
3939
| metric_type | The mode of the survey like "NPS" or “CSAT” |

src/connections/sources/catalog/libraries/mobile/amp/index.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ If you're new to [AMP](https://www.ampproject.org){:target="_blank"}, go through
1717
### Step 1: Include AMP component
1818
Before the closing `</head>` tag, include the [`amp-analytics` component](https://www.ampproject.org/docs/reference/components/amp-analytics){:target="_blank"}:
1919

20-
```js
20+
```js
2121
<script async custom-element="amp-analytics" src="https://cdn.ampproject.org/v0/amp-analytics-0.1.js"></script>
22-
```
22+
```
2323

2424
### Step 2: Include Segment analytics
2525
Within your `<body>` tags, include the following Segment analytics snippet:
2626

27-
```html
27+
```html
2828
<body>
2929
<amp-analytics type="segment">
3030
<script type="application/json">
@@ -37,12 +37,12 @@ Within your `<body>` tags, include the following Segment analytics snippet:
3737
</script>
3838
</amp-analytics>
3939
</body>
40-
```
40+
```
4141
Replace `WRITE_KEY` with the write key you obtain from the AMP Source you've set up within the Segment UI.
4242

4343
For sources in [EU workspaces](/docs/guides/regional-segment/), use the following snippet:
4444

45-
```html
45+
```html
4646
<amp-analytics type="segment">
4747
<script type="application/json">
4848
{
@@ -55,7 +55,7 @@ For sources in [EU workspaces](/docs/guides/regional-segment/), use the followin
5555
}
5656
</script>
5757
</amp-analytics>
58-
```
58+
```
5959

6060
By default, the snippet will automatically fire a page event which you can read more about [in the Page section of this documentation](/docs/connections/sources/catalog/libraries/mobile/amp/#page).
6161

@@ -66,7 +66,7 @@ The Page method lets you record page views on your website, along with your choi
6666

6767
A `page` call is included by default when you include Segment Analytics into your code with the ability to customize the `name` of your page:
6868

69-
```html
69+
```html
7070
<amp-analytics type="segment">
7171
<script type="application/json">
7272
{
@@ -77,15 +77,15 @@ A `page` call is included by default when you include Segment Analytics into you
7777
}
7878
</script>
7979
</amp-analytics>
80-
```
80+
```
8181

8282
## Track
8383

8484
The Track method (referred to as `click` in AMP) lets you record any actions your users perform.
8585

8686
In order to track these `click` events simply add a trigger with a `selector`, which behaves the same way as [CSS Selectors](https://www.w3schools.com/cssref/css_selectors.asp){:target="_blank"}, which will send that event once the user clicks:
8787

88-
```html
88+
```html
8989
<body>
9090
<amp-analytics type="segment">
9191
<script type="application/json">
@@ -109,15 +109,15 @@ In order to track these `click` events simply add a trigger with a `selector`, w
109109
</amp-analytics>
110110
<button class="read-more-button">Read More</button>
111111
</body>
112-
```
112+
```
113113

114114
## Properties
115115

116116
### Default properties
117117

118118
A few properties are automatically collected with each page view and track call:
119119

120-
```json
120+
```json
121121
{
122122
"anonymousId": "amp-<unique-id>",
123123
"context.locale": "en-US",
@@ -128,13 +128,13 @@ A few properties are automatically collected with each page view and track call:
128128
"context.screen.width": 600,
129129
"context.screen.height": 800
130130
}
131-
```
131+
```
132132

133133
### Custom properties
134134

135135
If you would like to collect additional, custom properties, include an `extraUrlParams` object. All properties you'd like to include must follow the format of `properties.<property_name>`:
136136

137-
```html
137+
```html
138138
<amp-analytics type="segment">
139139
<script type="application/json">
140140
{
@@ -152,7 +152,7 @@ If you would like to collect additional, custom properties, include an `extraUrl
152152
}
153153
</script>
154154
</amp-analytics>
155-
```
155+
```
156156

157157
### UTM parameters
158158

@@ -226,4 +226,3 @@ For further details refer to the various `Client ID` scenarios in relation to AM
226226
<!-- TODO: the product linked above was deprecated, need to find a replacement or hide this page --->
227227

228228
See a live <a href="https://segment-amp.firebaseapp.com">AMP with Segment analytics</a>
229-
<link rel="amphtml" href="https://segment-amp.firebaseapp.com">

src/connections/sources/catalog/libraries/mobile/android/wear.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,21 @@ analytics.track("Purchased Item", new Properties().putValue("sku", "13d31").putR
8282
```
8383

8484
<table class="api-table">
85+
<thead>
86+
<tr>
87+
<td>Field</td>
88+
<td>Type</td>
89+
<td>Description</td>
90+
</tr>
91+
</thead>
8592
<tr>
86-
<td>`name` _String,required_</td>
93+
<td>`name`</td>
94+
<td>_String,required_</td>
8795
<td>A name for the tracked action.</td>
8896
</tr>
8997
<tr>
90-
<td>`properties` _Properties,optional_</td>
98+
<td>`properties`</td>
99+
<td>_Properties,optional_</td>
91100
<td>A map of properties for this action, e.g. revenue if the action was a purchase.</td>
92101
</tr>
93102
</table>
@@ -106,16 +115,26 @@ analytics.screen("Purchase Screen", "Smartwatches", new Properties().putValue("s
106115
```
107116

108117
<table class="api-table">
118+
<thead>
119+
<tr>
120+
<td>Field</td>
121+
<td>Type</td>
122+
<td>Description</td>
123+
</tr>
124+
</thead>
109125
<tr>
110-
<td>`name` _String,optional*_</td>
126+
<td>`name`</td>
127+
<td>_String,optional*_</td>
111128
<td>A name for the screen. Optional if category is provided.</td>
112129
</tr>
113130
<tr>
114-
<td>`category` _String,optional*_</td>
131+
<td>`category`</td>
132+
<td>_String,optional*_</td>
115133
<td>A category for the screen. Optional if name is provided.</td>
116134
</tr>
117135
<tr>
118-
<td>`properties` _Properties,optional_</td>
136+
<td>`properties`</td>
137+
<td>_Properties,optional_</td>
119138
<td>A map of properties for this screen.</td>
120139
</tr>
121140
</table>

src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/1flow-swift.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You'll then have the option to pin to a version, or specific branch, as well as
3030

3131
Open your Package.swift file and add the following to the `dependencies` section:
3232

33-
```
33+
```swift
3434
.package(
3535
name: "Segment",
3636
url: "https://github.com/1Flow-Inc/segment-1flow-ios.git",
@@ -42,14 +42,14 @@ Open your Package.swift file and add the following to the `dependencies` section
4242

4343
Open the file where you set up and configure the Analytics-Swift library. Add this plugin to the list of imports.
4444

45-
```
45+
```swift
4646
import Segment
4747
import SegmentOneFlow // <-- Add this line
4848
```
4949

5050
Just under your Analytics-Swift library setup, call `analytics.add(plugin: ...)` to add an instance of the plugin to the Analytics timeline.
5151

52-
```
52+
```swift
5353
let analytics = Analytics(configuration: Configuration(writeKey: "<YOUR WRITE KEY>")
5454
.flushAt(3)
5555
.trackApplicationLifecycleEvents(true))

src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/adjust-swift.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You'll then have the option to pin to a version, or specific branch, as well as
3030

3131
Open your Package.swift file and add the following do your the `dependencies` section:
3232

33-
```
33+
```swift
3434
.package(
3535
name: "Segment",
3636
url: "https://github.com/segment-integrations/analytics-swift-integration-adjust.git",
@@ -41,14 +41,14 @@ Open your Package.swift file and add the following do your the `dependencies` se
4141

4242
Open the file where you setup and configure the Analytics-Swift library. Add this plugin to the list of imports.
4343

44-
```
44+
```swift
4545
import Segment
4646
import SegmentAdjust // <-- Add this line
4747
```
4848

4949
Just under your Analytics-Swift library setup, call `analytics.add(plugin: ...)` to add an instance of the plugin to the Analytics timeline.
5050

51-
```
51+
```swift
5252
let analytics = Analytics(configuration: Configuration(writeKey: "<YOUR WRITE KEY>")
5353
.flushAt(3)
5454
.trackApplicationLifecycleEvents(true))
@@ -133,4 +133,4 @@ The destination automatically forwards push notification tokens through to Adjus
133133

134134
### Event buffering
135135

136-
By default, our destination enables event buffering for Adjust. This saves your customers' battery life. However, you can disable this in the options on the Adjust destination settings on Segment.
136+
By default, our destination enables event buffering for Adjust. This saves your customers' battery life. However, you can disable this in the options on the Adjust destination settings on Segment.

src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/adobe-swift.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Adobe Analytics uses a slightly different approach to tracking than Segment, and
1212

1313
For example, if one of your end users dismissed a welcome dialog in your app, Segment would generate a `Welcome Dialog Dismissed` event with properties that contain the user ID (`user123`) and the dialog name (`welcome-dialog`), while Adobe Analytics would model the same action as a pageView with variables that represent the dialog name, visitorID, and the event name, and an eVar ("dismissed").
1414

15-
Both Segment and Adobe Analytics have recommended standard data for tracking events. Segment has [the Spec](/docs/connections/spec/), and Adobe uses predefined events. Segment automatically maps incoming event data and some product level properties to Adobe's predefined events, when the event data is in the correct Segment Ecommerce Spec](/docs/connections/spec/ecommerce/v2/) format. Video calls using the format described in [this document](/docs/connections/spec/video) are also automatically mapped. If you're using the Mobile SDKs, mobile lifecycle events are also automatically mapped. If you need to create Page and Track events that are outside the scope of the Ecommerce Spec, you need to map those in your Segment destinations settings UI.
15+
Both Segment and Adobe Analytics have recommended standard data for tracking events. Segment has [the Spec](/docs/connections/spec/), and Adobe uses predefined events. Segment automatically maps incoming event data and some product level properties to Adobe's predefined events, when the event data is in the correct [Segment Ecommerce Spec](/docs/connections/spec/ecommerce/v2/) format. Video calls using the format described in [this document](/docs/connections/spec/video) are also automatically mapped. If you're using the Mobile SDKs, mobile lifecycle events are also automatically mapped. If you need to create Page and Track events that are outside the scope of the Ecommerce Spec, you need to map those in your Segment destinations settings UI.
1616

1717
Segment strongly recommends that you create a [Tracking Plan](/docs/protocols) for both your Segment and Adobe Analytics events before you send any events or properties to Adobe. This helps you map your Segment events to Adobe `events` and Segment properties to Adobe variables. If you decide to set up Adobe Analytics for mobile, you must set up this mapping in both the Segment settings and the Adobe Mobile Services dashboard, so it's good to stay consistent.
1818

@@ -44,7 +44,7 @@ You then have the option to pin to a version or specific branch and select which
4444

4545
Open your Package.swift file and add the following to the `dependencies` section:
4646

47-
```
47+
```swift
4848
.package(
4949
name: "Segment",
5050
url: "https://github.com/segment-integrations/analytics-swift-adobe-analytics.git",
@@ -56,14 +56,14 @@ Open your Package.swift file and add the following to the `dependencies` section
5656

5757
Open the file where you set up and configured the Analytics-Swift library. Add this plugin to the list of imports.
5858

59-
```
59+
```swift
6060
import Segment
6161
import SegmentAdobe // <-- Add this line
6262
```
6363

6464
Just under your Analytics-Swift library setup, call `analytics.add(plugin: ...)` to add an instance of the plugin to the Analytics timeline.
6565

66-
```
66+
```swift
6767
let analytics = Analytics(configuration: Configuration(writeKey: "<YOUR WRITE KEY>")
6868
.flushAt(3)
6969
.trackApplicationLifecycleEvents(true))

src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/mixpanel-swift.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,13 @@ The first thing you'll want to do is to identify your users so Mixpanel knows wh
8282

8383
As soon as you have a `userId` for a visitor that was previously anonymous you'll need to [`alias`](/docs/connections/spec/alias/) their old anonymous `id` to the new `userId`. In Mixpanel only **one** anonymous user history can be merged to **one** identified user. For that reason you should only call `alias` once, right after a user registered, but before the first `identify`.
8484

85-
When you call the Identify method from the client in either a browser using Analytics.js or one a mobile SDKs, several things occur: Segment recognizes and translates the [special traits](/docs/connections/spec/identify/#traits) so that they fit the expectations of Mixpanel's API. The table below shows the mappings. Pass the key on the left and Segment transforms it to the key on the right before sending to Mixpanel.
85+
When you call the Identify method from the client in either a browser using Analytics.js or one a mobile SDKs, several things occur: Segment recognizes and translates the [special traits](/docs/connections/spec/identify/#traits) so that they fit the expectations of Mixpanel's API. The table below shows the mappings. Pass the key on the left and Segment transforms it to the key on the right before sending to Mixpanel.
8686

8787
<table>
88+
<tr>
89+
<td>Key</td>
90+
<td>Segment transformation</td>
91+
</tr>
8892
<tr>
8993
<td>`created`</td>
9094
<td>`$created`</td>

src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/nielsen-dtvr-swift.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To get started with Nielsen-DTVR and retrieve an `appid` to configure this integ
1515
- Reach out to your Segment customer service representative to enable the Nielsen-DTVR plugin, as this destination is in private beta.
1616

1717

18-
### Adding the dependency
18+
## Adding the dependency
1919

2020
### via Xcode
2121
In the Xcode `File` menu, click `Add Packages`. You'll see a dialog where you can search for Swift packages. In the search field, enter the URL to this repo.

0 commit comments

Comments
 (0)