Skip to content

Commit 350d4cf

Browse files
authored
Merge pull request #404 from segmentio/repo-sync
repo sync
2 parents eebde0a + 3374706 commit 350d4cf

File tree

12 files changed

+52
-51
lines changed

12 files changed

+52
-51
lines changed

scripts/catalog_papi.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,8 @@ const updateSources = async () => {
180180
const hiddenSources = [
181181
'amp',
182182
'factual-engine',
183-
'twilio-event-streams-beta'
183+
'twilio-event-streams-beta',
184+
'ibm-watson-assistant'
184185
]
185186

186187
const regionalSourceEndpoint = regionalSupport.sources.endpoint

src/_data/catalog/sources.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ items:
535535
isCloudEventSource: false
536536
slug: ibm-watson-assistant
537537
url: connections/sources/catalog/cloud-apps/ibm-watson-assistant
538-
hidden: false
538+
hidden: true
539539
regions:
540540
- us
541541
endpoints:

src/_includes/components/actions-fields.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
{% for action in actions %}
9595
### {{action.name}}
9696
<p>{{action.description | markdownify}}</p>
97-
<p>{{action.name}} is a <strong>{{action.platform | capitalize}}</strong> action.</p>
97+
<p>{{action.name}} is a <strong>{{action.platform | capitalize}}</strong> action. The default Trigger is:</p> <code>{{action.defaultTrigger}}</code>
9898

9999

100100
{% if action.fields.size > 0 %}

src/connections/destinations/actions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Destination Actions
66

77
The Destination Actions framework improves on classic destinations by enabling you to see and control how Segment sends the event data it receives from your sources, to actions-based destinations. Each Action in a destination lists the event data it requires, and the event data that is optional.
88

9-
You can also choose which event types, event names, or event property values trigger an Action. These triggers and mappings make it possible to send different versions of the Action, depending on the context from which it is triggered.
9+
You can also choose which event types, event names, or event property values trigger an Action. These Triggers and mappings make it possible to send different versions of the Action, depending on the context from which it is triggered.
1010

1111
Each Actions-framework Destination you see in the Segment catalog represents a feature or capability of the destination which can consume data from your Segment source. The Action clearly lists which data from the events it requires, and which data is optional. For example, Amplitude requires that you always send a `LogEvent` , or Slack always requires a `PostMessage`. Each Action also includes a default mapping which you can modify.
1212

@@ -41,8 +41,8 @@ A Destination Action contains a hierarchy of components, that work together to e
4141
| Component | Description |
4242
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4343
| Global Settings | Define authentication and connection-related information like API and Secret keys. |
44-
| Mappings | Handle the individual calls to the destination. In them, you define what type of call you want to make to the destination, and what triggers that call. Individual Destination Actions may come enabled with some predefined mappings to handle common events like Screen calls, Identify calls, and Track calls. Mappings have two components that make this possible: **Triggers** and an **Action**. |
45-
| Triggers | Enable you to define *when* the corresponding Action fires. As part of a Trigger, you can use condition-based filters to narrow the scope of the trigger. <br /> <br /> Self-service users can add a maximum of two conditions per trigger. |
44+
| Mappings | Handle the individual calls to the destination. In them, you define what type of call you want to make to the destination, and what Triggers that call. Individual Destination Actions may come enabled with some predefined mappings to handle common events like Screen calls, Identify calls, and Track calls. Mappings have two components that make this possible: **Triggers** and an **Action**. |
45+
| Triggers | Enable you to define *when* the corresponding Action fires. As part of a Trigger, you can use condition-based filters to narrow the scope of the Trigger. <br /> <br /> Self-service users can add a maximum of two conditions per Trigger. |
4646
| Actions | Determine the information sent to the destination. In the Configure action section, you map the fields that come from your source, to fields that the destination expects to find. Fields on the destination side depend on the type of action selected. |
4747

4848
For example, in the Amplitude (Actions) destination, you define your API and Secret keys in the destination's global settings. Then, the provided Page Calls mapping:
@@ -108,7 +108,7 @@ If necessary, click **New Mapping** to create a new, blank action.
108108

109109
1. In the edit panel, define the [conditions](#conditions) under which the action should run.
110110
2. Test those conditions to make sure that they correctly match an expected event.
111-
This step looks for events that match the criteria in the [debugger queue](/docs/connections/sources/debugger/), so you might need to trigger some events with the expected criteria to test your conditions. You can skip the test step if needed, and re-try it at any time.
111+
This step looks for events that match the criteria in the [debugger queue](/docs/connections/sources/debugger/), so you might need to Trigger some events with the expected criteria to test your conditions. You can skip the test step if needed, and re-try it at any time.
112112
3. Next, set up the data mapping from the Segment format to the destination tool format.
113113
4. Test the mapping with data from a sample event.
114114
The edit panel shows you the mapping output in the format for the destination tool. You can change your mapping as needed and re-test.
@@ -121,7 +121,7 @@ If necessary, click **New Mapping** to create a new, blank action.
121121
### Conditions
122122

123123
> info ""
124-
> Self-service users can add a maximum of two conditions per trigger.
124+
> Self-service users can add a maximum of two conditions per Trigger.
125125
126126

127127
The following type filters and operators are available to help you build conditions:
@@ -138,4 +138,4 @@ You can combine criteria in a single group using **ALL** or **ANY**. Use an ANY
138138
> - You need to remove properties from the data sent to the destination
139139
> - You need to filter data from multiple types of call (for example, Track, Page, and Identify calls)
140140
>
141-
> If your use case does not match these criteria, you might benefit from using Mapping-level triggers to match only certain events.
141+
> If your use case does not match these criteria, you might benefit from using Mapping-level Triggers to match only certain events.

src/connections/destinations/catalog/actions-google-analytics-4/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ Segment recommends using the prebuilt mappings when possible, however the Segmen
6565
In addition to recommended events, you can also send custom events using the [Custom Event action](/docs/connections/destinations/catalog/actions-google-analytics-4/#custom-event). Custom events are events that you name. Custom events don't appear in most standard reports; you need to set up custom reports for meaningful analysis. To create custom events in the Google Analytics 4 web interface, see Google’s [Modify and create events through the user interface](https://support.google.com/analytics/answer/10085872){:target='_blank'}.
6666

6767
> info "Event naming limitations"
68-
> Google Analytics 4 requires that all event names contain only alpha-numeric characters and underscores, and must start with an alphabetic character. Segment replaces spaces in Event Names with an underscore, so that these events are accepted by GA4. For example, Segment renames an event named `Home Profile` to `Home_Profile`. In some cases, GA4 may reject an event outright, due to unsupported characters. For example, an event named `Home | Profile` will be silently rejected due to the pipe character.
68+
> Google Analytics 4 requires that all event names contain only alpha-numeric characters and underscores, must start with an alphabetic character, and support a maximum of 40 characters. Segment replaces spaces in Event Names with an underscore, so that these events are accepted by GA4. For example, Segment renames an event named `Home Profile` to `Home_Profile`. In some cases, GA4 may reject an event outright, due to unsupported characters. For example, an event named `Home | Profile` will be silently rejected due to the pipe character.
6969
70-
In all cases, event names in GA4 are case sensitive. The Custom Event action includes a **Lowercase Event Name** option, to ensure consistency of all events sent to Google. For more information, see Google's articles [Google Analytics 4 event name rules](https://support.google.com/analytics/answer/10085872?hl=en&ref_topic=9756175#event-name-rules){:target='_blank'} and [Event name limitations](https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events?client_type=firebase){:target="_blank"}.
70+
In all cases, event names in GA4 are case sensitive and require values in all properties. The Custom Event action includes a **Lowercase Event Name** option, to ensure consistency of all events sent to Google. For more information, see Google's articles [Google Analytics 4 event name rules](https://support.google.com/analytics/answer/10085872?hl=en&ref_topic=9756175#event-name-rules){:target='_blank'} and [Event name limitations](https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events?client_type=firebase){:target="_blank"}.
7171

7272
#### Custom Dimensions and Metrics
7373
With Google Analytics 4, you must create custom dimensions and metrics within the Google Analytics 4 interface and link parameters to the corresponding dimension or metric. When you create the dimension or metric, you can either select a parameter from the list of already collected fields or enter the name of the parameter you plan to collect in the future. Custom dimensions can be either event-scoped or user-scoped, and custom metrics must be event-scoped.

src/connections/destinations/catalog/byteplus/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This destination is maintained by BytePlus. For any issues with the destination,
2020
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2121
2. Search for "BytePlus" in the Destinations Catalog, and select the "BytePlus" destination.
2222
3. Choose which Source should send data to the "BytePlus" destination.
23-
4. In BytePlus, go to your "[Organization Settings](https://docs.byteplus.com/data-intelligence/docs/create-your-organizations-and-projects)" > "Project List" and find the targeted project.
23+
4. In BytePlus, go to Organization Settings > Project List and find the targeted project.
2424
5. Click on **Details** for the targeted project and find the API key ("App Key") on the pop-out information page. This should be a 32-character string of numbers and letters.
2525
6. Enter the "API Key" in the "BytePlus" destination settings in Segment.
2626

src/connections/destinations/catalog/datarangers/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ This destination is maintained by BytePlus. For any issues with the destination,
1818
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
1919
2. Search for "BytePlus" in the Destinations Catalog, and select the "BytePlus" destination.
2020
3. Choose which Source should send data to the "BytePlus" destination.
21-
4. In BytePlus, go to your "[Organization Settings](https://docs.byteplus.com/data-intelligence/docs/create-your-organizations-and-projects)" > "Project List" and find the targeted project.
21+
4. In BytePlus, go to Organization Settings > Project List and find the targeted project.
2222
5. Click on **Details** for the targeted project and find the API key ("App Key") on the pop-out information page. This should be a 32-character string of numbers and letters.
2323
6. Enter the "API Key" in the "BytePlus" destination settings in Segment.
2424

2525

2626
## Page
2727

28-
If you aren't familiar with the Segment Spec, take a look at the Page method documentation (https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like:
28+
If you aren't familiar with the Segment Spec, take a look at the Page method documentation (/docs/connections/spec/page/) to learn about what it does. An example call would look like:
2929

3030

3131
```js
@@ -37,7 +37,7 @@ Segment sends Page calls to BytePlus as a `page` event.
3737

3838
## Screen
3939

40-
If you aren't familiar with the Segment Spec, take a look at the [Screen method documentation](https://segment.com/docs/connections/spec/screen/) to learn about what it does. An example call would look like:
40+
If you aren't familiar with the Segment Spec, take a look at the [Screen method documentation](/docs/connections/spec/screen/) to learn about what it does. An example call would look like:
4141
```obj-c
4242
[[SEGAnalytics sharedAnalytics] screen:@"Home"];
4343
```
@@ -46,7 +46,7 @@ Segment sends Screen calls to BytePlus as a`screen`event.
4646
4747
## Identify
4848
49-
If you aren't familiar with the Segment Spec, take a look at the [Identify method documentation](https://segment.com/docs/connections/spec/identify/) to learn about what it does. An example call would look like:
49+
If you aren't familiar with the Segment Spec, take a look at the [Identify method documentation](/docs/connections/spec/identify/) to learn about what it does. An example call would look like:
5050
5151
```js
5252
analytics.identify('userId123', {
@@ -57,7 +57,7 @@ Segment sends Identify calls to BytePlus as an `identify `event with `SSID`.
5757

5858
## Track
5959

60-
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
60+
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](/docs/connections/spec/track/) to learn about what it does. An example call would look like:
6161
```js
6262
analytics.track('Login Button Clicked')
6363
```

src/connections/destinations/catalog/simplereach/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ rewrite: true
33
title: SimpleReach Destination
44
id: 55d3c70e0a20f4e22f0fb3eb
55
---
6-
[SimpleReach](https://simplereach.com/) helps brands, agencies, and publishers increase the impact of their content marketing. The SimpleReach Destination is open-source. You can browse the code [on GitHub](https://github.com/segment-integrations/analytics.js-integration-simplereach).
6+
SimpleReach helps brands, agencies, and publishers increase the impact of their content marketing. The SimpleReach Destination is open-source. You can browse the code [on GitHub](https://github.com/segment-integrations/analytics.js-integration-simplereach).
77

88
## Getting Started
99

src/connections/destinations/catalog/trafficguard/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This destination is maintained by TrafficGuard.
1616

1717
1. From the Segment web app, click **Catalog**.
1818
2. Search for "TrafficGuard" in the Catalog, select it, and choose which of your sources to connect the destination to.
19-
3. Enter the "API Key" into your Segment Settings UI which you can find in your property in the [TrafficGuard dashboard](https://dash.trafficguard.ai/dashboard).
19+
3. Enter the "API Key" into your Segment Settings UI which you can find in the property in the TrafficGuard dashboard.
2020

2121
![](images/trafficguard.png)
2222

0 commit comments

Comments
 (0)