Skip to content

Commit

Permalink
Merge pull request #6975 from segmentio/develop
Browse files Browse the repository at this point in the history
Release 24.34.2
  • Loading branch information
pwseg authored Aug 22, 2024
2 parents f834cda + 90adb66 commit 2abf977
Show file tree
Hide file tree
Showing 16 changed files with 187 additions and 87 deletions.
2 changes: 1 addition & 1 deletion src/_data/catalog/destination_categories.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination categories last updated 2024-08-20
# destination categories last updated 2024-08-22
items:
- display_name: A/B Testing
slug: a-b-testing
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/destinations.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2024-08-20
# destination data last updated 2024-08-22
items:
- id: 637e8d185e2dec264895ea89
display_name: 1Flow
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/destinations_private.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2024-08-20
# destination data last updated 2024-08-22
items:
- id: 54521fd925e721e32a72eee1
display_name: Pardot
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/source_categories.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# source categories last updated 2024-08-20
# source categories last updated 2024-08-22
items:
- display_name: A/B Testing
slug: a-b-testing
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/sources.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# sources last updated 2024-08-20
# sources last updated 2024-08-22
items:
- id: 8HWbgPTt3k
display_name: .NET
Expand Down
14 changes: 14 additions & 0 deletions src/_data/sidenav/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,18 @@ sections:
title: Sample Queries
- path: /unify/profiles-sync/tables
title: Tables & Materialized Views
- section_title: Data Graph
slug: unify/data-graph
section:
- path: /unify/data-graph/
title: Data Graph
- section_title: Setup Guides
slug: /unify/data-graph/setup-guides/
section:
- path: /unify/data-graph/setup-guides/snowflake-setup/
title: Snowflake Setup
- path: /unify/data-graph/setup-guides/databricks-setup/
title: Databricks Setup
- section_title: Traits
slug: unify/traits
section:
Expand Down Expand Up @@ -409,6 +421,8 @@ sections:
section:
- path: '/engage/audiences'
title: Audiences Overview
- path: '/engage/audiences/linked-audiences'
title: Linked Audiences
- path: '/engage/audiences/account-audiences'
title: Account-level Audiences
- path: '/engage/audiences/generative-audiences'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
title: Dynamic Yield By Mastercard Audiences Destination
id: 64ede9fe67158afa8de61480
engage: true
beta: true
---

{% include content/plan-grid.md name=actions %}

[Dynamic Yield by Mastercard](https://www.dynamicyield.com/){:target="_blank”} helps businesses deliver digital customer experiences that are personalized, optimized, and synchronized.
With Dynamic Yield’s Experience OS, you can algorithmically match content, products, and offers to each individual customer to increase revenue, build customer loyalty, and gain a sustainable competitive advantage.

This destination is maintained by Dynamic Yield by Mastercard. For any issues with the destination, [contact the Dynamic Yield support team](mailto:[email protected]).

## Getting started

**Dynamic Yield by Mastercard Audiences** is an Audience Destination which must be first connected to an Engage Space before it can be connected to individual Engage Audiences. The steps below outline how to connect the Destination to an Engage Space and then to an Audience.

### Create an instance of the Dynamic Yield Destination

1. From your Segment workspace, navigate to **Connections > Catalog**.
2. Use the search field to find the **Dynamic Yield by Mastercard Audiences** Destination, then select it.
3. Click **Add destination**.
4. Select the Engage Space you'd like to connect your destination to and click **Next**.
5. Enter a name for your destination and click **Create destination**.

### Configuring Basic Settings
1. Provide the Section ID and Connection Key on the Settings tab for your Dynamic Yield by Mastercard destination.
2. Enable the Destination using the toggle, then click the **Save changes** button.


### Create and configure a Mapping
You must first create, configure, and enable a Mapping before connecting your Audiences to the Dynamic Yield by Mastercard destination.

1. Navigate to the Mappings tab in the Dynamic Yield by Mastercard Destination.
2. Click **New Mapping** and select the **Sync Audience Action**.
3. Ensure that the only condition to trigger the mapping is **Event Type is Track** (remove the **Event Type is Identify** condition, if present).
4. Click **Save**.
5. Enable the Mapping from the Mappings tab using the **Status** toggle.

Once these steps have been completed you can connect Audiences to the Destination.

### Connecting Audiences to the Dynamic Yield by Mastercard Destination

1. Navigate to your **Engage Space > Audiences**.
2. Select the Audience you'd like to sync to your Dynamic Yield by Mastercard Audiences destination.
3. Click **+ Add destination**, select the **Dynamic Yield by Mastercard Audiences** Destination you connected earlier, and click **Add Destination**.
4. On the Audience Settings panel, provide a value for the following fields:
- **Audience Name**: The name Segment uses when creating the Audience in Dynamic Yield.
- **Identifier Type**: Select `userid`, `anonymousid`, or `email`. * See [Customized Identifier Setup](#customized-identifier-setup) for how to configure identifiers other than userid, email or anonymousid.
5. Enable the **Send Track** toggle. You don't need to change the **Enter Event** or **Exit Event** fields, as these are not used by this Destination.
6. Click **Default Setup** panel under **Event settings**.
7. Click **Save** and then click **Add Destination**.

The Destination is now connected to your Audience and starts syncing data to Dynamic Yield.


### Customized Identifier Setup
The Dynamic Yield Audience Destination can accept identifiers other than userId, anonymousId or email. However, this requires some additional configuration steps when connecting the Audience to your Dynamic Yield Audiences Destination.

1. When connecting your Audience to the **Dynamic Yield Audiences** Destination, select the **Customized Setup** panel under **Event Settings**.
2. Click**Add identifier** then select the identifier type you'd like to use.
3. Provide a name for the identifier in the **Identifier in destination** field.
4. Scroll back up to the top of the Audience Settings panel and ensure that the **Identifier Type** field contains the name of the identifier you configured in the Customized Setup panel.
5. Click **Save** and then click **Add Destination** button.

The Destination is now connected to your Audience and starts syncing data to Dynamic Yield with the specified custom identifier.

{% include components/actions-fields.html %}
2 changes: 2 additions & 0 deletions src/connections/destinations/catalog/facebook-pixel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,8 @@ If you're using real estate, travel, or automotive [Dynamic Ads](https://www.fac

For most implementations, Segment recommends leaving these mappings blank. By default, Segment sets `content_type` to "product".

The same mapping can be used to change the `content_id` from the default value (product_id or the sku) to anything specific for Meta Pixel. For more information about required Meta Pixel events, see Meta's [Required Meta Pixel events and parameters for Advantage+ catalog ads](https://www.facebook.com/business/help/606577526529702?id=1205376682832142){:target="_blank”} documentation.

## Troubleshooting

### PII blocklisting
Expand Down
2 changes: 2 additions & 0 deletions src/connections/destinations/catalog/inkit/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
title: Inkit Destination
rewrite: true
id: 5f0746ced1c79b49ddee49fd
hidden: true
---

[Inkit](https://inkit.com){:target="_blank"} and Segment empower organizations to securely generate and distribute documents - both digitally as well as through direct mail.
For example, automatically create and send electronic documents like invoices, reports, notices, and more through a magic link or e-delivery. Or generate and send documents for e-signature, storage, postcards, letters, and more, all powered by the Inkit integration for Segment.

Expand Down
4 changes: 4 additions & 0 deletions src/connections/destinations/destination-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,3 +259,7 @@ When Segment sends an event to a destination but encounters a timeout error, it
#### How do destination filters handle Protocols Transformations?
- **Source-Scoped Transformations**: If destination filters are enabled, Segment processes [source scoped transformations](/docs/protocols/transform/#step-2-set-up-the-transformation) before the events reach destination filters.
- **Destination-Scoped Transformations**: Segment processes [destination-specific transformations](/docs/protocols/transform/#step-2-set-up-the-transformation) after the events have passed through the destination filters.

#### Are destination filter conditions case-sensitive?

Destination filters are case-sensitive. Make sure to test your filter conditions with a test event before saving and enabling the filter.
33 changes: 15 additions & 18 deletions src/connections/sources/catalog/libraries/server/http-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,19 +74,6 @@ You can reuse the access token until the expiry period specified on the OAuth ap

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

## Errors

Segment returns a `200` response for all API requests except errors caused by large payloads and JSON errors (which return `400` responses.) To debug events that return `200` responses but aren't accepted by Segment, use the Segment Debugger.

Common reasons events are not accepted by Segment include:
- **Payload is too large:** The HTTP API can handle API requests that are 32KB or smaller. The batch API endpoint accepts a maximum of 500KB per request, with a limit of 32KB per event in the batch. If these limits are exceeded, Segment returns a 400 Bad Request error.
- **Identifier is not present**: The HTTP API requires that each payload has a userId and/or anonymousId.
- **Track event is missing name**: All Track events sent to Segment must have an `event` field.
- **Deduplication**: Segment deduplicates events using the `messageId` field, which is automatically added to all payloads coming into Segment. If you're setting up the HTTP API yourself, ensure all events have unique messageId values with fewer than 100 characters.
- **Invalid JSON**: If you send an event with invalid JSON, Segment returns a 400 Bad Request error.

Segment welcomes feedback on API responses and error messages. [Reach out to support](https://segment.com/help/contact/){:target="_blank"} with any requests or suggestions you may have.

## Rate limits

For each workspace, Segment recommends you to not exceed 1,000 requests per second with the HTTP API. If you exceed this, Segment reserves the right to queue any additional events and process those at a rate that doesn't exceed the limit. Requests that exceed acceptable limits may be rejected with HTTP Status Code 429. When Segment rejects the requests, the response header contains `Retry-After` and `X-RateLimit-Reset` headers, which contains the number of seconds after which you can retry the request.
Expand Down Expand Up @@ -470,16 +457,26 @@ Destination flags are **case sensitive** and match [the destination's name in th

When sending a HTTP call from a user's device, you can collect the IP address by setting `context.direct` to `true`.

## Troubleshooting
## Errors

Segment returns a `200` response for all API requests except errors caused by large payloads and JSON errors (which return `400` responses.) To debug events that return `200` responses but aren't accepted by Segment, use the Segment Debugger.

Common reasons events are not accepted by Segment include:
- **Payload is too large:** The HTTP API can handle API requests that are 32KB or smaller. The batch API endpoint accepts a maximum of 500KB per request, with a limit of 32KB per event in the batch. If these limits are exceeded, Segment returns a 400 Bad Request error.
- **Identifier is not present**: The HTTP API requires that each payload has a userId and/or anonymousId. If you send events without either the userId or anonymousId, Segment’s tracking API responds with an no_user_anon_id error. Check the event payload and client instrumentation for more details.
- **Track event is missing name**: All Track events sent to Segment must have an `event` field.
- **Deduplication**: Segment deduplicates events using the `messageId` field, which is automatically added to all payloads coming into Segment. If you're setting up the HTTP API yourself, ensure all events have unique messageId values with fewer than 100 characters.
- **Invalid JSON**: If you send an event with invalid JSON, Segment returns a 400 Bad Request error.
- **Incorrect credentials**: Double check your credentials for your downstream destinations.
- **Destination incompatibility**: Make sure that the destination you are troubleshooting can accept server-side API calls. You can see compatibility information on the [Destination comparison by category](/docs/connections/destinations/category-compare/) page and in the documentation for your specific destination.
- **Destination-specific requirements**: Check the documentation specific to the destination to see if there are other requirements for using the method and destination that you're trying to get working.

{% include content/troubleshooting-intro.md %}
Segment welcomes feedback on API responses and error messages. [Reach out to support](https://segment.com/help/contact/){:target="_blank"} with any requests or suggestions you may have.

<!-- LR: no quickstart for this file. removing this include and manually putting in a flat text version that can be customized {% include content/troubleshooting-server-debugger.md %} -->
## Troubleshooting

### No events in my debugger

1. Double check that you've set up the library correctly.

2. Make sure that you're calling a Segment API method after the library is successfully installed—[Identify](#identify), [Track](#track), and so on.

{% include content/server-side-troubleshooting.md %}
Loading

0 comments on commit 2abf977

Please sign in to comment.