Skip to content

Commit 6de3d4c

Browse files
author
markzegarelli
authored
Merge branch 'develop' into airship-doc-sync
2 parents b31852b + f98beb5 commit 6de3d4c

File tree

24 files changed

+481
-313
lines changed

24 files changed

+481
-313
lines changed

.github/workflows/unallowed-contributions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ on:
2222

2323
jobs:
2424
triage:
25-
if: github.repository == 'segmentio/segment-docs' && github.event.pull_request.user.login != 'markzegarelli'
25+
if: github.repository == 'segmentio/segment-docs' && (github.event.pull_request.user.login != 'markzegarelli' || github.event.pull_request.user.login != 'stayseesong' || github.event.pull_request.user.login != 'pwseg')
2626
runs-on: ubuntu-latest
2727
steps:
2828
- name: Get files changed

.vale.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ StylesPath = vale-styles
33
Vocab = Docs
44

55
[*.md]
6-
BasedOnStyles = write-good, segment
6+
BasedOnStyles = segment
77
TokenIgnores = ({% .* %})

src/_data/catalog/destinations.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7818,7 +7818,7 @@ items:
78187818
components:
78197819
- code: https://github.com/segmentio/integrations/tree/master/integrations/hubspot
78207820
type: server
7821-
browserUnbundlingSupported: true
7821+
browserUnbundlingSupported: false
78227822
browserUnbundlingPublic: true
78237823
replay: false
78247824
connection_modes:
@@ -8707,14 +8707,14 @@ items:
87078707
description: Sends pages with names to FullStory as tracking events.
87088708
required: false
87098709
label: Track Named Pages
8710-
- display_name: Fullstory (Actions)
8711-
name: Fullstory (Actions)
8710+
- display_name: FullStory (Actions)
8711+
name: FullStory (Actions)
87128712
slug: actions-fullstory
87138713
hidden: false
87148714
url: connections/destinations/catalog/actions-fullstory
87158715
previous_names:
87168716
- Fullstory
8717-
- Fullstory (Actions)
8717+
- FullStory (Actions)
87188718
website: http://www.fullstory.com
87198719
status: PUBLIC_BETA
87208720
categories:

src/_data/catalog/overrides-list.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@ items:
44
- google-ads-gtag
55
- klaviyo
66
- friendbuy
7+
- google-ads-classic
8+

src/_data/catalog/overrides.yml

Lines changed: 134 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
items:
44
- slug: hubspot
55
display_name: HubSpot
6+
previous_names:
7+
- HubSpot
68
components:
79
- type: WEB
810
- type: CLOUD
@@ -106,4 +108,135 @@ items:
106108
defaultValue: []
107109
description: Map your page calls to specific FriendBuy Widgets.
108110
required: false
109-
label: Page Widgets
111+
label: Page Widgets
112+
- slug: google-ads-classic
113+
display_name: Google Ads (Classic)
114+
name: Google Ads (Classic)
115+
hidden: false
116+
url: connections/destinations/catalog/google-ads-classic
117+
previous_names:
118+
- AdWords
119+
- Google Ads (Classic)
120+
website: https://adwords.google.com
121+
status: PUBLIC
122+
categories:
123+
- Advertising
124+
logo:
125+
url: https://cdn.filepicker.io/api/file/O54PEswFQAC7ZZDLSBZ5
126+
mark:
127+
url: https://cdn.filepicker.io/api/file/R5kQQ2DMR0CuNdDbzPvr
128+
methods:
129+
track: true
130+
identify: false
131+
group: false
132+
alias: false
133+
page: true
134+
platforms:
135+
browser: true
136+
mobile: true
137+
server: true
138+
components:
139+
- code: https://github.com/segment-integrations/analytics.js-integration-adwords
140+
type: browser
141+
- code: >-
142+
https://github.com/segmentio/integrations/tree/master/integrations/google-adwords
143+
type: server
144+
browserUnbundlingSupported: false
145+
browserUnbundlingPublic: true
146+
replay: false
147+
connection_modes:
148+
device:
149+
web: true
150+
mobile: false
151+
server: false
152+
cloud:
153+
web: false
154+
mobile: true
155+
server: false
156+
summary: >-
157+
accepts data in cloud-mode from all mobile sources, and can accept data in
158+
device-mode from Analytics.js sources.
159+
cmode_type: mixed
160+
case: '9'
161+
settings:
162+
- name: conversionId
163+
type: string
164+
defaultValue: ''
165+
description: >-
166+
Your AdWords conversion identifier. It looks like `983265867`. You can opt
167+
to override this on a per-event basis but at the very least this
168+
conversion ID will serve as the ID used in page calls.
169+
required: true
170+
label: Conversion ID
171+
- name: correctLat
172+
type: boolean
173+
defaultValue: true
174+
description: >-
175+
Enable this to set Limit Ad Tracking to `true` when
176+
context.device.adTrackingEnabled is `false`.
177+
required: true
178+
label: Correct LAT Behavior
179+
- name: eventMappings
180+
type: mixed
181+
defaultValue: []
182+
description: AdWords behavior for each of your Segment Events is defined here.
183+
required: true
184+
label: Event Mappings
185+
- name: linkId
186+
type: string
187+
defaultValue: ''
188+
description: >-
189+
The AdWords Link Id associated with Segment. The process for obtaining
190+
this can be found
191+
[here](https://support.google.com/adwords/answer/7365001). To create this
192+
Link Id, you must input Segment's Provider Id: **7552494388**
193+
194+
195+
**Important:** this setting is required only if you are using the new
196+
AdWords for mobile implementations.
197+
required: true
198+
label: Link Id
199+
- name: pageRemarketing
200+
type: boolean
201+
defaultValue: false
202+
description: Enable this to send a remarketing tag with your page calls
203+
required: true
204+
label: Page Remarketing
205+
- name: trackAttributionData
206+
type: boolean
207+
defaultValue: false
208+
description: >-
209+
If this setting is enabled, Segment will send successfully attributed
210+
`Application Installed` events from AdWords as `Install Attributed` events
211+
back into this source. These events will contain data about the AdWords
212+
campaign that lead to the conversion. You can learn more about these
213+
events [here](https://segment.com/docs/spec/mobile/#install-attributed).
214+
215+
216+
**Important:** this feature is only available if you are using the new
217+
AdWords version.
218+
required: true
219+
label: Track Attribution Data
220+
- name: version
221+
type: select
222+
defaultValue: ''
223+
description: >-
224+
The current version of your AdWords account. If you have migrated your
225+
AdWords account to the **new** AdWords interface at any point, you are
226+
using version 2. Otherwise, please select version 1.
227+
required: true
228+
label: Version
229+
- name: zeroedAttribution
230+
type: boolean
231+
defaultValue: false
232+
description: >-
233+
With the update to use analytics-ios v4.x SDK if adTrackingEnabled is set
234+
to false, the advertisingId key will be deleted from the event. These
235+
events will fail when sent to Google Adwords. To prevent these event
236+
failures in this scenario enable this setting to set the IDFA to be zero'd
237+
out (ie. '00000000-0000-0000-0000-000000000000') when sent to Google
238+
Adwords.
239+
required: false
240+
label: >-
241+
Fallback to Zeroed IDFA when advertisingId key not present (Server-Side
242+
Only)

src/_data/sidenav/strat.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,9 @@ sections:
7171
section:
7272
- path: /connections/destinations/catalog/salesforce
7373
title: Salesforce destination
74-
- path: /connections/destinations/catalog/salesforce-live-agent
75-
title: Salesforce Live Agent destination
74+
# This is in Private Beta
75+
# - path: /connections/destinations/catalog/salesforce-live-agent
76+
# title: Salesforce Live Agent destination
7677
- path: /connections/destinations/catalog/salesforce-marketing-cloud
7778
title: Salesforce Marketing Cloud destination
7879
- path: /connections/destinations/catalog/salesforce-dmp

src/connections/destinations/actions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Each Actions-framework Destination you see in the Segment catalog represents a f
2020
- [Braze (Actions) Web](/docs/connections/destinations/catalog/actions-braze-web)
2121
- [Braze (Actions) Cloud](/docs/connections/destinations/catalog/actions-braze-cloud)
2222
- [Slack (Actions)](/docs/connections/destinations/catalog/actions-slack)
23-
- [Fullstory (Actions)](/docs/connections/destinations/catalog/actions-fullstory)
23+
- [FullStory (Actions)](/docs/connections/destinations/catalog/actions-fullstory)
24+
- [Customer.io (Actions)](/docs/connections/destinations/catalog/actions-customer-io)
2425

2526
## Destination Actions compatibility
2627

src/connections/destinations/catalog/actions-customer-io/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Customer.io (Actions) Destination
33
hide-personas-partial: true
44
hide-boilerplate: true
55
hide-dossier: true
6-
hidden: true
7-
published: false
86
---
97
{% include content/plan-grid.md name="actions" %}
108

src/connections/destinations/catalog/actions-fullstory/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Fullstory (Actions)
2+
title: FullStory (Actions)
33
hide-boilerplate: true
44
hide-dossier: true
55
---

src/connections/destinations/catalog/facebook-pixel-server-side/index.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,7 @@ This approach provides a redundancy that ensures maximum signal reliability. Eve
7676

7777
#### Match rate considerations
7878

79-
For this option to work best, you must pass the same `external_id` from both the browser and the server sources.
80-
To do this, go to your Facebook Pixel destination settings in Segment, and enable **Use UserId or Anonymous Id as External Id**. By default the Facebook Conversions API destination uses the `userId` (or `anonymousId` if not present) to set the External Id, so when you set up Facebook Pixel to use the same settings, Facebook can then match the users.
79+
For this option to work best, pass the same `external_id` from the browser and the server. To achieve this, go to the Facebook Pixel destination settings in Segment and enable the **Enable Advanced Matching** and **Use User ID or Anonymous ID as External ID** settings. By default, the Facebook Conversions API destination uses the `userId` (or `anonymousId` if not present) to set the `external_id`, so when you configure Facebook Pixel to use the same settings, Facebook matches users by those IDs.
8180

8281
You can also increase the match rate for events from a server source by sending [user traits in the context object of the track events](#default-mappings-to-facebook-properties). You can also collect other fields from the browser, such as `userAgent`, `ip` address, and [Facebook's parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc) and pass them to the server, and manually add them to the events.
8382

@@ -91,9 +90,9 @@ Use this approach if you want to separate tracking events completed on a user's
9190

9291
#### Match rate considerations
9392

94-
For this option to work best, the same `external_id` needs to be passed from the browser and from the server. To easily achieve this go to your Segment destination settings for Facebook Pixel and toggle on the setting called **Use UserId or Anonymous Id as External Id**. The Facebook Conversions API destination uses the userId (or anonymousId if not present) to set the External Id by default. Therefore enabling this on Facebook Pixel will allow Facebook to match the users.
93+
For this option to work best, the same `external_id` needs to be passed from the browser and the server. To achieve this, go to your Facebook Pixel destination settings in Segment and enable the **Enable Advanced Matching** and **Use User ID or Anonymous ID as External ID** settings. By default the Facebook Conversions API destination uses the `userId` (or `anonymousId` if not present) to set the `external_id`, so when you set up Facebook Pixel to use the same settings, Facebook can then match the users.
9594

96-
You can also increase the match rate for events from a server source by sending [user traits in the context object of the track events](#default-mappings-to-facebook-properties). You can also collect other fields from the browser, such as `userAgent`, `ip` address, and [Facebook's parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc) and pass them to the server, and manually add them to the events.
95+
You can also send [user traits in the context object of the track events](#default-mappings-to-facebook-properties)to increase the match rate for events from a server source. Collect other fields from the browser, like `userAgent`, `ip` address, and [Facebook's parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and manually add them to the events.
9796

9897
#### Deduplication considerations
9998

@@ -124,7 +123,7 @@ For more information about Track calls, see the [Track method](/docs/connections
124123

125124
Beginning February 15th 2021, Facebook requires the `action_source` server event parameter for all events sent to the Conversions API. This parameter is used to specify where the conversions occurred. If `action_source` is set to 'website' then the `client_user_agent` and the `event_source_url` parameters are also required. Events sent to the Conversions API after February 15th that do not meet the requirements may not be available for optimization, targeting, or measurement.
126125

127-
| Server Event Parameter | Requirement | Implementation |
126+
| Server Event Parameter | Requirement | Implementation p |
128127
| ---------------------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
129128
| `action_source` | Always required | It is set automatically but it can be set manually. |
130129
| `client_user_agent` | Only required if `action_source` = "website" | It must be set manually if using a server library. It is set automatically if using the Segment web library. |
@@ -139,7 +138,7 @@ You can set `action_source` manually by passing it as a property of a Track even
139138

140139
| Action Source Values | Description |
141140
| -------------------- | --------------------------------------------------------------------------------------------------------- |
142-
| `chat` | Conversion was made via a messaging app, SMS, or online messaging feature. |
141+
| `chat` | Conversion was made through a messaging app, SMS, or online messaging feature. |
143142
| `email` | Conversion happened over email. |
144143
| `other` | Conversion happened in a way that is not listed. |
145144
| `phone_call` | Conversion was made over the phone. |
@@ -265,18 +264,18 @@ analytics.track("Clicked Email", {
265264
```
266265

267266
### Custom Mappings to Facebook Properties
268-
Any properties you send that aren't listed above are sent in the 'Custom Data' part of the Segment payload to Facebook.
267+
Any properties you send that aren't listed above are sent in the `custom_data` part of the Segment payload to Facebook.
269268

270269
### Alternative External IDs
271270

272-
By default, Segment sends the `userID` as `externalID`, and if `userID` is absent falls back to `anonymousID`. To use a different field in your payload as the External ID, use the "Alternative External ID Field". An example value for this setting would be `properties.externalId`.
271+
By default, Segment sends the `userId` as `external_id`, and if `userId` is absent falls back to `anonymousId`. To use a different field in your payload as the `external_id`, use the **Alternative External ID Field** setting. An example value for this setting would be `properties.externalId`.
273272

274-
### Alternative "Value" Properties
273+
### Alternative Value Properties
275274

276275
For most events Segment sends revenue for the Pixel value field, but for
277-
the pre-purchase events "Product Viewed" and "Product Added", Segment
278-
uses the value of the "Value Field Identifier" setting to determine which
279-
property to use for the "value" field. This field defaults to
276+
the pre-purchase events `Product Viewed` and `Product Added`, Segment
277+
uses the value of the **Value Field Identifier** setting to determine which
278+
property to use for the `value` field. This field defaults to
280279
`price`.
281280

282281
## Limited Data Use
@@ -313,7 +312,7 @@ minutes. You can confirm that Facebook received them:
313312

314313
1. Go to the Events Manager.
315314
2. Click on the corresponding pixel.
316-
3. In the **Overview** tab, look for events where the "Connection Mode" is `Server`.
315+
3. In the **Overview** tab, look for events where the "Connection Method" is `Server`.
317316

318317
> info ""
319318
> **Note**: It might take a few minutes before events appear in the Events Manager.

0 commit comments

Comments
 (0)