You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/_includes/content/destination-dossier.html
+6-1Lines changed: 6 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,12 @@
43
43
<h6>Destination Info</h6>
44
44
<ulclass="qi">
45
45
{% if destMethods.size > 0 %}<li>Accepts {% for method in destMethods%}{% if destMethods.size == 1 %}{{method}} calls.{% else %}{% unless forloop.last == true %}{{method}}, {% endunless %}{% if forloop.last == true%}and {{method}} calls{%endif%}{% endif %}{% endfor %}</li>{% endif %}
46
-
<li>Referred to as <strong>{{previous_names | join: '</strong>, or <strong>' }}</strong> in the <ahref="/docs/guides/filtering-data/#filtering-with-the-integrations-object">Integrations object</a></li>
46
+
{% if previous_names.size == 1 or components.size == 0 %}
47
+
<li>Refer to it as <strong>{{previous_names | join: '</strong>, or <strong>' }}</strong> in the <ahref="/docs/guides/filtering-data/#filtering-with-the-integrations-object">Integrations object</a></li>
48
+
{% else %}
49
+
{% if connectionModes.cloud.web == true or connectionModes.cloud.mobile == true or connectionModes.cloud.server == true %} <li>In Cloud-mode, refer to it as <strong>{{previous_names | join: '</strong>, or <strong>' }}</strong> in the <ahref="/docs/guides/filtering-data/#filtering-with-the-integrations-object">Integrations object</a></li>{%endif%}
50
+
{% if connectionModes.device.web == true or connectionModes.device.mobile == true or connectionModes.device.server == true %} <li>In Device-mode, refer to it as <strong>{{previous_names | first}}</strong> in the <ahref="/docs/guides/filtering-data/#filtering-with-the-integrations-object">Integrations object</a></li>{%endif%}
51
+
{% endif %}
47
52
{% if destinationInfo.status == "PUBLIC_BETA" %}<li>This destination is in <spanclass="release-pill">Beta</span></li>{% endif %}
## Adding {{ currentIntegration.display_name }} to the integrations object
51
49
52
-
To add {{ currentIntegration.display_name }} to the `integrations` JSON object (for example, [to filter data from a specific source](/docs/guides/filtering-data/#filtering-with-the-integrations-object)), use one of the following valid names for this integration:
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/google-ads-classic/index.md
+4-7Lines changed: 4 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,11 @@ hide-personas-partial: true
6
6
cmode-override: true
7
7
id: 54521fd525e721e32a72ee92
8
8
---
9
-
> info ""
10
-
> The Google Ads (Classic) destination code is available on GitHub [here](https://github.com/segment-integrations/analytics.js-integration-adwords){:target="_blank"}.
9
+
> warning "The Google Ads (Classic) destination is outdated."
10
+
> For website tracking, Google released a new version of Google Ads that uses [a global site tag (gtag.js)](https://support.google.com/google-ads/answer/7548399?hl=en){:target="_blank"}. Segment supports the global site tag in the [Google Ads (Gtag) destination](/docs/connections/destinations/catalog/google-adwords-new/). For mobile tracking, Google recommends using their [Firebase SDKs](https://support.google.com/google-ads/answer/6397604?hl=en){:target="_blank"}. Segment supports a Firebase implementation with the [Google Firebase destination](/docs/connections/destinations/catalog/firebase/).
11
11
12
12
## Getting Started
13
13
14
-
> info ""
15
-
> Google released a new version of Google Ads that uses [a Global Site Tag (or Gtag)](https://support.google.com/adwords/answer/7548399?hl=en). Segment supports this using a different version of the destination - see the documentation for [Google Ads (Gtag)](/docs/connections/destinations/catalog/google-adwords-new/) for more details.
16
-
17
14
With Segment, you can use your events to fire a Google Ads conversion pixel from your website **in client-side JavaScript.**
18
15
You can also trigger Google Ads (Classic) conversion from your mobile app using the **Server to Server** destination, so you don't need to include the SDK in your app. The server to server connection requires mobile device specific details to forward the events to Google Ads (Classic). Google Ads (Classic) **does not work with any server-side libraries**. Make sure when you're setting up your Google Ads (Classic) conversions that you choose the appropriate tracking method.
19
16
@@ -47,7 +44,7 @@ To find a conversion ID look inside of your Google Ads (Classic) account and nav
47
44
48
45
If you select "Website," click through to the "Review and Install" step in the Google Ads (Classic) dashboard. Scroll down to the "Install your tag" section and look for `w.google_conversion_id`. Copy the string directly to the right of it, and paste it into the Google Ads (Classic) section of your Segment destination tab.
49
46
50
-
If you select "App" you can choose to track conversions from Firebase, Google Play, or first opens and in-app actions. For more on setting up moble tracking, see [Server to Server Destination for Mobile Apps](#mobile--server) further down on this page.
47
+
If you select "App" you can choose to track conversions from Firebase, Google Play, or first opens and in-app actions. For more on setting up mobile tracking, see [Server to Server Destination for Mobile Apps](#mobile--server) further down on this page.
51
48
52
49
> info ""
53
50
> If using the New Adwords Experience, the Conversion ID can now be found in a different location. Navigate to Tools, Billing, and Settings menu and, then, select "Measurement: Conversions", which opens to the "Conversion Actions" table. From here you can drill down to the conversion "Tag setup" to view the tag details. From here, select Use Google Tag Manager card in order to expose the Conversion ID.
@@ -135,7 +132,7 @@ All `track` events are by default sent to your Google Ads (Classic) account and
135
132
8. ecommerce_purchase
136
133
9. custom
137
134
138
-
Segment integrates with these event types using the use of the [Semantic Event Spec](/docs/connections/spec/semantic/). Each individual mapping Segment supports is documented in the sections below. Any event Segment recieves that is not a mapped semantic event will be sent to Google Ads (Classic) as a `custom` event type.
135
+
Segment integrates with these event types using the use of the [Semantic Event Spec](/docs/connections/spec/semantic/). Each individual mapping Segment supports is documented in the sections below. Any event Segment receives that is not a mapped semantic event will be sent to Google Ads (Classic) as a `custom` event type.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/google-ads-gtag/index.md
+11-14Lines changed: 11 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -6,22 +6,19 @@ strat: google
6
6
name-override: true
7
7
id: 5a03bfe73156760001ab34ec
8
8
---
9
-
## Before you begin
10
9
11
-
If you're using the [new Google Ads (Gtag) experience](https://support.google.com/adwords/answer/6095821?hl=en&ref_topic=3165803), you can enable the **Google Ads (Gtag)** Destination (previously called "Google Adwords New") in the Segment catalog. The new Google Ads uses a Global Site Tag (Gtag) and event snippets.
10
+
The [Google global site tag (gtag.js)](https://support.google.com/google-ads/answer/7548399?hl=en){:target="_blank"} is a JavaScript tagging framework and API that allows you to send web conversions to Google Ads. With the Segment Google Ads (Gtag) destination, Segment loads gtag.js for you so you can make efficient use of your existing tracking implementation.
12
11
13
-
> info "Info message."
14
-
> **IMPORTANT**: Only use this destination if your Google Ads account is using the _New_ (Gtag) Experience. If you're using Google Tag Manager (a separate product) as well, don't add the global site tag again in your GTM containers. You should also disable any [Google Ads (Classic)](/docs/connections/destinations/catalog/adwords/) destinations within the same source, since **Google Ads (Classic)** can't load at the same times as **Google Ads (Gtag)**.
12
+
> info ""
13
+
> Only use this destination if your Google Ads account is using Gtag. If you're using Google Tag Manager, don't add the global site tag (gtag.js) in your GTM containers. You should also disable any [Google Ads (Classic)](/docs/connections/destinations/catalog/adwords/) destinations within the same source, since **Google Ads (Classic)** can't load at the same time as **Google Ads (Gtag)**.
15
14
16
15
## Getting Started
17
16
18
-
You can use this destination to map your `.page()` calls to **Page Load Conversions** or `.track()` calls to **Click Conversions**.
19
-
20
-
Currently this is only supported on the browser.
17
+
You can use this destination to map your `.page()` calls to **Page Load Conversions** or `.track()` calls to **Click Conversions**. Currently this is only supported on the browser.
21
18
22
19
## Page
23
20
24
-
If you want to map all your unnamed `.page()` calls to a default Page Load Conversion, you can enter the AdWords Conversion ID in **Settings > Default Page Conversion**. However, if you created specific Page Load Conversions in Google Ads that you'd like to map your named `.page()` calls in Segment, you can map the events in **Settings > Page Load Conversions**.
21
+
If you want to map all your unnamed `.page()` calls to a default Page Load Conversion, you can enter the Conversion ID in **Settings > Default Page Conversion**. However, if you created specific Page Load Conversions in Google Ads that you'd like to map your named `.page()` calls in Segment, you can map the events in **Settings > Page Load Conversions**.
25
22
26
23
Segment forwards all the `properties` of the page call, such as `path`, `title`, `url`, because by default, Google Ads (Gtag) makes these available in your remarketing campaigns.
27
24
@@ -48,9 +45,9 @@ If you pass `properties.value`, `properties.currency`, or `properties.order_id`,
48
45
49
46
The only exception is that for `Order Completed` events, Segment will map Google's semantic `value` field to your `properties.revenue`.
50
47
51
-
## Troubleshooting AdWords Conversions
52
-
To figure out if an event is flagged for Conversion by the AdWords SDK, follow these steps:
53
-
1. Confirm that the events mapped to Google Ads Conversion are being sent in device-mode while using the Segment Analytics.js library. To do this:
48
+
## Troubleshooting Google Ads Conversions
49
+
To figure out if an event is flagged for conversion, follow these steps:
50
+
1. Confirm that the events mapped to a Google Ads conversion are being sent in device-mode while using the Segment Analytics.js library. To do this:
54
51
1. Go to **Connections > Sources** in your workspace and choose your Source.
55
52
2. Go to the **Debugger** tab.
56
53
3. Click on an event and look at the **Raw** view to make sure the events have a library name of `analytics.js`. There should be a snippet of code that looks like this:
@@ -66,16 +63,16 @@ To figure out if an event is flagged for Conversion by the AdWords SDK, follow t
66
63
67
64

68
65
69
-
5. Go to the **Settings** tab for your Gtag destination in Segment on a new webpage and choose **Click Conversions** to look at the mapped `track()` events and make sure the events are mapped to the correct **Adwords Conversion Label**.
66
+
5. Go to the **Settings** tab for your Gtag destination in Segment on a new webpage and choose **Click Conversions** to look at the mapped `track()` events and make sure the events are mapped to the correct **Conversion Label**.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/hotjar/index.md
+31-19Lines changed: 31 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -3,41 +3,36 @@ title: Hotjar Destination
3
3
rewrite: true
4
4
id: 5913371070a3e552b9561a4e
5
5
---
6
-
[Hotjar](https://help.hotjar.com/hc/en-us) is the fast & visual way to understand your users. It offers a full set of user experience tools: heatmaps, session recordings, forms reporting, funnels, and feedback tools, giving you everything your team needs to uncover user insights and make the right changes.
6
+
[Hotjar](https://hotjar.com){:target="_blank"} enables you to understand your users in a fast and visual way. Hotjar offers a full set of tools such as analytics, page heatmaps, session recordings, feedback tools, and more. Hotjar provides you with everything your team needs to uncover user insights and make the right product changes.
7
7
8
-
The Segment Hotjar Destination allows you to both easily install Hotjar on your pages, and send [User Attributes](https://help.hotjar.com/hc/en-us/articles/360038394053-How-to-Setup-User-Attributes-in-4-Steps) information over Hotjar's [Identify API](https://help.hotjar.com/hc/en-us/articles/360033640653) using the Segment Identify Spec. As of February 3rd, 2020, this allows you to:
9
-
10
-
*[Target Polls and Incoming Feedback to users based on their User Attributes](https://help.hotjar.com/hc/en-us/articles/360022688554)
11
-
*[Lookup and Delete user data based on their User ID](https://help.hotjar.com/hc/en-us/articles/360001749014)
12
-
13
-
In time, most or all Hotjar features will use User Attributes in some way, with filtering Recordings planned in the first half of 2020.
14
-
15
-
This destination is maintained by Segment.
8
+
The Segment Hotjar Destination allows you to get started with Hotjar and its core APIs. You can:
9
+
1. Automatically install the [Hotjar Tracking Code](https://help.hotjar.com/hc/en-us/articles/115011639927){:target="_blank"}.
10
+
2. Automatically send [user attributes](https://help.hotjar.com/hc/en-us/articles/360033640653-Identify-API-Reference){:target="_blank"} to Hotjar by connecting your Segment `identify` calls with Hotjar's own Identify API.
11
+
3. Automatically send [custom events](https://help.hotjar.com/hc/en-us/articles/4405109971095-Events-API-Reference){:target="_blank"} to Hotjar by connecting your Segment `track` calls with Hotjar's own Events API.
16
12
13
+
Knowing who your users are and what they're doing unlocks more advanced filtering and targeting capabilities across all of Hotjar's tools, helping you find meaningful insights faster.
17
14
18
15
## Getting Started
19
16
20
17
{% include content/connection-modes.md %}
21
18
22
-
1.From the Segment web app, click **Catalog**.
19
+
1.Navigate to **Connections** and click **Add Destination** From the Segment web app.
23
20
24
-
2. Search for "Hotjar" in the Catalog, select it, and choose which of your Javascript sources to connect the destination to.
21
+
2. Search for *Hotjar* in the Catalog, select it, and choose the Javascript source you want to connect the destination to.
25
22
26
-
3. Add your Hotjar Site ID to your Destination settings. You can find this under Settings and Sites & Organizations in your Hotjar dashboard. It should be a whole number (e.g. 123456).
23
+
3. Add your **Hotjar Site ID** to your Destination settings. You can find this ID in Account settings > Sites & Organizations.
27
24
28
-
4. Your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Hotjar's tracking snippet, along with your Site ID, onto the page. If you are already using Hotjar, remove Hotjar's snippet from your code.
29
-
30
-
Hotjar automatically starts tracking visitors based on the tools you have enabled in your Hotjar dashboard.
25
+
Your changes will appear in the Segment CDN after 45 minutes, and then Analytics.js will start to asynchronously load Hotjar's tracking snippet and send data. If you're already using Hotjar, remove Hotjar's snippet from your code.
31
26
32
27
## Identify
33
28
34
-
The Hotjar destination will automatically ingest a User ID, as well as values sent over your Identify spec as [traits](/docs/connections/spec/identify/#traits), as long as [User Attributes are enabled in Hotjar](https://help.hotjar.com/hc/en-us/articles/360038394053-How-to-Setup-User-Attributes-in-4-Steps#step-2-review-your-privacy-requirements-and-enable-user-attributes).
29
+
The Hotjar destination will automatically ingest a User ID and any values sent over your Identify spec as [traits](/docs/connections/spec/identify/#traits), as long as session capture is enabled in Hotjar.
35
30
36
31
Identify calls that do not have a User ID value will not be sent to Hotjar.
37
32
38
33
### Nested values or lists
39
34
40
-
The Hotjar Identify API is unable to ingest values passed as nested objects or lists over your `identify` Spec:
35
+
Currently, the Hotjar Identify API **does not** support ingesting values passed as nested objects or lists over your identify Spec:
41
36
42
37
```js
43
38
"traits": {
@@ -54,6 +49,23 @@ The Hotjar Identify API is unable to ingest values passed as nested objects or l
54
49
}
55
50
```
56
51
57
-
In this example, Hotjar would reject all the values in the `address` field.
52
+
In the example above, Hotjar rejects all the values in the `address` field.
53
+
54
+
## Track
55
+
56
+
The Hotjar destination automatically ingests any user actions tracked over your Track spec as [events](/docs/connections/spec/track/), as long as session capture is enabled in Hotjar.
57
+
58
+
### Event properties
59
+
60
+
Currently, the Hotjar Events API **does not** support ingesting event properties:
61
+
62
+
```js
63
+
analytics.track("Experiment Viewed", {
64
+
experiment_id:"1234",
65
+
experiment_name:"new_upsell_UX"
66
+
variation_id:"1234b"
67
+
variation_name:"variant"
68
+
});
69
+
```
58
70
59
-
This is a recognized limitation of this version of the Hotjar Identify API, and as of February 3rd, 2020, is in the improvements backlog for the API.
71
+
In the example above, Hotjar only ingests the event name, `Experiment Viewed`. All of its event properties are rejected.
Segment sends Group calls to Variance as an `Account` if you've chosen the "Group" Account Mapping method during setup.
87
87
88
+
### Alias
89
+
90
+
If you're not familiar with the Segment Spec, take a look at the [Alias method documentation](/docs/connections/spec/alias/) to learn about what it does. An example call would look like this:
91
+
92
+
```js
93
+
analytics.alias('123456')
94
+
```
95
+
96
+
If there is an existing user with that `userId` in Variance that matches the `previousId` passed with the alias, that user will be merged into the "123456" user identified in the alias. If there is only one user with the `previousId` and no user with the `userId`, that user will have their Variance `externalId` updated to match the current `userId` passed in the alias.
97
+
88
98
## Account Mapping
89
99
90
100
Variance offers several ways to map your users to accounts or companies, including the following.
0 commit comments