Skip to content

Commit 41aaf49

Browse files
markzegarellimarkzegarelli
committed
DOC-240 cleaned data
1 parent 2a1ffa2 commit 41aaf49

File tree

2 files changed

+99
-61
lines changed

2 files changed

+99
-61
lines changed

‎src/_data/actions/amplitude.yml

Lines changed: 89 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,28 @@ config:
44
- name: API Key
55
connection_mode:
66
- cloud
7-
- device
7+
- device-web
8+
- device-mobile
89
configurable: true
910
location: Global Setting
1011
notes: ""
1112
- name: Track Products Once
1213
connection_mode:
13-
- cloud
14+
- device-web
1415
configurable: false
1516
location: null
1617
notes: "Not applicable to Cloud mode"
1718
- name: Version Name
1819
connection_mode:
19-
- cloud
20+
- device-web
2021
configurable: true
2122
location: "Action field **App Version**."
2223
notes: "Defaults to `context.app.version`."
2324
- name: Connection Mode
2425
connection_mode:
2526
- cloud
26-
- device
27+
- device-web
28+
- device-mobile
2729
configurable: true
2830
location: null
2931
notes: Actions support Cloud mode connections
@@ -32,28 +34,32 @@ config:
3234
- name: Track all pages to Amplitude
3335
connection_mode:
3436
- cloud
35-
- device
37+
- device-web
38+
- device-mobile
3639
configurable: true
3740
location: "Subscription **Page Calls**"
3841
notes: When enabled, Amplitude (Actions) tracks all Page calls by default
3942
- name: Track all Screens
4043
connection_mode:
4144
- cloud
42-
- device
45+
- device-web
46+
- device-mobile
4347
configurable: true
4448
location: "Subscription **Page Calls**"
4549
notes: When enabled, Amplitude (Actions) tracks all Screen calls by default
4650
- name: Track Categorized Pages to Amplitude
4751
connection_mode:
4852
- cloud
49-
- device
53+
- device-web
54+
- device-mobile
5055
configurable: true
5156
location: "Subscription **Page Calls**"
5257
notes: Add a Trigger filter condition to check that Event Property **category** exists
5358
- name: Track Named Pages to Amplitude
5459
connection_mode:
5560
- cloud
56-
- device
61+
- device-web
62+
- device-mobile
5763
configurable: true
5864
location: "Subscription **Page Calls**"
5965
notes: Add a Trigger filter condition to check that Event Property **name** exists
@@ -62,147 +68,171 @@ config:
6268
- name: Group Type Trait
6369
connection_mode:
6470
- cloud
65-
- device
71+
- device-web
72+
- device-mobile
6673
configurable: true
6774
location: "Subscription **Group Identify User**."
6875
notes: Select a value in the **Group Type** actions field.
6976
- name: Group Value Trait
7077
connection_mode:
7178
- cloud
72-
- device
79+
- device-web
80+
- device-mobile
7381
configurable: true
7482
location: "Subscription **Group Identify User**."
7583
notes: Select a value in the **Group Value** actions field.
7684
- name: Traits to Append
77-
connection_mode: null
85+
connection_mode:
86+
- cloud
7887
configurable: false
7988
location:
80-
notes: --
89+
notes: Not supported with Actions
8190
- name: Traits to Increment
82-
connection_mode: null
91+
connection_mode:
92+
- cloud
93+
- device-web
94+
- device-mobile
8395
configurable: false
8496
location:
85-
notes: --
97+
notes: Not supported with Actions
8698
- name: Traits to Prepend
87-
connection_mode: null
99+
connection_mode:
100+
- cloud
88101
configurable: false
89102
location:
90-
notes: --
103+
notes: Not supported with Actions
91104
- name: Traits to Set Once
92-
connection_mode: null
105+
connection_mode:
106+
- cloud
107+
- device-web
108+
- device-mobile
93109
configurable: false
94110
location:
95-
notes: --
111+
notes: Not supported with Actions
96112
- category: Other Settings
97113
settings:
98114
- name: Append Fields to Event Properties
99115
connection_mode:
116+
- device-web
117+
- device-mobile
100118
configurable: false
101119
location:
102-
notes: Not applicable to Cloud Mode
120+
notes: Not supported with Actions
103121
- name: Batch Events
104122
connection_mode:
105-
- cloud
106-
configurable: false
107-
location:
108-
notes: Not applicable to Cloud Mode
123+
- device-web
124+
configurable: true
125+
location: "**Use Batch Endpoint** field on the **Log Event** action"
126+
notes:
109127
- name: Enable Location Listening
110128
connection_mode:
111-
- device
129+
- device-mobile
112130
configurable: false
113131
location:
114-
notes: Not applicable to Cloud Mode
132+
notes: Use `context.location.latitude` and `context.location.longitude` on the mobile client. Other destinations may also process this data. Amplitude uses IP-based location, if you're unable to send latitude and longitude.
115133
- name: Event Upload period millis
116134
connection_mode:
117-
- cloud
135+
- device-web
118136
configurable: false
119137
location:
120-
notes: Not applicable to Cloud Mode
138+
notes: Not configurable for Cloud-mode batching
121139
- name: Event Upload Threshold
122140
connection_mode:
123-
- cloud
141+
- device-web
124142
configurable: false
125143
location:
126-
notes: Not applicable to Cloud Mode
144+
notes: Not configurable for Cloud-mode batching
127145
- name: Force HTTPS
128146
connection_mode:
129-
- cloud
147+
- device-web
130148
configurable: false
131149
location:
132-
notes: Not applicable to Cloud Mode
150+
notes: Not configurable in Cloud-mode, https is enabled by default.
133151
- name: Map Query Params to Custom Property
134-
connection_mode: null
152+
connection_mode:
153+
- cloud
154+
- device-web
135155
configurable: false
136156
location:
137-
notes: Not available
157+
notes: Not supported with Actions
138158
- name: Prefer Anonymous Device ID
139159
connection_mode:
140160
- cloud
141-
- device
161+
- device-web
162+
- device-mobile
142163
configurable: true
143164
location: Actions field **Device ID**.
144165
notes: Replace the contents of the field with your preferred value.
145166
- name: Save Referrer, URL Params, GCLID Once per Session
146167
connection_mode:
147-
- cloud
168+
- device-web
148169
configurable: false
149170
location:
150-
notes: Not available
171+
notes: Not supported with Actions
151172
- name: Secret Key
152173
connection_mode:
153174
- cloud
154-
- device
175+
- device-web
176+
- device mobile
155177
configurable: true
156178
location: Global Setting
157179
notes: ""
158180
- name: Enable Alias
159-
connection_mode: null
160-
configurable: false
161-
location:
162-
notes:
181+
connection_mode:
182+
- cloud
183+
configurable: true
184+
location: Use the **Map User** action.
185+
notes: The **Map User** action is not enabled by default. Add a new Subscription to access the **Map User** action.
163186
- name: Send to Batch Endpoint
164-
connection_mode: null
165-
configurable: false
166-
location:
187+
connection_mode:
188+
- cloud
189+
configurable: true
190+
location: "**Use Batch Endpoint** field on the **Log Event** action"
167191
notes:
168192
- name: Track GCLID
169-
connection_mode: null
193+
connection_mode:
194+
- device-web
170195
configurable: false
171196
location:
172-
notes: Not applicable to Cloud Mode
197+
notes: Not supported with Actions
173198
- name: Track Referrer to Amplitude
174-
connection_mode: null
199+
connection_mode:
200+
- device-web
175201
configurable: false
176202
location:
177-
notes: Not applicable to Cloud Mode
203+
notes: Not supported with Actions
178204
- name: Track Revenue per Product
179205
connection_mode:
180206
- cloud
181-
- device
207+
- device-web
208+
- device-mobile
182209
configurable: true
183210
location: Actions field **Track Revenue Per Product**.
184211
notes: Available in any subscription that uses the **Log Event** action.
185212
- name: Track Session Events to Amplitude
186213
connection_mode:
187-
- cloud
214+
- device-web
188215
configurable: false
189216
location:
190-
notes: For best results, use **Session ID**
217+
notes: This setting sends `[Session Started]` and `[Session Ended]` events. However, Session ID is used most often in session-based reporting. Analytics.js sources track Session ID by default. Mobile sources require a plugin to enable Session ID tracking.
191218
- name: Track UTM Properties to Amplitude
192-
connection_mode: null
219+
connection_mode:
220+
- cloud
221+
- device-web
193222
configurable: false
194223
location:
195-
notes: --
224+
notes: Not supported with Actions
196225
- name: Unset Params Referrer on New Session
197226
connection_mode:
198-
- cloud
227+
- device-web
199228
configurable: false
200229
location:
201-
notes: --
230+
notes: Not supported with Actions
202231
- name: Use Advertising ID for Device ID
203232
connection_mode:
204233
- cloud
205-
- device
234+
- device-web
235+
- device-mobile
206236
configurable: true
207237
location: Actions field **Device ID**.
208238
notes: Update the value so your preferred field appears first in the `coalesce()` function.
@@ -213,8 +243,9 @@ config:
213243
notes: These fields are set by default with values from the context object.
214244
- name: Use Log Revenue v2 API
215245
connection_mode:
216-
- cloud
246+
- device-web
247+
- device-mobile
217248
configurable: false
218249
location:
219-
notes: Not applicable to Cloud mode
250+
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**
220251

‎src/utils/actions-map-table.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ title: Actions Mapping
5454
text-transform: uppercase;
5555
color: rgb(71, 77, 102);
5656
opacity: 0.65;
57+
white-space: nowrap;
58+
}
59+
60+
.device-web-mode, .device-mobile-mode {
61+
background-color: #e6f5ef;
62+
color: #317159
5763
}
5864

5965
</style>
@@ -65,8 +71,9 @@ title: Actions Mapping
6571
<a href="#" id="all" class="button button-link active">All</a>
6672
<a href="#" id="true" class="button button-link" >Configurable</a>
6773
<a href="#" id="false" class="button button-link" >Not Configurable</a>
68-
<a href="#" id="cloud" class="button button-link">Cloud-mode</a>
69-
<a href="#" id="device" class="button button-link" >Device-mode</a>
74+
<a href="#" id="cloud" class="button button-link">Cloud</a>
75+
<a href="#" id="device-web" class="button button-link" >Device-web</a>
76+
<a href="#" id="device-mobile" class="button button-link" >Device-mobile</a>
7077
</div>
7178

7279
<table id="settingsTable">
@@ -88,7 +95,7 @@ title: Actions Mapping
8895
class="settingRow {%unless setting.configurable%}no-map{%endunless%} {{setting.configurable}} {% for mode in setting.connection_mode %}{{mode}} {%endfor%}"
8996
id="settingRow">
9097
<td>{{setting.name}} <br /> {% for mode in setting.connection_mode %}<span
91-
class="cmode">{{mode | capitalize}}-mode</span> {% endfor %}</td>
98+
class="cmode {{mode}}-mode">{{mode | capitalize}}</span> {% endfor %}</td>
9299
<!-- <td>{{setting.configurable}}</td> -->
93100
<td>{% if setting.location %}{{setting.location}} <br /> <br /> {% endif %}{{setting.notes}}</td>
94101
</tr>

0 commit comments

Comments
 (0)