search

segmentio / segment-docs

Segment Documentation. Powered by Jekyll.
https://segment.com/docs/
Creative Commons Attribution 4.0 International
48 stars 343 forks source link

[Content]: #3328

Open lizkane222 opened 2 years ago

lizkane222 commented 2 years ago

What article on segment.com/docs is affected?

https://segment.com/docs/connections/destinations/catalog/actions-amplitude/#amplitude-settings-mapping

What part(s) of the article would you like to see updated?

amplitude-settings-mapping

There are a few Amplitude Classic settings that are not mentioned in the #amplitude-settings-mapping table:

Track Referrer to Amplitude - this setting only works when Amplitude Classic is connected to Analytics.js source and enabled in device-mode. Enabling this will send referrer information as a user property to Amplitude when you call Segment’s page method. When using Amplitude Actions, you can simply send referrer as a user property by updating the User Properties mapping: amplitude referrer

Track UTM Properties to Amplitude - works out-of-the-box. With Amplitude Classic, you would need to make sure that UTM parameters are passed within context.campaign dictionary (Analytics.js does it automatically). With Amplitude Actions, default mapping also expects UTM parameters to be passed within context.campaign. amplitude utm

These two device-mode specific settings cannot be migrated to Amplitude Actions as saveParamsReferrerOncePerSession and unsetParamsReferrerOnNewSession options cannot be passed to Amplitude server-side (using API):

Save Referrer, URL Params, GCLID Once Per Session - device-mode setting only, from Amplitude JavaScript SDK docs - Tracking UTM Parameters, Referrer, and gclid (JavaScript). When this option is enabled in Segment, option saveParamsReferrerOncePerSession is passed as true to Amplitude SDK so that UTM parameters are not overwritten for the user within the same session.

Unset Params Referrer On New Session - also a device-mode setting only which can be used to set the Amplitude unsetParamsReferrerOnNewSession option, if false, the existing referrer and utm_parameter values will be carried through each new session.

Additional information

We've had a couple of customers write into support about the Amplitude Actions destination not having information around some of the previous settings that were available in the Amplitude Classic destination.

Feel free to reference this ticket.

markzegarelli commented 2 years ago

Thanks @lizkane222! I've updated the mapping table to include the first two settings you've referenced.

I'll need to think about how to handle the second two though. We initially proposed to include only settings that could be migrated to Actions.

I will ship the first two updates tomorrow.