Skip to content

Commit 384b379

Browse files
committed
chore: fixes for serialization of batch 8.3
1 parent 7f5ec0f commit 384b379

File tree

10 files changed

+19
-27
lines changed

10 files changed

+19
-27
lines changed

src/connections/destinations/catalog/ab-smartly/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ Segment provides specific implementation details for A/B Smartly in the sections
2424
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2525
2. Search for "A/B Smartly" in the Destinations Catalog, and select the "A/B Smartly" destination.
2626
3. Choose which Source should send data to the "A/B Smartly" destination.
27-
4. Go to the A/B Smartly dashboard(https://your-org-name.absmartly.com/apikey/list){:target="_blank”}, find and copy the "API key" that you created for segment.
27+
4. Go to the A/B Smartly dashboard (`https://your-org-name.absmartly.com/apikey/list`), find and copy the "API key" that you created for segment.
2828
5. Enter the "API Key" in the "A/B Smartly" destination settings in Segment.
2929
6. If the integration requests for an Application name go to your A/B Smartly dashboard (`https://your-org-name.absmartly.com/application/create`) and create an Application named "Segment", or whatever you would like to call it. Use that name in the Application field of the integration settings.
3030
7. Add also your A/B Smartly Collector endpoint. It's the same endpoint that you are using in all your A/B Smartly SDKs.
3131
8. Enter the environment from your Environment list (`https://your-org-name.absmartly.com/environment/list`) that should receive your Segment data. Most likely it will be the production one.
32-
9. And finally a mapping of Segment Identities to A/B Smartly Units(`https://your-org-name.absmartly.com/unit/list`). You should map all of your Segment identities that you would like to use in your A/B tests to the units that you already have in A/B Smartly. Users must map all the identity types, but not for the individual users. Map all of your ids in your Unit List(`https://your-org-name.absmartly.com/unit/list`).
32+
9. And finally a mapping of Segment Identities to A/B Smartly Units (`https://your-org-name.absmartly.com/unit/list`). You should map all of your Segment identities that you would like to use in your A/B tests to the units that you already have in A/B Smartly. Users must map all the identity types, but not for the individual users. Map all of your ids in your Unit List(`https://your-org-name.absmartly.com/unit/list`).
3333
10. Optionally go to "Goal Mapping" and start adding the track calls that you would like to see showing up on A/B Smartly as goals. You only need to create a name mapping if the name of the goal on A/B Smartly's platform is different from the name of the track call in Segment.
3434

3535
## Page

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Once the Segment library is integrated with your server, toggle Aboardly on in y
1010

1111
Aboardly supports the `identify` and `track` methods.
1212

13-
- - -
14-
1513
## Identify
1614

1715
When you `identify` a user, we'll pass that user's information to Aboardly with `userId` as Aboardly's External Customer ID. Aboardly recognizes all traits sent by Segment, however in order to send emails you should always add the `email` trait when possible.

src/connections/destinations/catalog/actions-webhook-extensible/reddit-ads-conversion-api-integration-recipe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ To map data from your destination to Reddit Ads:
132132
4. Fill out mapping fields:
133133
1. To specify the URL, go to your Reddit Ads account, navigate to **Pixel configuration** to find your Pixel ID. The format of the URL should be `https://ads-api.reddit.com/api/v2.0/conversions/events/{{YOURPIXEL_ID}}`, with your pixel ID being at the end of the URL.
134134
2. Specify the headers:
135-
- Set up Authorization using the bearer token generated in the previous step.
136-
- Specify the content type that the Conversion API expects.
135+
- Set up Authorization using the bearer token generated in the previous step.
136+
- Specify the content type that the Conversion API expects.
137137
5. Use the mapping interface and search for the “body” parameter that was created in the insert function to select the transformed object that can be sent as the event body.
138138
6. Turn off batching for this operation.
139139

src/connections/destinations/catalog/adobe-analytics/index.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,6 @@ It can also take up to an hour for all of the mobile users' Segment settings cac
5959

6060
Adobe Analytics has a real-time reporting feature which displays web page traffic and ranks page views in real time. Configuring and enabling these reports are restricted to Adobe Admin users. To learn more see Adobe's [overview on Real-time reporting](https://docs.adobe.com/content/help/en/analytics/components/real-time-reporting/realtime.html){:target="_blank”}
6161

62-
---
63-
6462
## Device-mode - Analytics.js
6563

6664
Device-mode web data is sent using Analytics.js, with Analytics.js either serving as a wrapper/bundle around the Adobe Analytics code, or sending directly to Segment servers where the data is then sent on to the Adobe destination.
@@ -86,8 +84,6 @@ To use Adobe's Marketing Cloud Visitor ID Service, enter your **Marketing Cloud
8684

8785
![A screenshot of the Adobe Analytics settings page in Segment, with the Identity Resolution section selected.](images/mcvid.png)
8886

89-
---
90-
9187
## Cloud-mode - Server-side
9288

9389
"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. Cloud mode data is sent to Adobe using Adobe's data insertion API in XML format. To learn more about Adobe's data insertion API see the [documentation here](https://docs.adobe.com/content/help/en/analytics/import/c-data-insertion-api.html){:target="_blank”}.
@@ -128,8 +124,8 @@ Segment's server-side integration is not open-source. Let's explore what happens
128124
});
129125
```
130126

131-
- `userId`
132-
- `anonymousId`
127+
- `userId`
128+
- `anonymousId`
133129

134130
> info ""
135131
> Adobe Analytics timestamp options need to match in the Segment destination settings and Adobe setting. Otherwise, events might be silently dropped by Adobe despite sending a 200 success response to Segment

src/connections/destinations/catalog/adwords-remarketing-lists/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Engage audiences can only send to Google Ads Remarketing Lists for Google Search
168168

169169
#### How many users must be in an audience to use Google Ads Campaigns?
170170

171-
100.
171+
100
172172

173173
#### What custom matchers does Engage send to Google Ads?
174174

src/connections/destinations/catalog/all-aboard/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Once the Segment library is integrated with your server, toggle All Aboard! to "
1010

1111
All Aboard! supports the `identify` method.
1212

13-
- - -
14-
1513
## Identify
1614

1715
When you `identify` a user we pass that user's information to All Aboard. You can use the `identify` call to add new customers to All Aboard! or append traits to existing customers.

src/connections/destinations/catalog/amazon-kinesis-firehose/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To get started:
1414
2. Create an IAM policy.
1515
1. Sign in to the [Identity and Access Management (IAM) console](https://console.aws.amazon.com/iam/){:target="_blank"}.
1616
2. Follow [these instructions](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create-console.html#access_policies_create-json-editor){:target="_blank"} to create an IAM policy on the JSON to allow Segment permission to write to your Kinesis Firehose Stream.
17-
- Use the following template policy in the **Policy Document** field. Be sure to change the `{region}`, `{account-id}` and `{stream-name}` with the applicable values.
17+
- Use the following template policy in the **Policy Document** field. Be sure to change the `{region}`, `{account-id}` and `{stream-name}` with the applicable values.
1818

1919

2020
```js
@@ -36,11 +36,11 @@ To get started:
3636

3737

3838
3. Create an IAM role.
39-
1. Follow [these instructions](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html#roles-creatingrole-user-console){:target="_blank”} to create an IAM role to allow Segment permission to write to your Kinesis Firehose Stream.
40-
2. When prompted to enter an Account ID, enter `595280932656`.
41-
3. Select the checkbox to enable **Require External ID**.
42-
4. Enter your Secret ID as the **External ID**. This can be found in Segment by navigating to your Amazon Kinesis Firehose destination in Segment, going to the Settings tab, and clicking the Secret ID setting.
43-
- **Note:** If you have multiple sources using Kinesis, enter one of their Secret IDs here for now and then follow the procedure outlined in the [Multiple Sources](#best-practices) section at the bottom of this doc once you've completed this step and saved your IAM role.
39+
1. Follow [these instructions](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html#roles-creatingrole-user-console){:target="_blank”} to create an IAM role to allow Segment permission to write to your Kinesis Firehose Stream.
40+
2. When prompted to enter an Account ID, enter `595280932656`.
41+
3. Select the checkbox to enable **Require External ID**.
42+
4. Enter your Secret ID as the **External ID**. This can be found in Segment by navigating to your Amazon Kinesis Firehose destination in Segment, going to the Settings tab, and clicking the Secret ID setting.
43+
- **Note:** If you have multiple sources using Kinesis, enter one of their Secret IDs here for now and then follow the procedure outlined in the [Multiple Sources](#best-practices) section at the bottom of this doc once you've completed this step and saved your IAM role.
4444
5. When adding permissions to your new role, find the policy you created in step 2 and attach it.
4545

4646
4. Create a new Kinesis Firehose Destination.

src/connections/destinations/catalog/amazon-kinesis/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ To get started:
4343
3. Create an IAM role.
4444
1. Follow these instructions to [Create an IAM role](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user.html#roles-creatingrole-user-console){:target="_blank"} to allow Segment permission to write to your Kinesis Stream.
4545
2. When prompted to enter an Account ID, enter `595280932656`. Make sure to enable **Require External ID** and enter your Segment Source ID as the External ID. This can be found by navigating to **Settings > API Keys** from your Segment source homepage.
46-
* **NOTE:** If you have multiple sources using Kinesis, enter one of their source IDs here for now and then follow the procedure outlined in the [Multiple Sources](/docs/connections/destinations/catalog/amazon-kinesis/#multiple-sources) section once you've completed this step and saved your IAM role.
46+
* **NOTE:** If you have multiple sources using Kinesis, enter one of their source IDs here for now and then follow the procedure outlined in the [Multiple Sources](/docs/connections/destinations/catalog/amazon-kinesis/#multiple-sources) section once you've completed this step and saved your IAM role.
4747
3. When adding permissions to your new role, find the policy you created in step 2 and attach it.
4848

4949
4. Create a new Kinesis destination.
5050
1. In the Segment source that you want to connect to your Kinesis destination, click **Add Destination**. Search and select the **Amazon Kinesis** destination.
5151
2. Enter the **Role Address**, **Stream Region**, **Stream Name**, and **Secret ID**.
52-
* **NOTE:** For security purposes, Segment sets your Workspace ID as your Secret ID. If you're using a Secret ID different from your Workspace ID, reach out to our support team so they can change it to make your account more secure.
52+
* **NOTE:** For security purposes, Segment sets your Workspace ID as your Secret ID. If you're using a Secret ID different from your Workspace ID, reach out to our support team so they can change it to make your account more secure.
5353

5454
> success ""
5555
> Segment's Amazon Kinesis destination only transmits data in JSON format.

src/connections/destinations/catalog/amazon-lambda/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ To configure your Segment Lambda destination:
183183

184184
This setting controls the [Log Type](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax){:target="_blank”} for your Lambda function using Cloud Watch. Select option `Tail` if you would like to see [detailed logs](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html){:target="_blank”} in Cloud Watch.
185185

186-
**My Lambda <> Segment connection is timing out, what do I do?**
186+
**My Lambda `<>` Segment connection is timing out, what do I do?**
187187

188188
Due to how the event delivery system, [Centrifuge](https://www.twilio.com/en-us/blog/archive/2018/introducing-centrifuge){:target="_blank”}, works, your Lambda can't take more than 5 seconds to run per message. If you're consistently running into timeout issues, you should consult the [AWS Lambda docs](https://docs.aws.amazon.com/lambda/index.html#lang/en_us){:target="_blank”}, as well as docs for your language of choice, for tips on optimizing performance.
189189

src/connections/destinations/catalog/amazon-personalize/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -799,7 +799,7 @@ To install Segment's Layer:
799799

800800
You need to modify the IAM Role & Policy originally created with this Lambda to allow it to send and receive data from Personalize. To do this:
801801

802-
1. From the **Execution role** section of your Lambda function, click the **View the <your-role-name>** link.
802+
1. From the **Execution role** section of your Lambda function, click the **View the `<your-role-name>`** link.
803803

804804
![A screenshot of the execution role settings section on your Lambda.](images/ExecutionRoleIAM.png)
805805

@@ -907,7 +907,7 @@ You need to create a Personalize Event Tracker for the Dataset Group you created
907907
}
908908
```
909909

910-
* This may be automatically included as policy "AmazonPersonalize-ExecutionPolicy-<some-set-of-numbers>"
910+
* This may be automatically included as policy `AmazonPersonalize-ExecutionPolicy-<some-set-of-numbers>`
911911

912912
```json
913913
{
@@ -1004,6 +1004,6 @@ There are two settings relevant for track calls:
10041004

10051005
This setting controls the [Log Type](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax){:target="_blank”} for your Lambda function using Cloud Watch. Select option `Tail` if you would like to see [detailed logs](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html){:target="_blank”}in Cloud Watch.
10061006

1007-
**My Lambda <> Segment connection is timing out, what do I do?**
1007+
**My Lambda `<>` Segment connection is timing out, what do I do?**
10081008

10091009
Due to how Segment's event delivery system, [Centrifuge](https://www.twilio.com/en-us/blog/archive/2018/introducing-centrifuge){:target="_blank”}, works, your Lambda can't take more than five seconds to run per message. If you're consistently running into timeout issues, you should consult the [AWS Lambda docs](https://docs.aws.amazon.com/lambda/index.html#lang/en_us){:target="_blank”}, as well as docs for your language of choice, for tips on optimizing performance.

0 commit comments

Comments
 (0)