Skip to content

Commit f88391c

Browse files
committed
DOC-240 updates toward parity
1 parent 780c4fb commit f88391c

File tree

1 file changed

+40
-6
lines changed
  • src/connections/destinations/catalog/actions-amplitude

1 file changed

+40
-6
lines changed

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

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,6 @@ You can select these subscriptions by choosing "Quick Setup" when you first conf
9292
| Screen Calls | All **screen** calls from the connected source | Log Event | Event Type = Viewed `name`<br>for example, `Viewed Homescreen` |
9393
| Identify Calls | All **identify** calls from the connected source | Identify User | |
9494

95-
<!-- Include section about hard coded mappings for Log Revenue v2 in Track event -->
96-
<!-- Mention in Group setting the enterprise Amplitude account blurb -->
97-
<!-- Add Legacy Group Behavior section to migration -->
98-
99-
10095
## Available Amplitude Actions
10196

10297
Build your own subscriptions with the following Amplitude-supported actions:
@@ -172,6 +167,27 @@ If you enable the setting ("on"), Segment sends a single revenue event for each
172167

173168
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.
174169

170+
#### Log Revenue v2
171+
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.
173+
174+
| Amplitude Property | Segment Property | Description |
175+
| ------------------ | ------------------------------------------------------------ | -------------------------------------------------------------------------- |
176+
| `productId` | `productId` | An identifier for the product. |
177+
| `quantity` | `quantity` | The quantity of products purchased. Note: revenue = `quantity` * `price`. |
178+
| `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+
| `eventProperties` | Any remaining properties | A NSDictionary or Map of event properties to include in the revenue event. |
183+
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`.
185+
186+
Property names should be `camelCase` for Android implementations, and `snake_case` for iOS implementations.
187+
188+
> info ""
189+
> Amplitude does not support currency conversion. You should normalize all revenue data to your currency of choice before sending it to Amplitude.
190+
175191
#### Send To Batch Endpoint
176192

177193

@@ -189,8 +205,15 @@ In the default configuration, this mapping is triggered when Segment sends an Id
189205

190206
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.
191207

208+
{% comment %}
209+
### Merge users with Anonymous ID and User ID
210+
<!-- MZ 7/29: Identify User does not have a field for Anonymous 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.
212+
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.
214+
215+
{% endcomment %}
192216

193-
<!-- Include Merging users with Anonymous ID and USer ID -->
194217

195218
### Map User
196219

@@ -219,13 +242,24 @@ You can also unmap users, for example if you aliased them in error. To unmap a u
219242

220243
In the default configuration, this mapping is triggered when Segment sends a Group call to Amplitude (Actions).
221244

245+
> warning ""
246+
> Groups are an enterprise-only feature in Amplitude, and are only available if you've purchased the Accounts add-on.
247+
222248
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.
223249

224250
These Group updates only affect events that occur after you set up the Amplitude mapping. You cannot use this to group historical data.
225251

226252
> success ""
227253
> 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.
228254
255+
If you don't have an enterprise Amplitude account, or don't have the Accounts add-on, Segment always adds groups as `user_properties` on a user record. As long as you specify the Action settings below, Segment adds a "group type" user property with a value of the "group value".
256+
257+
To use Amplitude's groups with Segment, you must enable the following Action settings and make sure to include the data values they need to function. These settings act as a mapping from Segment group traits to Amplitude group types and values.
258+
259+
- **"Amplitude Group Type Trait"**: This specifies what trait in your Group calls contains the Amplitude "group type". In other words, it's how you tell Segment which trait to use as the group type.
260+
261+
- **"Amplitude Group Value Trait"**: This specifies what trait in your Group calls contains the Amplitude "group value". It's how you tell Segment which trait to use as the group value.
262+
229263
## Migration from Amplitude Classic
230264

231265
Most of the classic Amplitude destination settings were related to device-mode collection (for example, batching or Log Revenue V2), and do not apply to the Amplitude (Actions) destination, which runs in cloud-mode. The following sections discuss how to replicate the old settings where possible.

0 commit comments

Comments
 (0)