Skip to content

Commit 16c9537

Browse files
committed
Merge remote-tracking branch 'upstream/develop' into DOCSPLAT-2993
2 parents bf4376e + f02239b commit 16c9537

File tree

11 files changed

+90
-162
lines changed

11 files changed

+90
-162
lines changed

src/_data/catalog/kotlin_resources.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ items:
1616
categories:
1717
- app
1818
- name: Android AdvertisingId Plugin
19-
url: https://github.com/segmentio/analytics-kotlin/blob/main/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins/AndroidAdvertisingIdPlugin.kt
19+
url: https://github.com/segmentio/analytics-kotlin/blob/1ef79eaf035549d08f91bac4e0a1de8ca6793e7b/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins/AndroidAdvertisingIdPlugin.kt
2020
categories:
2121
- plugin
2222
- name: Screen Recording Plugin

src/connections/destinations/catalog/actions-first-party-dv360/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ redirect_from: /connections/destinations/catalog/first-party-dv360/
99

1010
Google’s [Display & Video (DV360)](https://marketingplatform.google.com/about/display-video-360/){:target="_blank"} is an end-to-end campaign management tool that enables enterprise customers to plan, measure, and run display and video advertisements. Segment’s integration with DV360 enables Segment customers to sync audiences created in Engage with DV360 for centralized audience management and improved retargeting.
1111

12-
This destination is different from the existing DV360 Actions as it allows you to upload [contact info](https://developers.google.com/display-video/api/reference/rest/v3/firstAndThirdPartyAudiences#ContactInfo){:target="_blank"} and the [mobile device ID](https://developers.google.com/display-video/api/reference/rest/v3/firstAndThirdPartyAudiences#mobiledeviceidlist){:target="_blank"}.
12+
This destination is different from the existing DV360 Actions as it allows you to upload [contact info](https://developers.google.com/display-video/api/reference/rest/v4/firstPartyAndPartnerAudiences#contactinfo){:target="_blank"} and the [mobile device ID](https://developers.google.com/display-video/api/reference/rest/v4/firstPartyAndPartnerAudiences#mobiledeviceidlist){:target="_blank"}.
1313

1414
This destination can only be used with Engage.
1515

@@ -68,12 +68,15 @@ Segment automatically sends consent as `TRUE` for this destination. Segment use
6868

6969
## Data requirements
7070
Based on Google’s documentation, make sure you send the correct required identifiers:
71-
* [Contact info list requirements](https://developers.google.com/display-video/api/reference/rest/v3/firstAndThirdPartyAudiences#contactinfo){:target="_blank"}
71+
* [Contact info list requirements](https://developers.google.com/display-video/api/reference/rest/v4/firstPartyAndPartnerAudiences#contactinfo){:target="_blank"}
7272
* For example, you must send first name, last name, ZIP code, and country code all together and not just one. Make sure all phone numbers are in [E.164 format](https://en.wikipedia.org/wiki/E.164){:target="_blank"}.
73-
* [Mobile ID Requirements](https://developers.google.com/display-video/api/reference/rest/v3/firstAndThirdPartyAudiences#mobiledeviceidlist){:target="_blank"}
73+
* [Mobile ID Requirements](https://developers.google.com/display-video/api/reference/rest/v4/firstPartyAndPartnerAudiences#mobiledeviceidlist){:target="_blank"}
7474

7575

7676
## FAQs
7777

7878
#### When will my data appear in DV360?
7979
When you complete the connection between Segment and DV360, it can take from 24 to 48 hours for Google to create the user list. This must complete before Segment can begin to sync users into that list.
80+
81+
#### What is membershipDurationDays and its limit?
82+
The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540.

src/connections/destinations/catalog/ibm-ubx/index.md

Lines changed: 45 additions & 114 deletions
Large diffs are not rendered by default.

src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: SendGrid Marketing Campaigns Source
33
id: GCeG0vmcDW
44
---
55

6-
[SendGrid Marketing Campaigns](http://twilio.com/docs/sendgrid/ui/integrations/segment?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} lets you automatically stream your email events directly into Segment for use inside your warehouse or other downstream destinations.
6+
[SendGrid Marketing Campaigns](https://twilio.com/docs/sendgrid/ui/integrations/segment?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} lets you automatically stream your email events directly into Segment for use inside your warehouse or other downstream destinations.
77

88
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) that can not only export data into your Segment warehouse but also federate the exported data into your other enabled Segment destinations.
99

src/connections/sources/catalog/cloud-apps/vero/index.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,36 @@ id: FOkpxVzfJJ
44
---
55
{% include content/source-region-unsupported.md %}
66

7-
Vero is an email marketing tool that lets you set up automated emails to your users that get sent after they've completed certain actions. [Visit Website](http://getvero.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”}
7+
[Vero](http://getvero.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is an email marketing tool that lets you set up automated emails to your users that get sent after they've completed certain actions.
88

9-
Take your company's email analysis to the next level by **adding Vero as a Source to Segment.** Segment automatically collects email events like `Email Delivered` and `Email Opened`, forward them to your destinations, and load them into your data warehouse. 
9+
Take your company's email analysis to the next level by **adding Vero as a source to Segment**. Segment automatically collects email events like `Email Delivered` and `Email Opened`, forwards them to your destinations, and loads them into your data warehouse. 
1010

11-
In your favorite BI or analytics tool, you'll be able to analyze your email campaigns in SQL or through drag-and-drop reports. And, you'll be able to join your Vero data with the event data you're already sending through Segment to analyze the down-funnel effects of your emails. 
11+
In a BI or analytics tool, you can analyze your email campaigns in SQL or through drag-and-drop reports. You're also able to join your Vero data with the event data that you're already sending through Segment to analyze the down-funnel effects of your emails. 
1212

13-
## Getting Started
13+
## Getting started
1414

15-
If you have previously enabled sending email events using the Vero destination during our beta (using a project write key), you do not need to create new Vero source. Your email data will continue to flow as normal.
15+
If you have previously enabled sending email events using the Vero destination during beta (using a project write key), you do not need to create new Vero source. Your email data will continue to flow as normal.
1616

17-
1. From your workspace's `segment.com/<your-workspace>/sources page`, click `Add source`.
17+
1. From your Segment workspace, go to **Connections > Catalog**, search for "Vero" and click **Add Source**.
18+
2. Give the source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name autopopulates the schema name. For example, the source name `Vero` creates the schema `vero`.
19+
3. In the **Overview** page, find your **Segment write key** for Vero and copy it.
20+
4. To finish the setup, go to your Vero account, navigate to **[Integrations](https://app.getvero.com/settings/integrations?integrations=all){:target="_blank”} > Segment** and enter this Segment write key.
21+
5. Click **Save**.
22+
6. In Segment, click into your Vero source. Here, you can add destinations where you want to see email events.
1823

19-
2. Choose Vero.
20-
21-
3. Give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name autopopulates the schema name. For example, the source name `Vero` creates the schema `vero`.
22-
23-
4. The next page ("Overview") will surface your **Segment write key for Vero.** Copy this write key. 
24-
25-
5. To finish the setup, you'll have to go into your Vero account and enter this Segment write key in their integrations settings. Find the right place in Vero by clicking [Integrations](https://app.getvero.com/settings/integrations?integrations=all){:target="_blank”} > Segment.
26-
27-
6. Click **Save**.
28-
29-
7. In Segment, click into your Vero Source in `segment.com/<your-workspace>/sources`. From there you'll be able to add Destinations where you want to see email events.
30-
31-
That's it! As you send emails, events will now be sent to your destinations and automatically loaded into any warehouses you have enabled. 
24+
As you send emails, events are sent to your destinations and automatically loaded into any warehouses you have enabled. 
3225

3326
## Components
3427

3528
**Stream**
3629

37-
Vero uses our stream Source component to send Segment email events. It uses a server-side `track` method to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. 
30+
Vero uses Segment's stream source component to send Segment email events. It uses a server-side `track` method to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. 
3831

3932
The default behavior is for Vero to pass the `userId` associated with the email recipient as the `userId`. There are cases in which Vero does not have an associated `userId`, in which case the email address will be passed in as the `anonymousId`
4033

4134
## Collections
4235

43-
Collections are the groupings of data we pull from your Source. In your warehouse, each collection gets its own table, as well as a `tracks` table that aggregates all the events into a single table. 
36+
Collections are the groupings of data pulled from your Source. In your warehouse, each collection gets its own table, as well as a `tracks` table that aggregates all the events into a single table. 
4437

4538
<table>
4639
<tr>
@@ -98,4 +91,4 @@ from activecampaign.email_delivered
9891

9992
## Send data to Vero
10093

101-
The Vero Source works better when you also connect Vero as a destination. With the Vero **Destination**, you can use Segment to send Vero user and event data from which you trigger email campaigns. Want to start sending website or mobile data to Vero? Head on over to our [Vero destination docs](/docs/connections/destinations/catalog/vero/).
94+
The Vero source works best when you also connect Vero as a destination. With the Vero destination, you can use Segment to send Vero user and event data from which you trigger email campaigns. To start sending website or mobile data to Vero, see the [Vero destination docs](/docs/connections/destinations/catalog/vero/).

src/connections/sources/catalog/libraries/mobile/apple/swift-samples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ strat: swift
44
---
55

66
## Samples
7-
The code samples below demonstrate the implementation of common use cases of the Analytics Swift library across different platforms.
7+
The following code samples show how to implement common use cases of the Analytics Swift library across different platforms.
88

99
### Sample applications
1010
{% assign resources = site.data.catalog.swift_resources.items | where: "categories", "app" %}

src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-samples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ strat: swift
44
---
55

66
## Samples
7-
The code samples below demonstrate the implementation of common use cases of the Analytics Kotlin library across different platforms.
7+
The following code samples show how to implement common use cases of the Analytics Kotlin library across different platforms.
88

99
### Sample applications
1010
{% assign resources = site.data.catalog.kotlin_resources.items | where: "categories", "app" %}
@@ -18,4 +18,4 @@ The code samples below demonstrate the implementation of common use cases of the
1818
{: .columns}
1919
{% for resource in resources %}
2020
- [{{resource.name}}]({{resource.url}}){:target="_blank"}
21-
{%endfor%}
21+
{%endfor%}

src/connections/sources/catalog/libraries/website/plugins/youtube/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ After you've generated the API key:
2828

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

31-
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.
31+
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 the following script to the section of the source code where the page loads.
3232

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

src/connections/spec/ecommerce/index.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ title: 'Spec: V1 Ecommerce Events'
33
hidden: true
44
---
55

6-
This guide maps out the standard data Segment expects to see from ecommerce companies. The semantic events detailed below represent the ideal for ecommerce events; not every ecommerce store will take advantage of every event or all of their properties.
6+
This guide maps out the standard data Segment expects to see from ecommerce companies. The semantic events detailed represent the ideal for ecommerce events; not every ecommerce store takes advantage of every event or all of their properties.
77

88
## V2
99

1010
Segment now supports a fully **backwards compatible** V2 of the Ecommerce Spec. You can still use V1, but Segment recommends upgrading to V2 as it includes many more spec'd ecommerce events.
1111

1212
For more information about the V2 spec, refer to the [Ecommerce V2 docs](/docs/connections/spec/ecommerce/v2/).
1313

14-
## V1 Overview
14+
## V1 overview
1515

16-
One of the core components of the Segment [Spec](/docs/connections/spec/) is the [Track](/docs/connections/spec/track) method. It records any arbitrary event that the user has triggered. For Ecommerce tracking, you will be sending **specific event names** that Segment recognizes semantically. That way the Segment app can transform them before sending them off to each different tool.
16+
One of the core components of the Segment [Spec](/docs/connections/spec/) is the [Track](/docs/connections/spec/track) method. It records any arbitrary event that the user has triggered. For Ecommerce tracking, you send **specific event names** that Segment recognizes semantically. That way the Segment app can transform them before sending them off to each different tool.
1717

18-
The `properties` listed in the sections below are **required** for some destinations to function. You can always add your own custom properties (product color, size, etc.) in addition to the required ones.
18+
The `properties` listed in the following sections are **required** for some destinations to function. You can always add your own custom properties (for example, product color, size) in addition to the required ones.
1919

2020

2121
## Events
@@ -38,11 +38,11 @@ The ecommerce category includes the following semantic events:
3838
- [Google Analytics Enhanced Ecommerce](#google-analytics-enhanced-ecommerce)
3939

4040

41-
## Viewed Product Category
41+
## Viewed product category
4242

43-
Category pages are a staple of Ecommerce. They let the user browse all of the products in a specific category. You'll want to track all of your product category pages so you can quickly see which categories are most popular.
43+
Category pages are a staple of Ecommerce. They let the user browse all of the products in a specific category. You can track all of your product category pages so you can quickly see which categories are most popular.
4444

45-
To do that, you'll want to record a specially recognized event called `Viewed Product Category` using a `track call`. This event fires when a visitor views a product category. That view might happen on a page, screen, or modal.
45+
To do that, yrecord a specially recognized event called `Viewed Product Category` using a Track call. This event fires when a visitor views a product category. That view might happen on a page, screen, or modal.
4646

4747
### Properties
4848

@@ -76,9 +76,9 @@ Property | Type | Description
7676
```
7777

7878

79-
## Viewed Product
79+
## Viewed product
8080

81-
The second special event to record for an Ecommerce installation is 'Viewed Product'. To record that you'll use a Track call. This event fires when a visitor views a product. That view might happen on a page, screen, or preview modal.
81+
The second special event to record for an Ecommerce installation is 'Viewed Product'. To record that, use a Track call. This event fires when a visitor views a product. That view might happen on a page, screen, or preview modal.
8282

8383
Note that the properties are required to tell individual tools, like Google Analytics, about the specific product that was viewed. You can always add your own custom properties as well.
8484

@@ -94,7 +94,8 @@ Property | Type | Description
9494
`price` | Number | The price ($) of the product being viewed.
9595
`category` | String | The product category being viewed.
9696

97-
_Note: The `sku` and `id` do not have to be different. If they are different, typically the `id` is a database identifier, like `9714107479` and the `sku` is a public-facing identifier like `SEG-02`._
97+
> info ""
98+
> The `sku` and `id` do not have to be different. If they are different, typically the `id` is a database identifier, like `9714107479` and the `sku` is a public-facing identifier like `SEG-02`.
9899
99100
### Example
100101

@@ -131,7 +132,7 @@ _Note: The `sku` and `id` do not have to be different. If they are different, ty
131132

132133
Next up are two events that are critical to figuring out how your customers are interacting with your products: 'Added Product' and 'Removed Product'. Fire the `Added Product` event when a visitor adds a product to their shopping cart and the `Removed Product` event when a visitor removes a product from their shopping cart.
133134

134-
The properties to record for each of these are the same as the ones for the'Viewed Product' event above (of course you can always add more properties of your own too!).
135+
The properties to record for each of these are the same as the ones for the' Viewed Product' event (you can always add more properties of your own).
135136

136137
### Properties
137138

@@ -209,9 +210,9 @@ Property | Type | Description
209210
```
210211

211212

212-
## Completing an Order
213+
## Completing an order
213214

214-
The final step is to record a `Order Completed` event when people complete your checkout process. It's the most important event to record, since you'll use it for A/B tests, sales dashboards, conversion pixels and pretty much everything you can think of.
215+
The final step is to record a `Order Completed` event when people complete your checkout process. It's the most important event to record, since you use it for A/B tests, sales dashboards, conversion pixels and more.
215216

216217
Be sure to **include all items in the cart as event properties**, with the same properties from the previous calls, like so:
217218

@@ -277,8 +278,8 @@ Be sure to **include all items in the cart as event properties**, with the same
277278
}
278279
```
279280

280-
**Note**: Some destinations require `total` in place of `revenue`. Specific requirements will be outlined in each destination's documentation.
281+
**Note**: Some destinations require `total` in place of `revenue`. Specific requirements are outlined in each destination's documentation.
281282

282-
## Google Analytics Enhanced Ecommerce
283+
## Google Analytics enhanced ecommerce
283284

284285
If you're using Google Analytics enhanced ecommerce, there are some special events you might also want to add. Details are in Segment's [Google Analytics docs](/docs/connections/destinations/catalog/google-analytics/#enabling-enhanced-e-commerce-tracking).

0 commit comments

Comments
 (0)