Skip to content

Commit e8c9b58

Browse files
committed
DOC-240 edits [netlify-ignore]
1 parent a158457 commit e8c9b58

File tree

5 files changed

+44
-40
lines changed

5 files changed

+44
-40
lines changed

src/_data/actions/amplitude.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,4 +248,3 @@ config:
248248
configurable: false
249249
location:
250250
notes: Actions supports Revenue v2. Confirm revenue reporting is working as expected if you migrate from the Classic Amplitude destination where this setting was **disabled**
251-

src/_includes/components/actions-map-table.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
{% assign configMap = site.data.actions.amplitude.config %}
2-
{% assign conModes = site.data.actions.amplitude.config| map: 'settings' | map: 'connection_mode' | uniq | compact%}
1+
{% assign thisDest = include.name %}
2+
{% assign configMap = site.data.actions.[thisDest].config %}
3+
{% assign conModes = site.data.actions.[thisDest].config| map: 'settings' | map: 'connection_mode' | uniq | compact%}
34

45

5-
### Amplitude settings mapping
6+
7+
8+
### {{thisDest | capitalize}} settings mapping
69

710
<input class="table-search" type="text" id="filterInput" onkeyup="searchFilter()" placeholder="Search for setting..">
811
<div class="button-container" id="btnContainer">
@@ -15,9 +18,8 @@
1518
<table id="settingsTable">
1619
<thead>
1720
<tr>
18-
<th>Amplitude 1.0 Destination Setting</th>
19-
<!-- <th>Configurable in Amplitude (Actions)?</th> -->
20-
<th>How to enable in Amplitude (Actions)</th>
21+
<th>{{thisDest}} Classic Destination Setting</th>
22+
<th>How to enable in {{thisDest}} (Actions)</th>
2123
</tr>
2224
</thead>
2325
<tbody>

src/connections/destinations/catalog/actions-amplitude/index.md

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Session tracking is available with Segment's new libraries: [Analytics.js 2.0](/
4242
### Device ID Mappings
4343
The Amplitude destination requires that each event include either a Device ID or a User ID. If a User ID isn't present, Amplitude uses the a Device ID, and vice versa, if a Device ID isn't present, Amplitude uses the User ID.
4444

45-
By default, Segment maps the Segment property `context.device.id` to the Amplitude property `Device ID`. If `context.device.id` isn't available, Segment maps the property `anonymousId` to the Amplitude `Device ID`. This is indicated by the following text in the Device ID field: `coalesce(` `context.device.id` `anonymousId` `)`.
45+
By default, Segment maps the Segment property `context.device.id` to the Amplitude property `Device ID`. If `context.device.id` isn't available, Segment maps the property `anonymousId` to the Amplitude `Device ID`. The Actions interface indicates this with the following contents of the Device ID field: `coalesce(` `context.device.id` `anonymousId` `)`.
4646

4747
### Enable session tracking for Analytics.js 2.0
4848

@@ -73,11 +73,12 @@ To enable session tracking in Amplitude when using the [Segment Kotlin library](
7373

7474
## Important differences from the classic Amplitude destination
7575

76-
The following user fields are captured by the classic Amplitude destination in device-mode (when it runs on the user’s device), but are not captured by Amplitude (Actions):
76+
The classic Amplitude destination captures the following user fields in device-mode (when it runs on the user’s device):
7777

7878
- Device Type (for example, Mac, PC, mobile device)
7979
- Platform (for example iOS or Android)
8080

81+
Amplitude (Actions) runs in cloud-mode, and does not capture these fields.
8182

8283
## Pre-built subscriptions
8384

@@ -105,15 +106,17 @@ You can see the Segment event fields Amplitude accepts for each action in the Ac
105106

106107
### Log Event
107108

108-
In the default configuration, the Log Event mapping is triggered when Segment sends a Track call to Amplitude (Actions).
109+
The Track Calls, Page Calls, and Screen Calls default subscriptions all send Log Events to Amplitude when the Amplitude (Actions) destination receives the corresponding call.
110+
111+
This action enables you to define the Event Type the destination sends using a combination of plain text and information received from the received event.
109112

110113
{% comment %}
111-
MZ - 7/26: Niels is validating the update needed to this section based on a comment in PR 1677
114+
MZ - 7/26: NT is validating the update needed to this section based on a comment in PR 1677
112115
### Order Completed
113116

114117
Use the [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) event to track revenue with Amplitude. This event records a list of products that a user purchased in a single transaction. This is the best way for sites that have a shopping cart system to track purchases.
115118

116-
You can use this event only for data coming from a Cloud-mode [source](/docs/connections/sources/). An `Order Completed` event from mobile using the bundled Amplitude integration will work the same as the standard `track` event documented above.
119+
You can use this event for data coming from a Cloud-mode [source](/docs/connections/sources/). An `Order Completed` event from mobile using the bundled Amplitude integration will work the same as the standard `track` event documented above.
117120

118121
The example below shows an "Order Completed" event with its properties.
119122

@@ -154,34 +157,34 @@ analytics.track({
154157
})
155158
```
156159

157-
When you send an "Order Completed" event from Segment, an "Order Completed" event appears in Amplitude for that purchase. An Amplitude event called "Product Purchased" is also created for each product in the purchase. All event properties, except `products`, are sent as `event_properties` of the Amplitude "Order Completed" event. Information about each product is present *only* on the individual "Product Purchased" events.
160+
When you send an "Order Completed" event from Segment, an "Order Completed" event appears in Amplitude for that purchase. An Amplitude event called "Product Purchased" is also created for each product in the purchase. Segment sends all event properties, except `products`, as `event_properties` of the Amplitude "Order Completed" event. Information about each product is present on the individual "Product Purchased" events.
158161
{% endcomment %}
159162

160163
#### Track Revenue Per Product
161164

162165
Amplitude has two different ways to track revenue associated with a multi-product purchase. You can choose which method you want to use using the **Track Revenue Per Product** destination setting.
163166

164-
If you disable the setting ("off"), Segment sends a single revenue event with the total amount purchased. Revenue data is added to the Amplitude "Order Completed" event. The "Product Purchased" events do not contain any native Amplitude revenue data.
167+
If you disable the setting ("off"), Segment sends a single revenue event with the total amount purchased and adds revenue data the Amplitude "Order Completed" event. The "Product Purchased" events do not contain any native Amplitude revenue data.
165168

166-
If you enable the setting ("on"), Segment sends a single revenue event for each product that was purchased. Revenue data is added to each "Product Purchased" event, and the "Order Completed" event does not contain any native Amplitude revenue data.
169+
If you enable the setting ("on"), Segment sends a single revenue event for each purchased product and adds Revenue data to each "Product Purchased" event. The "Order Completed" event does not contain any native Amplitude revenue data.
167170

168171
Make sure you format your events using the [Track method spec](/docs/connections/spec/track/). You must pass a `revenue` property, a `price` property, and a `quantity` property for each product in the products list.
169172

170173
#### Log Revenue v2
171174

172-
Segment's iOS and Android sources can send revenue using Amplitude's preferred `logRevenueV2` method. Segment sets Amplitude's special revenue properties, such as `revenueType` and `productIdentifier`, which are used in Amplitude's Revenue Analysis and Revenue LTV charts. Segment uses the Amplitude `eventProperties` field to send any properties _not_ mapped to Amplitude's special properties.
175+
Segment's iOS and Android sources can send revenue using Amplitude's preferred `logRevenueV2` method. Segment sets Amplitude's special revenue properties, such as `revenueType` and `productIdentifier`, which Amplitude's Revenue Analysis uses for Revenue Analysis and Revenue LTV charts. Segment uses the Amplitude `eventProperties` field to send any properties _not_ mapped to Amplitude's special properties.
173176

174177
| Amplitude Property | Segment Property | Description |
175178
| ------------------ | ------------------------------------------------------------ | -------------------------------------------------------------------------- |
176179
| `productId` | `productId` | An identifier for the product. |
177180
| `quantity` | `quantity` | The quantity of products purchased. Note: revenue = `quantity` * `price`. |
178181
| `price` | `price` or `revenue` (or `total` for mobile, see note below) | The price of the products purchased, and this can be negative. |
179-
| `revenueType` | `revenueType` | The type of revenue (e.g. tax, refund, income). |
180-
| `receiptSignature` | `receiptSignature` (Android only) | The receipt signature. |
181-
| `receipt` | `receipt` | This is required if you want to verify the revenue event. |
182+
| `revenueType` | `revenueType` | The revenue type (for example tax, refund, income). |
183+
| `receiptSignature` | `receiptSignature` (Android) | The receipt signature. |
184+
| `receipt` | `receipt` | Required if you want to verify the revenue event. |
182185
| `eventProperties` | Any remaining properties | A NSDictionary or Map of event properties to include in the revenue event. |
183186

184-
<!--&ast;-->\* If `properties.price` is not present, Segment uses `revenue` instead, and sends that as `price`. In Segment's iOS and Android components, if `revenue` isn't present either, Segment does an additional fallback and sends the `total`.
187+
<!--&ast;-->\* If `properties.price` is not present, Segment uses `revenue` instead, and sends that as `price`. In Segment's iOS and Android libraries, if `revenue` isn't present either, Segment sends the `total`.
185188

186189
Property names should be `camelCase` for Android implementations, and `snake_case` for iOS implementations.
187190

@@ -192,62 +195,61 @@ Property names should be `camelCase` for Android implementations, and `snake_cas
192195

193196

194197
> info ""
195-
> This endpoint is available when you send data in Cloud-mode only.
198+
> This endpoint is available when you send data in Cloud-mode.
196199
197200

198-
If `true`, events are sent to Amplitude’s `batch` endpoint rather than to their `httpapi` endpoint. Because Amplitude’s `batch` endpoint throttles traffic less restrictively than the Amplitude `httpapi` endpoint, enabling this setting can help to reduce 429 errors (throttling errors) from Amplitude.
201+
If `true`, the destination sends events to Amplitude’s `batch` endpoint rather than the `httpapi` endpoint. Because Amplitude’s `batch` endpoint throttles traffic less restrictively than the Amplitude `httpapi` endpoint, enabling this setting can help to reduce 429 errors (throttling errors) from Amplitude.
199202

200203
Amplitude’s `batch` endpoint throttles data when the rate of events sharing the same `user_id` or `device_id` exceeds an average of 1,000/second over a 30-second period. See the Amplitude documentation for more about [429 errors and throttling in Amplitude](https://developers.amplitude.com/#429s-in-depth).
201204

202205
### Identify User
203206

204-
In the default configuration, this mapping is triggered when Segment sends an Identify call to Amplitude (Actions).
207+
In the default configuration, Amplitude (Actions) triggers this mapping when it receives an Identify call.
205208

206209
This Action sets the user ID for a specific device ID, or updates the user properties. You can use this when you want to update user information without sending an Event to Amplitude.
207210

208-
{% comment %}
209-
### Merge users with Anonymous ID and User ID
210-
<!-- MZ 7/29: Anonymous id is in the coalesce function in Device ID -->
211-
To have Amplitude recognize an anonymous user and a known or logged-in user, make sure you include both the user’s `userId` and the `anonymousId` they had before that in your Identify call. If you don’t include the anonymousId, Amplitude can’t tell that the anonymous user is the same person as the logged-in user.
212211

213-
If you’re using a Segment server library or the Segment HTTP API, you must explicitly include both anonymousId and userId. If you’re using Analytics.js in device-mode, or a bundled SDK, Segment automatically includes anonymousId for you.
212+
### Merge users with Anonymous ID and User ID
214213

215-
{% endcomment %}
214+
To merge an anonymous user and known user based on `anonymousId` and `userId`, update the value of the Device ID field so that `anonymousId` is the value present.
216215

216+
By default, the Amplitude Device ID property receives the user's device ID from `context.device.id` and falls back to `anonymousId` if `context.device.id` is not present.
217217

218218
### Map User
219219

220-
In the default configuration, this mapping is triggered when Segment sends an Alias call to Amplitude (Actions).
220+
In the default configuration, Amplitude (Actions) triggers this mapping when it receives an Alias call.
221221

222222
This Action merges two users together that would otherwise have different User IDs tracked in Amplitude. You can use this when you want to merge the users without sending an Event to Amplitude.
223223

224-
| Segment identifier name | Equivalent Amplitude identifier name |
225-
| ----------------------- | ------------------------------------ |
226-
| `previousId` | `user_id` |
227-
| `userId` | `global_user_id` |
224+
| Segment identifier name | Amplitude identifier name |
225+
| ----------------------- | ------------------------- |
226+
| `previousId` | `user_id` |
227+
| `userId` | `global_user_id` |
228228

229-
This kind of mapping is useful for users who have different ids across different Amplitude projects. The user’s user_ids act as child ids, and can all be mapped to a single global_user_id in Amplitude. This allows you to analyze the user’s aggregate behavior in Amplitude’s Cross Portfolio view.
229+
This kind of mapping is useful for users who have different ids across different Amplitude projects. The user’s user_ids act as child ids, which Amplitude maps to a single global_user_id. This allows you to analyze the user’s behavior in Amplitude’s Cross Portfolio view.
230230

231231

232232

233233
{% comment %}
234+
<!-- vale off -->
234235
#### Unmap a user
235236

236237
You can also unmap users, for example if you aliased them in error. To unmap a user, pass the user’s previousId as an integration-specific option. The example Alias call below sends a request to Amplitude that unlinks user 123 from all global_user_ids it was previously associated with.
238+
<!-- vale on -->
237239
{% endcomment %}
238240

239241

240242

241243
### Group Identify User
242244

243-
In the default configuration, this mapping is triggered when Segment sends a Group call to Amplitude (Actions).
245+
In the default configuration, Amplitude (Actions) triggers this mapping when it receives a Group call.
244246

245247
> warning ""
246-
> Groups are an enterprise-only feature in Amplitude, and are only available if you've purchased the Accounts add-on.
248+
> Groups are an enterprise feature in Amplitude, and are available if you've purchased the Accounts add-on.
247249
248250
This Action sets or updates the properties of specific groups. You can use this when you want to update a group's information without sending an Event to Amplitude.
249251

250-
These Group updates only affect events that occur after you set up the Amplitude mapping. You cannot use this to group historical data.
252+
These Group updates affect events that occur after you set up the Amplitude mapping. You cannot use this to group historical data.
251253

252254
> success ""
253255
> If you are on a Business Tier Segment plan, you can use [Replay](/docs/guides/what-is-replay/) to run historical data through the Amplitude (Actions) destination to apply the grouping.
@@ -267,4 +269,4 @@ Configuration of the Amplitude (Actions) destination is done through Filters and
267269
> info ""
268270
> Contact Segment support if you find features missing from the Amplitude (Actions) destination that were available in the classic Amplitude destination.
269271
270-
{% include components/actions-map-table.html %}
272+
{% include components/actions-map-table.html name="amplitude" %}

vale-styles/Vocab/Docs/accept.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,5 @@ Lightbox
4747
gmail
4848
(?:P|p)endo
4949
(?:K|k)laviyo
50+
(?:U|u)nmaps?\b
51+
(?:U|u)nlinks?\b

vale-styles/write-good/TooWordy.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,6 @@ tokens:
177177
- procure
178178
- proficiency
179179
- provided that
180-
- purchase
181180
- put simply
182181
- readily apparent
183182
- refer back

0 commit comments

Comments
 (0)