Skip to content

Commit 8c9a406

Browse files
markzegarellimarkzegarelli
committed
DOC-240 finish prototype
1 parent 31a8c75 commit 8c9a406

File tree

2 files changed

+213
-23
lines changed

2 files changed

+213
-23
lines changed

‎src/_data/actions/amplitude.yml

Lines changed: 150 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,150 @@
1-
settings:
2-
connection_settings:
3-
- name: API Key
4-
configurable: true
5-
location: Global Setting
6-
notes: ""
7-
- name: Track Products Once
8-
configurable: false
9-
location: null
10-
notes: "Not applicable to Cloud mode"
11-
- name: Version Name
12-
configurable: true
13-
location: "Action field **App Version**. Defaults to `context.app.version`."
14-
notes: ""
15-
- name: Connection Mode
16-
configurable: true
17-
location: null
18-
notes: Actions support Cloud mode connections
19-
page_and_screen:
20-
- name: Track all pages to Amplitude
21-
configurable: true
22-
location: "Subscription **Page Calls**"
23-
notes: When enabled, Amplitude (Actions) tracks all Page calls by default
1+
config:
2+
- category: Connection Settings
3+
settings:
4+
- name: API Key
5+
configurable: true
6+
location: Global Setting
7+
notes: ""
8+
- name: Track Products Once
9+
configurable: false
10+
location: null
11+
notes: "Not applicable to Cloud mode"
12+
- name: Version Name
13+
configurable: true
14+
location: "Action field **App Version**."
15+
notes: "Defaults to `context.app.version`."
16+
- name: Connection Mode
17+
configurable: true
18+
location: null
19+
notes: Actions support Cloud mode connections
20+
- category: Page and Screen
21+
settings:
22+
- name: Track all pages to Amplitude
23+
configurable: true
24+
location: "Subscription **Page Calls**"
25+
notes: When enabled, Amplitude (Actions) tracks all Page calls by default
26+
- name: Track all Screens
27+
configurable: true
28+
location: "Subscription **Page Calls**"
29+
notes: When enabled, Amplitude (Actions) tracks all Screen calls by default
30+
- name: Track Categorized Pages to Amplitude
31+
configurable: true
32+
location: "Subscription **Page Calls**"
33+
notes: Add a Trigger filter condition to check that Event Property **category** exists
34+
- name: Track Named Pages to Amplitude
35+
configurable: true
36+
location: "Subscription **Page Calls**"
37+
notes: Add a Trigger filter condition to check that Event Property **name** exists
38+
- category: Traits
39+
settings:
40+
- name: Group Type Trait
41+
configurable: true
42+
location: "Subscription **Group Identify User**."
43+
notes: Select a value in the **Group Type** actions field.
44+
- name: Group Value Trait
45+
configurable: true
46+
location: "Subscription **Group Identify User**."
47+
notes: Select a value in the **Group Value** actions field.
48+
- name: Traits to Append
49+
configurable: false
50+
location:
51+
notes: --
52+
- name: Traits to Increment
53+
configurable: false
54+
location:
55+
notes: --
56+
- name: Traits to Prepend
57+
configurable: false
58+
location:
59+
notes: --
60+
- name: Traits to Set Once
61+
configurable: false
62+
location:
63+
notes: --
64+
- category: Other Settings
65+
settings:
66+
- name: Append Fields to Event Properties
67+
configurable: false
68+
location:
69+
notes: Not applicable to Cloud Mode
70+
- name: Batch Events
71+
configurable: false
72+
location:
73+
notes: Not applicable to Cloud Mode
74+
- name: Enable Location Listening
75+
configurable: false
76+
location:
77+
notes: Not applicable to Cloud Mode
78+
- name: Event Upload period millis
79+
configurable: false
80+
location:
81+
notes: Not applicable to Cloud Mode
82+
- name: Event Upload Threshold
83+
configurable: false
84+
location:
85+
notes: Not applicable to Cloud Mode
86+
- name: Force HTTPS
87+
configurable: false
88+
location:
89+
notes: Not applicable to Cloud Mode
90+
- name: Map Query Params to Custom Property
91+
configurable: false
92+
location:
93+
notes: Not available
94+
- name: Prefer Anonymous Device ID
95+
configurable: true
96+
location: Actions field **Device ID**.
97+
notes: Update the value so your preferred field appears first in the `coalesce()` function.
98+
- name: Save Referrer, URL Params, GCLID Once per Session
99+
configurable: false
100+
location:
101+
notes: Not available
102+
- name: Secret Key
103+
configurable: true
104+
location: Global Setting
105+
notes: ""
106+
- name: Enable Alias
107+
configurable: false
108+
location:
109+
notes:
110+
- name: Send to Batch Endpoint
111+
configurable: false
112+
location:
113+
notes:
114+
- name: Track GCLID
115+
configurable: false
116+
location:
117+
notes: Not applicable to Cloud Mode
118+
- name: Track Referrer to Amplitude
119+
configurable: false
120+
location:
121+
notes: Not applicable to Cloud Mode
122+
- name: Track Revenue per Product
123+
configurable: true
124+
location: Actions field **Track Revenue Per Product**.
125+
notes: Available in any subscription that uses the **Log Event** action.
126+
- name: Track Session Events to Amplitude
127+
configurable: false
128+
location:
129+
notes: For best results, use **Session ID**
130+
- name: Track UTM Properties to Amplitude
131+
configurable: false
132+
location:
133+
notes: --
134+
- name: Unset Params Referrer on New Session
135+
configurable: false
136+
location:
137+
notes: --
138+
- name: Use Advertising ID for Device ID
139+
configurable: true
140+
location: Actions field **Device ID**.
141+
notes: Update the value so your preferred field appears first in the `coalesce()` function.
142+
- name: Send Custom Language and Country Properties
143+
configurable: true
144+
location: Actions fields **Language** and **Country**
145+
notes: These fields are set by default with values from the context object.
146+
- name: Use Log Revenue v2 API
147+
configurable: false
148+
location:
149+
notes: Not applicable to Cloud mode
150+

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

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Actions Mapping
3+
---
4+
{% assign configMap = site.data.actions.amplitude.config %}
5+
6+
<style>
7+
tr.no-map td {
8+
color: #ddd
9+
}
10+
11+
12+
</style>
13+
## Including non-mappable settings
14+
15+
<table>
16+
<thead>
17+
<tr>
18+
<th>Amplitude 1.0 Destination Setting</th>
19+
<th>Configurable in Amplitude (Actions)?</th>
20+
<th>Details</th>
21+
</tr>
22+
</thead>
23+
<tbody>
24+
{% for category in configMap %}
25+
<tr>
26+
<td colspan="3" style="font-weight: bold; background-color:fafbff;font-size: 10px; text-transform: uppercase;">{{category.category}}</td>
27+
</tr>
28+
{% for setting in category.settings%}
29+
<tr {%unless setting.configurable%}class="no-map"{%endunless%}>
30+
<td>{{setting.name}}</td>
31+
<td>{{setting.configurable}}</td>
32+
<td>{% if setting.location %}{{setting.location}} <br /> <br /> {% endif %}{{setting.notes}}</td>
33+
</tr>
34+
{% endfor %}
35+
{% endfor %}
36+
</tbody>
37+
</table>
38+
39+
40+
## Hiding non-mappable settings
41+
<table>
42+
<thead>
43+
<tr>
44+
<th>Amplitude 1.0 Destination Setting</th>
45+
<th>Location in Amplitude (Actions)</th>
46+
</tr>
47+
</thead>
48+
<tbody>
49+
{% for category in configMap %}
50+
<tr>
51+
<td colspan="3" style="font-weight: bold; background-color:fafbff;font-size: 10px; text-transform: uppercase;">{{category.category}}</td>
52+
</tr>
53+
{% for setting in category.settings%}
54+
{% if setting.configurable == true %}
55+
<tr>
56+
<td>{{setting.name}}</td>
57+
<td>{% if setting.location %}{{setting.location}} <br /> <br /> {% endif %}{{setting.notes}}</td>
58+
</tr>
59+
{% endif %}
60+
{% endfor %}
61+
{% endfor %}
62+
</tbody>
63+
</table>

0 commit comments

Comments
 (0)