Skip to content
Open
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
4 changes: 2 additions & 2 deletions src/connections/sources/about-cloud-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Cloud-App Sources (often shortened to Cloud Sources) allow you to pull in data f

As in the basic tracking API, _objects_ usually contain information about a person or group which is updated over time, while _event_ data happens once, and is appended to a list.

### Event Cloud-App Sources
## Event Cloud-App Sources

Event Cloud Sources can export their data both into Segment warehouses, and into other enabled Segment integrations that work with event data.

### Object Cloud-App Sources
## Object Cloud-App Sources

Object Cloud App Sources can export data and import it directly into a Segment warehouse. You *must* have a Segment warehouse enabled before you enable these. From the warehouse, you can analyze your data with SQL, use [Reverse ETL](/docs/connections/reverse-etl) to extract data, or use Engage SQL Traits to build audiences. Some examples of Object Cloud sources are Salesforce (account information), Zendesk (support cases), and Stripe (payments information).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,6 @@ To get started, we recommend tracking just a few important events. You can alway

Once you've added a few `track` calls, **you're done!** You successfully instrumented your app! Now you're ready to turn on any destination you fancy from our interface, margarita in hand.

---

## What's Next?

We just walked through the quickest way to get started with Segment using Analytics-Android. You might also want to check out Segment's full [Analytics-Android reference](/docs/connections/sources/catalog/libraries/mobile/android) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http-api/) to get a sense for the bigger picture.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ tags:
- Xamarin
- Unity
- ASP.NET
id:
redirect_from:
- '/connections/sources/catalog/libraries/mobile/unity/'
- '/connections/sources/catalog/libraries/mobile/csharp/'
Expand All @@ -20,7 +19,8 @@ redirect_from:

With Analytics-CSharp, you can add Segment analytics to your C# based app which includes Unity, Xamarin, .NET. Analytics-CSharp helps you measure your users, product, and business. It unlocks insights into your app's funnel, core business metrics, and whether you have product-market fit. The Analytics-CSharp library is open-source [on GitHub](https://github.com/segmentio/analytics-csharp){:target="_blank"}.

### Supported platforms
## Supported platforms

These platforms support Analytics-CSharp:
* .NET/.NET core/.NET framework
* Mono
Expand Down Expand Up @@ -403,7 +403,7 @@ For example, you might want to disable flushes if you detect the user has no net
}
```

### Create your own flush policies
### Create your own flush policies

You can create a custom FlushPolicy special for your application needs by implementing the `IFlushPolicy` interface. You can also extend the `IFlushPolicy` class that already creates and handles the `shouldFlush` value reset.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,6 @@ To get started, we recommend tracking just a few important events. You can alway

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.


---


## What's Next?

We just walked through the quickest way to get started with Segment using go. You might also want to check out our full [Go library reference](/docs/connections/sources/catalog/libraries/server/go/) 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,6 @@ To get started, we recommend tracking just a few important events. You can alway

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.


---


## What's Next?

We just walked through the quickest way to get started with Segment using go. You might also want to check out our full [Go library reference](/docs/connections/sources/catalog/libraries/server/go/) 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,6 @@ To get started, we recommend tracking just a few important events. You can alway

Once you've added a few `track` calls, **you're done!** You successfully installed Analytics tracking. Now you're ready to turn on any destination you fancy from our interface, margarita in hand.


---


## What's Next?

We just walked through the quickest way to get started with Segment using our Java library. You might also want to check out our full [reference](/docs/connections/sources/catalog/libraries/server/java) 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,6 @@ To get started with Analytics Node.js:

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?

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ Use the Segment Objects API to send business objects relevant to your business r
> warning ""
> Segment hasn't added support for the core `analytics-<language>` libraries so you'll need to use the Segment HTTP API directly or the independent Go(lang) client for now.

### Authentication
## Authentication

Authenticate to the Objects API by sending your project's **Write Key** along with a request.
Authentication uses HTTP Basic Auth, which involves a 'username:password' that is base64 encoded and pre-pended with the string 'Basic '.

In practice that means taking a Segment source **Write Key**,`'abc123'`, as the username, adding a colon, and then the password field is left empty. After base64 encoding `'abc123:'` becomes `'YWJjMTIzOg=='`; and this is passed in the authorization header like so: `'Authorization: Basic YWJjMTIzOg=='`.

### Source type
## Source type

Set up an `HTTP API` source type in Segment. You will use this source write key for authenticating with the Objects API.

### Content-type
## Content-type

In order to send data to Segment's HTTP API, the content-type header must be set to `'application/json'`.

Expand Down Expand Up @@ -156,12 +156,14 @@ POST https://objects.segment.com/v1/set

This call sends a collection of "rooms". "rooms" becomes the table name in your data warehouse, and each individual object in the array becomes a row in that table.

| Field | Type | Description |
|-------------------------|--------|-------------------------------------------------------------------------------------------|
| `collection` *Required* | String | A string that represents the name of the collection. The collection name will become the table name in your data warehouse. Collection must consist of lowercase letters and underscores and maximum of 100 characters. Can not begin or end with an underscore. |
| `objects` | Array | A required array of objects describing the objects and properties being set. Must consist of at least one JSON object and a maximum of 10. |

Each object inside of the objects array must consist of the following parameters:

| Parameter | Type | Description |
|-------------------------|--------|-------------------------------------------------------------------------------------------|
| `id` *Required* | String | The unique ID representing the object in the third party system. Maximum of 100 characters. |
| `Properties` *Required* | Object | The object properties that represent the object. Example: Each value could be a string (ISO dates are parsed and recognized as `isodate` type), an integer, or a float (JSON types). Values cannot be lists or objects. Each value must be less than 32KB in size. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ It differs from the Object API in that it is designed to:
> warning ""
> At this time, Segment hasn't created tooling akin to core analytics-* libraries so you'll need to use Segment's HTTP API directly for now.

### Batched Object Data
## Batched Object Data

The `Batched Object Data` the API accepts is a file of line separated objects, in JSON form, compressed using `Gzip`.
The maximum size of a single `object` is 400KB and maximum uncompressed size of a file 512MB.

Expand All @@ -23,25 +24,26 @@ Example objects:
{"id":"1","collection":"users","properties":{"first_name":"John","last_name":"Smith"}}
{"id":"2","collection":"users","properties":{"first_name":"Jane","last_name":"Doe"}}
```

| Field | Type | Description |
|-------------------------|--------|-------------------------------------------------------------------------------------------|
| **`id`** *Required* | String | The unique ID representing the object in the third party system. <br><br> Maximum of 100 characters. |
| **`collection`** *Required* | String | A string that represents the name of the collection. The collection name will become the table name in your data warehouse. <br><br> Collection must consist of lowercase letters and underscores and maximum of 100 characters. Can not begin or end with an underscore. |
| **`Properties`** *Required* | Object | The object properties that represent the object. <br><br> Example: Each value could be a string (ISO dates are parsed and recognized as `isodate` type), an integer, or a float (JSON types). <br><br> Values cannot be lists or objects. Each value must be less than 32KB in size. |


### Authentication
## Authentication

Authenticate to the Objects Bulk API by sending your project's **Write Key** along with a request.
Authentication uses HTTP Basic Auth, which involves a `username:password` that is base64 encoded and prepended with the string `Basic `.

In practice that means taking a Segment source **Write Key** encoding it with base64. For example, `echo "abc123" | base64 -` becomes `'YWJjMTIzCg=='` and this is passed in the authorization header like so: `'Authorization: Basic YWJjMTIzCg=='`.

### Source type
## Source type

set up an `HTTP API` source type in Segment. You will use this source write key for authenticating with the Objects Bulk API.

### Limits
## Limits

The API imposes some rate limits including:
- **512MB** maximum uncompressed [file](#batched-object-data) upload size
- **400KB** maximum [object](#batched-object-data) size
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,6 @@ Segment::flush();

And presto, **you're done!** You successfully installed PHP tracking. Now you're ready to turn on any destination you fancy from our interface, margarita in hand.

---


## What's Next?

We just walked through the quickest way to get started with Segment using PHP. You might also want to check out our full [PHP reference](/docs/connections/sources/catalog/libraries/server/php) 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.
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,6 @@ To get started, we recommend tracking just a few important events. You can alway

And voila, **you're done!** You've just successfully installed analytics tracking on your servers. Now you're ready to turn on any destination you fancy from our interface, martini in hand.


---


## What's Next?

We just walked through the quickest way to get started with Segment using Python. You might also want to check out our full [Python library reference](/docs/connections/sources/catalog/libraries/server/python/) 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,6 @@ To get started, we recommend tracking just a few important events. You can alway

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.


---


## What's Next?

We just walked through the quickest way to get started with Segment using Ruby. You might also want to check out our full [Ruby library reference](/docs/connections/sources/catalog/libraries/server/ruby) 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,6 @@ To get started, we recommend tracking just a few important events. You can alway

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.


---


## What's Next?

We just walked through the quickest way to get started with Segment using go. You might also want to check out our full [Go library reference](/docs/connections/sources/catalog/libraries/server/rust/) 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Segment makes it simple for Cloudflare customers to integrate analytics, email m

The guide below explains how to install Segment on your Cloudflare-hosted website. All you need to get up and running is to create a Cloudflare source and turn on the Segment app for your website. The following guide will show you how, step by step.

don't have a Segment account? No problem, [sign up here](https://segment.com/signup?utm_source=cloudflare&utm_medium=docs&utm_campaign=partners).
Don't have a Segment account? No problem, [sign up here](https://segment.com/signup?utm_source=cloudflare&utm_medium=docs&utm_campaign=partners).

## Getting Started

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ analytics.trackForm(form, event, [properties])
```

Field | | Type | Description
----- | | ---- | -----------
----- | -- | ---- | -----------
`form(s)` | | Element or Array | The form element to track or an array of form elements or jQuery objects. _Note: trackForm takes an element, not a CSS selector._ Segment recommends that you wait until the DOM loads before passing the form element.
`event` | | String or Function | The name of the event, passed to the `track` method. Or a **function** that returns a string to use as the name of the `track` event.
`properties` | optional | Object or Function | A dictionary of properties to pass with the Track method. Or a **function** that returns an object to use as the `properties` of the event.
Expand Down Expand Up @@ -278,7 +278,7 @@ analytics.group(groupId, [traits], [options], [callback]);
The Group call has the following fields:

Field | | Type | Description
----- | | ---- | -----------
----- | -- | ---- | -----------
`groupId` | | String | The Group ID to associate with the current user.
`traits` | optional | Object | A dictionary of [traits](/docs/connections/spec/group#traits) for the group. Example traits for a group include `address`, `website`, and `employees`.
`options` | optional | Object | A dictionary of options. For example, [enable or disable specific destinations](#managing-data-flow-with-the-integrations-object) for the call. _Note: If you do not pass a `properties` object, pass an empty object (like '{}') before `options`_.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ With the analytics.js Vimeo Plugin you can collect Vimeo player events into the
To use the Vimeo plugin:

1. Generate an access token in Vimeo. The plugin uses this token to access metadata about the playing video content. Vimeo provides documentation to [generate the access token](https://developer.vimeo.com/api/guides/start#generate-access-token).
- **Note:** Make sure to select the access scopes you need as the plugin only needs to read information about your video(s).

- **Note:** Make sure to select the access scopes you need as the plugin only needs to read information about your video(s).

2. Enable a new plugin by navigating to the settings for your Source and clicking **Plugins**. You can enable the Vimeo plugin from this menu:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,16 @@ To begin, create a new project in the Google Developer Console, then create a ne
After you've generated the API key:

1. Enable a new plugin.
- Navigate to **Connections > Sources** and choose the source you want to connect the YouTube plugin to. Go to the **Settings** tab of your source and select **Plugins**. You can enable the YouTube plugin from this menu:

- Navigate to **Connections > Sources** and choose the source you want to connect the YouTube plugin to. Go to the **Settings** tab of your source and select **Plugins**. You can enable the YouTube plugin from this menu:

![the plugins setting screen](./images/youtube-vimeo-plugins-beta-2021-06-04.png)

**Note:** Only JavaScript sources support plugins.

2. Initialize the plugin by giving it access to the YouTube video player instance(s) running on your page. This can be done by adding this script, <script src="https://www.youtube.com/iframe_api"></script> to the section of the source code where the page loads.
- Use the initialize method in the YouTube `onYouTubeIframeAPIReady()` function to register and initialize the plugin with the player instance and your API key:

- Use the initialize method in the YouTube `onYouTubeIframeAPIReady()` function to register and initialize the plugin with the player instance and your API key:

```js
var player;
Expand Down
Loading