diff --git a/src/_data/sidenav/strat.yml b/src/_data/sidenav/strat.yml index 3ebb549ff2..8f75ab9acc 100644 --- a/src/_data/sidenav/strat.yml +++ b/src/_data/sidenav/strat.yml @@ -185,3 +185,11 @@ sections: title: Analytics-Swift - path: /connections/sources/catalog/libraries/mobile/swift-ios/migration title: Analytics-Swift Migration Guide + +- slug: node-js + section_title: Analytics-Node.js Documentation + section: + - path: /connections/sources/catalog/libraries/server/node/ + title: Analytics-Node.js + - path: /connections/sources/catalog/libraries/server/node/quickstart/ + title: Quickstart Node.js diff --git a/src/connections/destinations/catalog/google-analytics/index.md b/src/connections/destinations/catalog/google-analytics/index.md index 5812751f09..06582e089a 100644 --- a/src/connections/destinations/catalog/google-analytics/index.md +++ b/src/connections/destinations/catalog/google-analytics/index.md @@ -112,16 +112,7 @@ Google Universal Analytics has multiple scopes for each custom dimensions: hit ( #### Setting up Custom Dimensions First, [configure the Custom Dimensions](https://support.google.com/analytics/answer/2709829?hl=en) from your Google Universal Analytics admin page. -Once you finish this set up in Google Universal Analytics, you can to map traits and properties to your custom dimensions. Go to the Google Universal Analytics destination settings in the Segment App and locate the **Custom Dimensions** setting. This is where you will enter your mapping. - -The following images show an example of mapping "Gender" to dimension "1" and "User Type" to dimension "2": - -On Segment: -![custom dimension mapping screenshot](images/dimension-mapping.png) -On Google: -![custom dimension mapping screenshot](images/dimension-mapping-google-analytics.png) - -You can only map each trait or property to one Custom Dimension at a time. +Once you finish this set up in Google Universal Analytics, you can map traits and properties to your custom dimensions. Go to the Google Universal Analytics destination settings in the Segment App and locate the **Custom Dimensions** setting. This is where you will enter your mapping. You can only map each trait or property to one Custom Dimension at a time. When you finish mapping dimensions and save the settings, Segment checks if the user traits and properties in [Identify](/docs/connections/spec/identify/), [Track](/docs/connections/spec/track/) and [Page](/docs/connections/spec/page/) calls are defined as a dimension. If they are defined in your mapping, Segment sends that dimension to Google Universal Analytics. @@ -747,7 +738,7 @@ This source can be your server-side source. From there, its easy to send data to ### Consent Mode -Segment does not support Google's [Consent Mode](https://support.google.com/analytics/answer/9976101?hl=en){:target="_blank"} feature. Consent Mode enables you to adjust how Google's tags load on your site, based on whether users consent to your use of cookies. This feature requires Google's gtag.js library, and does not work when you use Segment's Google Universal Analytics destination, because it loads [Google's analytics.js library](https://support.google.com/analytics/answer/7476135?hl=en#zippy=%2Cin-this-article){:target="blank"} instead of the gtag.js library. +Segment does not support Google's [Consent Mode](https://support.google.com/analytics/answer/9976101?hl=en){:target="_blank"} feature. Consent Mode enables you to adjust how Google's tags load on your site, based on whether users consent to your use of cookies. This feature requires Google's gtag.js library, and does not work when you use Segment's Google Universal Analytics destination, because it loads [Google's analytics.js library](https://support.google.com/analytics/answer/7476135?hl=en#zippy=%2Cin-this-article){:target="blank"} instead of the gtag.js library. ### Cookie Domain Name diff --git a/src/connections/sources/catalog/cloud-apps/project/index.md b/src/connections/sources/catalog/cloud-apps/project/index.md index 67bfab2d93..c327e39516 100644 --- a/src/connections/sources/catalog/cloud-apps/project/index.md +++ b/src/connections/sources/catalog/cloud-apps/project/index.md @@ -2,5 +2,6 @@ title: 'Project Source' hidden: true id: qqE6TuEDEM +published: false --- - \ No newline at end of file + diff --git a/src/connections/sources/catalog/cloud-apps/twilio-event-streams-beta/index.md b/src/connections/sources/catalog/cloud-apps/twilio-event-streams-beta/index.md index 19a895306f..73dfa0a77b 100644 --- a/src/connections/sources/catalog/cloud-apps/twilio-event-streams-beta/index.md +++ b/src/connections/sources/catalog/cloud-apps/twilio-event-streams-beta/index.md @@ -2,5 +2,6 @@ title: Twilio Event Streams (Beta) hidden: true id: lWMazCg4rS +published: false --- {% include content/source-region-unsupported.md %} diff --git a/src/connections/sources/catalog/libraries/server/node/index.md b/src/connections/sources/catalog/libraries/server/node/index.md index a066a81909..b709f70817 100644 --- a/src/connections/sources/catalog/libraries/server/node/index.md +++ b/src/connections/sources/catalog/libraries/server/node/index.md @@ -2,6 +2,7 @@ title: Analytics for Node.js redirect_from: '/connections/sources/catalog/libraries/server/node-js/' repo: analytics-node +strat: node-js --- Our Node.js library lets you record analytics data from your node code. The requests hit our servers, and then we route your data to any destinations you have enabled. diff --git a/src/connections/sources/catalog/libraries/server/node/quickstart.md b/src/connections/sources/catalog/libraries/server/node/quickstart.md index 60a7ae3677..508fde4ae9 100644 --- a/src/connections/sources/catalog/libraries/server/node/quickstart.md +++ b/src/connections/sources/catalog/libraries/server/node/quickstart.md @@ -1,114 +1,89 @@ --- title: 'Quickstart: Node.js' redirect_from: '/connections/sources/catalog/libraries/server/node-js/quickstart/' +strat: node-js --- -This tutorial will help you start sending data from your Node servers to Segment and any of our destinations, using our Node library. As soon as you're set up you'll be able to turn on any new destinations with the flip of a switch! - -If you want to dive deeper at any point, check out the [Node library reference](/docs/connections/sources/catalog/libraries/server/node). - -## Step 1: Create a Source in the Segment app - -Before you begin, you need a Workspace (which is a container that holds all of the sources and destinations which are billed together for an organization). If you already created one, great! If not, you can sign up for a free Segment account and create one. - -Next, create a Node.js source from your Workspace: - -1. Click **Add Source**. -2. From the source catalog page, click **Node.js**. -3. Click **Add Source** again from the informational panel that appears to the right. -4. Give the source a display name, and enter the URL the source will collect data from. - -When you create a Source in the Segment web app, it tells the Segment servers that you'll be sending data from a specific source type. When you create (or change!) a Source in the Segment app, Segment generates a new Write Key for that source. You use the write key in your code to tell the Segment servers where the data is coming from, so Segment can route it to your destinations and other tools. - -## Step 2: Install the Module - -Installing Segment is easy, just run the following npm command: - -``` -npm install --save analytics-node -``` - -That will add our Node library module to your `package.json`. The module exposes an `Analytics` constructor, which you need to initialize with your Segment project's **Write Key**, like so: - -```javascript -var Analytics = require('analytics-node'); -var analytics = new Analytics('YOUR_WRITE_KEY'); -``` - -That will create an instance of `Analytics` that you can use to send data to Segment for your project. The default initialization settings are production-ready and queue 20 messages before sending any requests. In development you might want to use [development settings](/docs/connections/sources/catalog/libraries/server/node#development). - -Once you've got that, you're ready to... - - -## Step 3: Identify Users - -> note "" -> **Good to know**: For any of the different methods described in this quickstart, you can replace the properties and traits in the code samples with variables that represent the data collected. - -The `identify` method is how you tell Segment who the current user is. It includes a unique User ID and any optional traits you know about them. You can read more about it in the [identify reference](/docs/connections/sources/catalog/libraries/server/node#identify). - -Here's what a basic call to `identify` might look like: - -```js -analytics.identify({ - userId:'f4ca124298', - traits: { - name: 'Michael Bolton', - email: 'mbolton@example.com', - createdAt: new Date('2014-06-14T02:00:19.467Z') - } -}); -``` - -That's identifying Michael by his unique User ID (the one you know him by in your database) and labeling him with `name` and `email` traits. - -When you're using our Node library, you don't need to identify a user on every request they make to your servers. Instead, we recommend calling `identify` a single time when the user's account is first created, and only identifying again later when their traits are change. - -Once you've added an identify call, you can move on to... - - -## Step 4: Track Actions - -The `track` method is how you tell Segment about which actions your users are performing. Every action triggers what we call an "event", which can also have associated properties. You can read more about `track` in the [track reference](/docs/connections/sources/catalog/libraries/server/node#track). - -Here's what a call to `track` might look like when a user signs up: - -```js -analytics.track({ - userId:'f4ca124298', - event: 'Signed Up', - properties: { - plan: 'Enterprise' - } -}); -``` - -That's just telling us that your user just triggered the **Signed Up** event and chose your hypothetical `'Enterprise'` plan. Properties can be anything you want to record, for example: - -```js -analytics.track({ - userId:'f4ca124298', - event: 'Bookmarked Article', - properties: { - title: 'Snow Fall', - subtitle: 'The Avalanche at Tunnel Creek', - author: 'John Branch' - } -}); -``` - -You'll want to track events that are indicators of success for your site, like **Signed Up**, **Item Purchased** or **Article Bookmarked**. - -To get started, we recommend tracking just a few important events. You can always add more later! - -Once you've added a few `track` calls, **you're done!** You successfully installed analytics tracking on your servers. Now you're ready to turn on any destination you fancy from our interface, margarita in hand. - +This tutorial will help you start sending data from your Node servers to Segment and any destination, using Segment's Node library. Check out the full documentation for [Analytics Node.js](/docs/connections/sources/catalog/libraries/server/node) to learn more. + +To get started with Analytics Node.js: +1. Create a Node.js source in the Segment app. + 1. Navigate to **Connections > Sources > Add Source**. + 2. Search for **Node.js** from the source catalog and click **Node.js**. + 3. Click **Add Source** again from the informational panel that appears to the right. + 4. Give the source a display name, and enter the URL the source will collect data from. + * When you create a Source in the Segment web app, it tells the Segment servers that you'll be sending data from a specific source type. When you create or change a Source in the Segment app, Segment generates a new Write Key for that source. You use the write key in your code to tell the Segment servers where the data is coming from, so Segment can route it to your destinations and other tools. +2. Install the module. + 1. Run the following npm command to install Segment: + ``` + npm install --save analytics-node + ``` + + This will add the Node library module to your `package.json`. The module exposes an `Analytics` constructor, which you need to initialize with your Segment project's **Write Key**, like so: + + ```javascript + var Analytics = require('analytics-node'); + var analytics = new Analytics('YOUR_WRITE_KEY'); + ``` + + This will create an instance of `Analytics` that you can use to send data to Segment for your project. The default initialization settings are production-ready and queue 20 messages before sending any requests. In development you might want to use [development settings](/docs/connections/sources/catalog/libraries/server/node#development). +3. Identify Users. + + * **Note:** For any of the different methods described in this quickstart, you can replace the properties and traits in the code samples with variables that represent the data collected. + + + The `identify` method is how you tell Segment who the current user is. It includes a unique User ID and any optional traits you know about them. You can read more about it in the [identify reference](/docs/connections/sources/catalog/libraries/server/node#identify). Here's what a basic call to `identify` might look like: + + ```js + analytics.identify({ + userId:'f4ca124298', + traits: { + name: 'Michael Bolton', + email: 'mbolton@example.com', + createdAt: new Date('2014-06-14T02:00:19.467Z') + } + }); + ``` + + This identifies Michael by his unique User ID (the one you know him by in your database) and labeling him with `name` and `email` traits. When you're using the Node library, you don't need to identify a user on every request they make to your servers. Instead, Segment recommends calling `identify` a single time when the user's account is first created, and only identifying again later when their traits change. +4. Track Actions. + + Segment recommends tracking just a few important events. You can always add more later. You should track events that are indicators of success for your site, like **Signed Up**, **Item Purchased** or **Article Bookmarked**. + +
The `track` method is how you tell Segment about which actions your users are performing. Every action triggers what Segment calls an "event", which can also have associated properties. You can read more about `track` in the [track reference](/docs/connections/sources/catalog/libraries/server/node#track). + + Here's what a call to `track` might look like when a user signs up: + + ```js + analytics.track({ + userId:'f4ca124298', + event: 'Signed Up', + properties: { + plan: 'Enterprise' + } + }); + ``` + + This tells Segment that your user just triggered the **Signed Up** event and chose your hypothetical `'Enterprise'` plan. Properties can be anything you want to record, for example: + + ```js + analytics.track({ + userId:'f4ca124298', + event: 'Bookmarked Article', + properties: { + title: 'Snow Fall', + subtitle: 'The Avalanche at Tunnel Creek', + author: 'John Branch' + } + }); + ``` + +After you've added a few `track` calls, you've successfully installed analytics tracking on your servers. Now you're ready to turn on any destination from the Segment app. --- - ## What's Next? -We just walked through the quickest way to get started with Segment using node. You might also want to check out our full [Node library reference](/docs/connections/sources/catalog/libraries/server/node) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http/) to get a sense for the bigger picture. +You can check out the full docs for [Analytics Node.js](/docs/connections/sources/catalog/libraries/server/node) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http/) to get a sense for the bigger picture. -You might also want to consider installing [Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/) so that you can use destinations that require being loaded in the browser, like live chat tools or user feedback systems. +You can also consider installing [Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/) so that you can use destinations that require being loaded in the browser, like live chat tools or user feedback systems. diff --git a/src/connections/spec/identify.md b/src/connections/spec/identify.md index a4748ae38f..c3f4964b0a 100644 --- a/src/connections/spec/identify.md +++ b/src/connections/spec/identify.md @@ -1,7 +1,5 @@ --- title: 'Spec: Identify' -related: - - "/docs/connections/sources/catalog/" --- The Segment Identify call lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about the user, like their email, name, etc. diff --git a/src/getting-started/02-simple-install.md b/src/getting-started/02-simple-install.md index 092401744b..90e1388807 100644 --- a/src/getting-started/02-simple-install.md +++ b/src/getting-started/02-simple-install.md @@ -69,7 +69,7 @@ Click a tab below to see the tutorial content for the specific library you chose ### Step 1: Copy the Snippet
-Paste the snippet from the JavaScript Source overview page into the `` tag of your site. +Navigate **Connections > Sources > JavaScript** in the Segment app and copy the snippet from the JavaScript Source overview page and paste it into the `` tag of your site.

That snippet loads Analytics.js onto the page _asynchronously_, so it won't affect your page load speed. Once the snippet runs on your site, you can turn on destinations from the destinations page in your workspace and data starts loading on your site automatically.

diff --git a/src/getting-started/05-data-to-destinations.md b/src/getting-started/05-data-to-destinations.md index 0b638f22c9..628a68f35e 100644 --- a/src/getting-started/05-data-to-destinations.md +++ b/src/getting-started/05-data-to-destinations.md @@ -6,7 +6,7 @@ Once you've got data flowing _into_ Segment, what do you do with it? The Segment ## Routing data to destinations -When you enable a destination in the Segment App, you link it to a specific source (or sources). By default, Segment first processes the data from the selected source(s), then translates it and routes it from the Segment servers to to the API endpoint for that destination. +When you enable a destination in the Segment App, you link it to a specific source (or sources). By default, Segment first processes the data from the selected source(s), then translates it and routes it from the Segment servers to the API endpoint for that destination. This means that if you previously had loaded code or a snippet for that tool on your website or app, you should remove it once you have Segment implemented so you don't send duplicate data.