Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 68 additions & 68 deletions src/_data/catalog/destinations.yml

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/_data/glossary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Computed trait: |
[Computed traits](/docs/personas/computed-traits/) are per-user, or per-account [traits](#traits) that you create or “compute” in [Personas](/docs/personas/). When you build a Computed Trait, Personas adds it to relevant user profiles.

Custom trait: |
[Custom Traits](/docs/personas/#custom-traits) are user or account properties collected from all the events you send to Personas. For example, you can add any properties that you send as a part of your track calls or identify calls (`email`, `first_name`, `last_name`) as custom traits. You can then view them in the profile explorer, and use them in your audiences, computed traits and SQL traits.
[Custom Traits](/docs/personas/audiences/#custom-traits) are user or account properties collected from all the events you send to Personas. For example, you can add any properties that you send as a part of your track calls or identify calls (`email`, `first_name`, `last_name`) as custom traits. You can then view them in the profile explorer, and use them in your audiences, computed traits and SQL traits.

Debugger: |
This is the place in the app where you can see your events flowing through Segment
Expand Down Expand Up @@ -84,7 +84,7 @@ Method: |
A method is programming speak for "an action an object can take". It's a specific type of function that is attached to an object. All of our analytics tracking libraries create `analytics` objects, and then `track`, `identify`, `page`, [etc](/docs/connections/spec/) are methods you can invoke on those objects.

MTU: |
Monthly Tracked Users. You can find more about how they are calculated [here](https://segment.com/docs/guides/usage-and-billing/how-are-mtus-calculated-by-segment/) but in short, they are calculated by adding the number unique userIds and number of unique anonymousIds that a customer tracks with Segment.
Monthly Tracked Users. You can find more about how they are calculated [here](https://segment.com/docs/guides/usage-and-billing/mtus-and-throughput/#how-does-segment-calculate-mtus) but in short, they are calculated by adding the number unique userIds and number of unique anonymousIds that a customer tracks with Segment.

Object: |
An object is a type of data that persists over time and can be updated, for example a Business or a User record. Objects have "traits" which record information about that object, and which can change over time. For example a "user" object could have a trait of "email" which doesn't change often, but could also have a [computed trait](#computed-trait) like `logged_in_last_7_days`. (Objects are in contrast to "[events](#event)" which happen at a single moment in time, and whose properties do not change.)
Expand Down
2 changes: 1 addition & 1 deletion src/_includes/content/client-side-script-unverified.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Many times this is a limitation on the tool's detection process, where the detector is looking for a specific HTML element on your page. Our client side analytics.js library asynchronously loads the tool's library or pixel onto the page. As such, the detection fails.

In order to confirm that the tool's library or pixel is actually loaded onto the page, you can open up the [javascript console](/docs/connections/sources/catalog/libraries/website/javascript#how-do-i-open-the-javascript-console-in-your-debugger-) and go to the network tab when the page is loading.
In order to confirm that the tool's library or pixel is actually loaded onto the page, you can open up the [javascript console](/docs/connections/sources/catalog/libraries/website/javascript#how-do-i-open-the-javascript-console-in-your-debugger) and go to the network tab when the page is loading.

![Checking network tab to see if script loads](https://i.imgur.com/FdILEbO.gif)

Expand Down
2 changes: 1 addition & 1 deletion src/_includes/content/integrations-identify.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
### More About Identify

To learn more about how `identify` works, check out our [Identify docs](/docs/connections/spec/identify). For example, `email` and `name` are two of our [special traits](/docs/connections/spec/identify#special-traits) that we recognize semantically.
To learn more about how `identify` works, check out our [Identify docs](/docs/connections/spec/identify). For example, `email` and `name` are two of our [special traits](/docs/connections/spec/identify/#traits) that we recognize semantically.
2 changes: 1 addition & 1 deletion src/_includes/content/message-anatomy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The most basic Segment message requires only a `userID` or `anonymousID`; all other fields are optional to allow for maximum flexibility. However, a normal Segment message has three main parts: the [common fields](/docs/spec/common/), the ["context" object](/docs/spec/common#context), and the properties (if it's an event) or traits (if it's an object).
The most basic Segment message requires only a `userID` or `anonymousID`; all other fields are optional to allow for maximum flexibility. However, a normal Segment message has three main parts: the [common fields](/docs/connections/spec/common/), the ["context" object](/docs/connections/spec/common#context), and the properties (if it's an event) or traits (if it's an object).

The common fields include information specific to how the call was generated, like the timestamp and library name and version. The fields in the context object are usually generated by the library, and include information about the environment in which the call was generated: page path, user agent, OS, locale settings, etc. The properties and traits are optional and are where you customize the information you want to collect for your implementation.

Expand Down
2 changes: 1 addition & 1 deletion src/_includes/content/troubleshooting-server-debugger.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
### No events in my debugger

1. Double check that you've followed all the steps in the [Quickstart](quickstart/#getting-started).
1. Double check that you've followed all the steps in the [Quickstart](quickstart/).

2. Make sure that you're calling one of our API methods once the library is successfully installed—[`identify`](#identify), [`track`](#track), etc.
4 changes: 2 additions & 2 deletions src/connections/data-export-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ You can use our [webhooks destination](/docs/connections/destinations/catalog/we

#### Iron.io

Another one of our destinations is [Iron.io](/docs/connections/destinations/catalog/iron.io/). They function similar to webhooks, but they will manage the message queue and allow you to run scripts on your data before routing it to another end point. Again this is similar to what Segment does for our business customers, but will require a decent amount of work from your team, however it will be much more reliable if your event volume gets high.
Another one of our destinations is [Iron.io](/docs/connections/destinations/catalog/iron-io/). They function similar to webhooks, but they will manage the message queue and allow you to run scripts on your data before routing it to another end point. Again this is similar to what Segment does for our business customers, but will require a decent amount of work from your team, however it will be much more reliable if your event volume gets high.

#### 3rd Party Reporting APIs

This option is the most restrictive but might be the easiest if you need only basic basic data to be exported. A few examples would be to use the reporting APIs [Clicky](/docs/connections/destinations/catalog/clicky) or [Google Analytics](/docs/connections/destinations/catalog/google-analytics) provide (after turning those tools on in Segment and sending them data). Those APIs aren't super flexible and you won't see all the data from Segment, but for basic metrics they should work. One tool that's a bit more flexible when it comes to a reporting API is [Keen.io](/docs/connections/destinations/catalog/keen-io), which is also available on the Segment platform.
This option is the most restrictive but might be the easiest if you need only basic basic data to be exported. A few examples would be to use the reporting APIs [Clicky](/docs/connections/destinations/catalog/clicky) or [Google Analytics](/docs/connections/destinations/catalog/google-analytics) provide (after turning those tools on in Segment and sending them data). Those APIs aren't super flexible and you won't see all the data from Segment, but for basic metrics they should work. One tool that's a bit more flexible when it comes to a reporting API is [Keen.io](/docs/connections/destinations/catalog/keen/), which is also available on the Segment platform.
8 changes: 4 additions & 4 deletions src/connections/destination-data-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "How do I use Schema Controls?"
---

Once you have enabled Destinations for a given Source, all of the [data](https://segment.com/docs/connections/spec/) you track will be routed to your connected tools and warehouses. If you no longer wish to send all data to a particular Destination, you can disable the Destination from the Source overview page. 
Once you have enabled Destinations for a given Source, all of the [data](/docs/connections/spec/) you track will be routed to your connected tools and warehouses. If you no longer wish to send all data to a particular Destination, you can disable the Destination from the Source overview page. 

But what happens when you want to send all of your data to a warehouse, and only two specific events to an analytics tool? And once you're satisfied with your spec, how do you make sure rogue events are blocked from all of your warehouses and end tools? Segment gives you the power to control exactly what data is allowed into your Destinations, so you can protect the integrity of your data, and the decisions you make with it.

Expand All @@ -25,7 +25,7 @@ analytics.identify('user_123', {
});
```

Destination flags are **case sensitive** and match [the Destination's name in the docs](https://segment.com/docs/integrations) (i.e. "AdLearn Open Platform", "awe.sm", "MailChimp", etc.).
Destination flags are **case sensitive** and match [the Destination's name in the docs](/docs/connections/destinations/catalog/) (i.e. "AdLearn Open Platform", "awe.sm", "MailChimp", etc.).

If you're on Segment's Business plan, you can filter track calls right from the Segment UI on your Source Schema page by clicking on the field in the "Integrations" column and then adjusting the toggle for each tool. We recommend using the UI if possible since it's a much simpler way of managing your filters and can be updated with no code changes on your side.

Expand All @@ -35,7 +35,7 @@ If you're on Segment's Business plan, you can filter track calls right from the

If you no longer want to track an event, you can either remove it from your code or, if you're on the Business plan, you can block track calls right from the Segment UI on your Source Schema page by adjusting the toggle for each event.

![](images/asset_ZCRZqdO9.gif)
![](/docs/protocols/images/asset_ZCRZqdO9.gif)

Once you block an event in Segment, we'll stop forwarding it to all of your Destinations, including your warehouses. You can remove it from your code at your leisure. In addition to blocking track calls, Business plan customers can block all Page and Screen calls, as well as Identify traits and Group properties. 

Expand Down Expand Up @@ -83,7 +83,7 @@ No new identify traits will be allowed in Segment or sent to your Destinations.

For example, if you set your Schema Defaults for New Events to "Block," and a new event, `Order Completed`, is tracked, Segment will automatically block the event and it will not be sent to your warehouse or downstream tools. The event will continue to be blocked until you actively choose to allow it.

You will need to upgrade to the latest [iOS](https://segment.com/docs/connections/sources/catalog/libraries/mobile/ios/#install-the-sdk) and/or [Android](https://segment.com/docs/connections/sources/catalog/libraries/mobile/android/#step-1-install-the-library) SDKs for Schema Defaults to apply to events sent from mobile sources. 
You will need to upgrade to the latest [iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#install-the-sdk) and/or [Android](/docs/connections/sources/catalog/libraries/mobile/android/#step-1-install-the-library) SDKs for Schema Defaults to apply to events sent from mobile sources. 

## **What is considered a "new" event?**

Expand Down
4 changes: 2 additions & 2 deletions src/connections/destinations/catalog/adikteev/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ This destination is maintained by Adikteev. For any issues with the destination,

Currently, this destination supports events originating from Mobile sources alone.

You can read more about how to define a source [here](https://segment.com/docs/guides/getting-started/what-is-a-source/).
You can read more about how to define a source [here](/docs/connections/sources/#what-is-a-source).

To get started with Adikteev and Segment, you'll need an account with Adikteev.

If you don't have an account with Adikteev and want to use our services together with Segment contact us here: [contact@adikteev.com](mailto:contact@adikteev.com).

## Track

Adikteev is built to understand and analyze all the events generated by your app. For us to receive and analyze the events correctly, make sure you use the right [Track](https://segment.com/docs/connections/spec/track/) events as specified by Segment's Spec.
Adikteev is built to understand and analyze all the events generated by your app. For us to receive and analyze the events correctly, make sure you use the right [Track](/docs/connections/spec/track/) events as specified by Segment's Spec.
16 changes: 5 additions & 11 deletions src/connections/destinations/catalog/adobe-analytics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,6 @@ The following documentation provides detailed explanation of how both destinatio

<!-- TOC depthFrom:2 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 -->

- [Planning for Adobe Analytics](#planning-for-adobe-analytics)
- [Device-mode - Analytics.js](#device-mode-analytics-js)
- [Cloud-mode - aka Server-side](#cloud-mode-aka-server-side)
- [Implementing Segment for Adobe Analytics](#implementing-segment-for-adobe-analytics)
- [Adobe Analytics List Variables - lVars](#adobe-analytics-list-variables-lvars)
- [Adobe Analytics Properties - props](#adobe-analytics-properties-props)
- [Configuring Adobe Analytics Settings](#configuring-adobe-analytics-settings)
- [Setting up Adobe Analytics for Mobile](mobile/)
- [Setting up Adobe Heartbeat](heartbeat/)
- [Best Practices](best-practices/)
Expand All @@ -34,6 +27,7 @@ We strongly recommend that you create a tracking plan for both your Segment and


### Choosing between Device-mode and Cloud-mode

If you're using device-mode javascript, by default Segment "bundles" (mobile) or "wraps" (when using Analytics.js) the Adobe libraries. In this configuration, Segment sends Events directly from the client using the Adobe Analytics `Appmeasurement.js` library. Adobe's client-side libraries can provide services to other Adobe suites and products, however they can also increase the size of your page.

If you prefer, you can enable [Cloud-mode](/docs/connections/destinations/#connection-modes), and send data through the Segment servers where it is then mapped and sent on to Adobe Analytics. You enable Cloud-mode for Javascript or Legacy sources from the Adobe Analytics source settings in the Segment app.
Expand Down Expand Up @@ -79,7 +73,7 @@ To use Adobe's Marketing Cloud Visitor ID Service, enter your **Marketing Cloud

"Cloud-mode" data is data sent _without_ bundling the Segment-Adobe-Analytics SDK. It can be sent using mobile libraries, Analytics.js, and other server-based sources.

*For more information on mobile native integrations using Segment's iOS and Android Adobe Analytics SDKs, see the [next section in this doc](#setting-up-adobe-analytics-for-mobile).*
*For more information on mobile native integrations using Segment's iOS and Android Adobe Analytics SDKs, see the [page on mobile set up](mobile/).*

**Important**: For data sent from server-side libraries, you need to predefine your events and custom properties to send events to Adobe Analytics server-side destination. However, *for data sent from mobile devices*, we send *every* event along automatically, and you can use the Adobe Analytics [processing rules](https://marketing.adobe.com/resources/help/en_US/reference/processing_rules.html) UI to map actions, lifecycle dimensions, and custom properties from `contextData` to events, props and eVars.

Expand Down Expand Up @@ -132,7 +126,7 @@ When we generate the XML to send to Adobe, there are a few things that happen:

**Important**: The Android library can collect the `userAgent` automatically - however, the iOS library cannot do so. However, since we do collect other contextual metadata about your device, we render a valid iOS userAgent string that populates all your Mobile Web Reports.

6. If you are using the [Marketing Cloud ID Service](https://marketing.adobe.com/resources/help/en_US/mcvid/mcvid_overview.html), you can pass the **Marketing Cloud Visitor ID** as an destination specific setting and we set that as `<marketingCloudVisitorID>`.
6. If you are using the [Marketing Cloud ID Service](https://marketing.adobe.com/resources/help/en_US/mcvid/mcvid_overview.html), you can pass the **Marketing Cloud Visitor ID** as a destination-specific setting and we set that as `<marketingCloudVisitorID>`.

(In Node.js)
```javascript
Expand Down Expand Up @@ -203,7 +197,7 @@ Support for additional "stateful" lifecycle dimensions is coming in a future Ado

## Implementing Segment for Adobe Analytics

This section contains information about how to implement Segment calls for Adobe Analytics. You can choose to use the [automatic Ecommerce Spec mapping](#using-default-ecommerce-spec-events) so you don't have to set up a mapping in Segment and Adobe. If you need more event types or different ones, you can implement custom [Page calls](#creating-page-calls) and [Track events](#creating-track-events) to add to the standard Ecommerce spec. <!-- TODO: You can also override or opt-out of automatically mapping the Ecommerce events by passing `integration: AA: false` as part of your call.-->
This section contains information about how to implement Segment calls for Adobe Analytics. You can choose to use the [automatic Ecommerce Spec mapping](#using-default-ecommerce-spec-events) so you don't have to set up a mapping in Segment and Adobe. If you need more event types or different ones, you can implement custom [Page calls](#creating-page-calls) and [Track events](#creating-custom-track-events) to add to the standard Ecommerce spec. <!-- TODO: You can also override or opt-out of automatically mapping the Ecommerce events by passing `integration: AA: false` as part of your call.-->

### Using default Ecommerce Spec Events

Expand Down Expand Up @@ -551,7 +545,7 @@ This option allows you to associate a standard Visitor ID with the event.
```

## Link Names, Link URLs, Link Types
See [this](#setting-custom-linktypes-linknames-and-linkurls) section for information about configuring these as options.
See [this](best-practices/#setting-custom-linktypes-linknames-and-linkurls) section for information about configuring these as options.

## Configuring Adobe Analytics Settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can read more about how to send Algolia-related data to Segment from [the do

## Track

If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/spec/track/) does.
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does.

Algolia supports the following six events from Segment's [Ecommerce Spec](https://segment.com/docs/connections/spec/ecommerce/v2/).

Expand Down
Loading