diff --git a/src/connections/destinations/catalog/actions-amazon-conversions-api/index.md b/src/connections/destinations/catalog/actions-amazon-conversions-api/index.md new file mode 100644 index 0000000000..89d415803d --- /dev/null +++ b/src/connections/destinations/catalog/actions-amazon-conversions-api/index.md @@ -0,0 +1,165 @@ +--- +title: Amazon Conversions API (Actions) Destination +id: 683ef14a3f9aac157e3a3446 +hide-personas-partial: true +hide-boilerplate: false +hide-dossier: true +private: true +hidden: true +beta: true + +--- +The Amazon Conversions API (Actions) destination is a server-to-server integration with the Amazon Events API. This destination allows advertisers to send real-time or offline conversion events data from Segment directly to Amazon without needing Amazon Ad Tag (AAT) setup. + +This enables advertisers to evaluate the effectiveness of their Amazon marketing campaigns regardless of the location of the conversion and utilize this information to drive campaign optimization. The Events API can help strengthen performance and decrease cost per action with more complete attribution, improved data reliability, and better optimized delivery. + +## Benefits of Amazon Conversions API (Actions) + +The Amazon Conversions API destination provides the following benefits: + +- **Simplified setup**. Data mapping for actions-based destinations happens during configuration, which eliminates the need for most settings. +- **Clearer data mapping**. Actions-based destinations enable you to define the mapping between the data Segment receives from your source and the data Segment sends to the Amazon Conversions API. +- **Prebuilt event mappings**. Standard events like `Add to Shopping Cart` and `Checkout` come preconfigured with recommended parameters. +- **Multiple event types**. Support for various conversion event types including purchases, sign-ups, leads, and more. +- **Multi-platform support**. Send events from websites, Android apps, iOS apps, Fire TV, or offline sources. +- **Comprehensive user matching**. Multiple matching keys are available including email, phone, name, address, and mobile advertising IDs. +- **Data normalization**. Data is normalized before it's hashed to send to Amazon Conversions. +- **Custom attributes**. Includes additional context with event-specific attributes. +- **Consent management**. Built-in support for various privacy frameworks including Amazon consent options, TCF, and GPP. + +## Getting started + +Before connecting to the Amazon Conversions API destination, you must have an [Amazon Advertising account](https://advertising.amazon.com/API/docs/en-us/guides/onboarding/overview){:target="_blank"} and an Advertiser ID. + +To connect the Amazon Conversions API Destination: + +1. From the Segment web app, go to **Connections > Catalog**. +2. Search for **Amazon Conversions Api** in the top right corner. +3. From the search results under **Destinations**, select the **Amazon Conversions Api** destination and then click **Add destination** +4. Select the source that will send data to the Amazon Conversions API destination and follow the prompts to name your destination. +5. On the **Basic Settings** page, enter: + - Destination name + - **Region:** - Select North America (NA), Europe (EU), or Far East (FE) based on your Amazon Advertising account + - **Amazon Advertiser ID:** - Your Amazon Advertising Account ID +6. Authenticate using OAuth when prompted. +7. Go to the **Mappings** tab. Prebuilt mappings, like `Checkout`, `Search`, and `Add to Shopping Cart`, include predefined parameters. +8. To create a new mapping: + - Click **New Mapping** and select **Track Conversion**. + - Configure and enable the mapping. +9. Follow the steps in [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). +10. Toggle **Enable Destination** on, then click **Save Changes**. + +{% include components/actions-fields.html settings="true"%} + +> info "Event Action Source" +> By default, Segment sends all mappings as `website` conversions. To send events from mobile apps, Fire TV, or offline sources, set the Event Action Source in each mapping to the appropriate value: `android`, `ios`, `fire_tv`, or `offline`. + +## Supported event types + +Amazon Conversions API supports the following standard event types: + +| Event Type | Description | +| ---------- | ----------- | +| ADD_TO_SHOPPING_CART | When a user adds an item to their shopping cart | +| APPLICATION | When a user submits an application | +| CHECKOUT | When a user initiates a checkout process | +| CONTACT | When a user submits contact information | +| LEAD | When a user perform an action that initiates a sales lead | +| OFF_AMAZON_PURCHASES | When a user completes a purchase | +| MOBILE_APP_FIRST_START | When a user opens a mobile app for the first time | +| PAGE_VIEW | When a user views a page | +| SEARCH | When a user performs a search | +| SIGN_UP | When a user creates an account | +| SUBSCRIBE | When a user subscribes to a service | +| OTHER | For custom events that don't fit into the standard types | + +## Match keys for user identification + +Amazon requires at least one match key to identify the user associated with each conversion event. Amazon Conversions API supports the following match keys: + +| Match Key | Description | +| --------- | ----------- | +| email | User's email address (is hashed) | +| phone | User's phone number (is hashed) | +| firstName | User's first name (is hashed) | +| lastName | User's last name (is hashed) | +| address | User's street address (is hashed) | +| city | User's city (is hashed) | +| state | User's state (is hashed) | +| postalCode | User's postal code (is hashed) | +| maid | Mobile advertising ID (ADID, IDFA, or FIREADID) | +| rampId | RAMP ID for attribution to traffic events | +| matchId | Custom match ID for the user | + +Segment automatically maps these fields from standard identity traits when available. + +## Consent management + +For EU advertisers and users, Amazon requires consent information to be included with conversion events. The Amazon Conversions API supports several consent mechanisms. + +### Geographic consent (IP Address) + +For basic consent management, include the user's IP address. Segment automatically maps this from the context.ip field when available. + +### Amazon consent format + +Amazon-specific consent format with two primary fields: + +| Consent Field | Description | Values | +| ------------- | ----------- | ------ | +| amznAdStorage | Whether the user has consented to cookie-based tracking | GRANTED, DENIED | +| amznUserData | Whether the user has consented to use personal data for advertising | GRANTED, DENIED | + +### Industry standard consent + +For more comprehensive consent management: + +| Consent Field | Description | +| ------------- | ----------- | +| tcf | Transparency and Consent Framework (TCF) encoded string | +| gpp | Global Privacy Platform (GPP) encoded string | + +## Data processing options + +The Amazon Conversions API supports data processing options to control how events are processed: + +| Option | Description | +| ------ | ----------- | +| LIMITED_DATA_USE | Signals that an event should be processed with limited data use restrictions. Events marked with this option won't be used for advertising purposes. | + +## Custom attributes + +You can include custom attributes with your events to provide additional context. Each custom attribute has: + +- **Name**: Identifier for the attribute (only letters, numbers, and underscores allowed) +- **Data Type**: STRING, NUMBER, or BOOLEAN +- **Value**: The attribute value (maximum 256 characters) + +## FAQ + +#### How does deduplication work? + +Amazon Conversions API uses the `clientDedupeId` field to prevent duplicate events. By default, Segment maps the messageId to this field. For events with the same clientDedupeId, only the latest event will be processed. + +#### What regions are supported? + +Amazon Conversions API supports three regions: +- North America (NA) +- Europe (EU) +- Far East (FE) + +Select the region that corresponds to your Amazon Advertising account. + +#### What are the requirements for OFF_AMAZON_PURCHASES events? + +OFF_AMAZON_PURCHASES events have additional optional fields: +- `currencyCode`: The currency of the purchase in ISO-4217 format (e.g., USD, EUR) +- `unitsSold`: The number of items purchased (defaults to 1 if not provided) + +#### How are PII fields handled? + +Personally identifiable information (PII) fields like email, phone, name, and address are automatically hashed before sending to Amazon. + +#### How can I verify events in Amazon? + +After you start sending events, you should see them in your Amazon Advertising dashboard under conversion tracking reports. Allow some time for the events to be processed and attributed. diff --git a/src/connections/destinations/catalog/actions-intercom-cloud/index.md b/src/connections/destinations/catalog/actions-intercom-cloud/index.md index b62ec0b0d3..6b69f194d0 100644 --- a/src/connections/destinations/catalog/actions-intercom-cloud/index.md +++ b/src/connections/destinations/catalog/actions-intercom-cloud/index.md @@ -47,3 +47,8 @@ If a company is created without an attached user, the company does not appear on ### Why isn’t a user getting attached to a company? When you use the Identify Company action, Segment creates or updates a company's information. In the same action, Segment also attaches the user in your group call to that company. If the user doesn't exist in Intercom when the action runs, Segment creates or updates the company but can't attach the user. Ensure the user is created in Intercom first. + +### Why do I get a 404 Not Found error when sending Track events to Intercom? +A `404 Not Found` error typically occurs when attempting to update a user in Intercom who does not yet exist in the system. This can happen if an Identify event, which includes the corresponding `userId`, was not sent before the Track event that resulted in the `404` error. + +To resolve this, ensure that Identify events are sent **before** Track events to ensure proper processing and avoid errors. diff --git a/src/connections/destinations/catalog/actions-reddit-audiences/index.md b/src/connections/destinations/catalog/actions-reddit-audiences/index.md index 3ba2f1f0d2..a12eac4470 100644 --- a/src/connections/destinations/catalog/actions-reddit-audiences/index.md +++ b/src/connections/destinations/catalog/actions-reddit-audiences/index.md @@ -1,6 +1,7 @@ --- title: Reddit Audiences id: 66f2b0f961bb2128729079bb +redirect_from: '/connections/destinations/catalog/reddit-audiences/' --- {% include content/plan-grid.md name="actions" %} diff --git a/src/connections/destinations/catalog/actions-reddit-conversions-api/index.md b/src/connections/destinations/catalog/actions-reddit-conversions-api/index.md index 0d3af5d7b1..b645afe69d 100644 --- a/src/connections/destinations/catalog/actions-reddit-conversions-api/index.md +++ b/src/connections/destinations/catalog/actions-reddit-conversions-api/index.md @@ -1,6 +1,7 @@ --- title: Reddit Conversions API id: 66cc766ef4b1c152177239a0 +redirect_from: '/connections/destinations/catalog/reddit-conversions-api/' --- {% include content/plan-grid.md name="actions" %} diff --git a/src/engage/audiences/index.md b/src/engage/audiences/index.md index 285032c5b4..86259525b9 100644 --- a/src/engage/audiences/index.md +++ b/src/engage/audiences/index.md @@ -286,6 +286,9 @@ To access audience alerting, navigate to **Engage > Audiences**, select an audie On the **Alerts** tab, you can create new alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create, unless you have the [Workspace Owner role](/docs/segment-app/iam/roles/). +> info "Deleting alerts created by other users requires Workspace Owner role" +> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. + #### Activation event health spikes or drops You can create an Activation event health spikes or drops alert that notifies you when events sent from your audience to a downstream destination have failures to a destination above a certain threshold. For example, if you set a change percentage of 4% and your destination received 100 events from your audience over the first 24 hours, Segment would notify you the following day if your destination ingested fewer than 96 or more than 104 events. @@ -293,7 +296,7 @@ You can create an Activation event health spikes or drops alert that notifies yo To create an Activation event health spikes or drops alert: 1. From your Segment workspace's home page, navigate to **Engage > Audiences**. 2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**. -3. On the Create alert sidesheet, select the destination for which you'd like to monitor event health. +3. On the Create alert sidesheet, select the **Activation event health spikes or drops** alert and pick a destination for which you'd like to monitor event health. 4. Enter a percentage threshold to trigger activation event health notifications. 5. Select one or more of the following alert channels: - **Email**: Select this to receive notifications at the provided email address. @@ -305,8 +308,27 @@ To make changes to an Activation event health spikes or drops alert, select the To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**. -> info "Deleting alerts created by other users requires Workspace Owner role" -> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. +#### Audience size change + +You can create an Audience size change alert that notifies you when your audience increases or decreases by a certain threshold. For example, if you set a change percentage of 4% and your destination had 100 members over the first 24 hours, Segment would notify you the following day if your audience had fewer than 96 or more than 104 members. + +> info "Audience size change alerts currently only support Linked Audiences" +> Audience size change alerts are in public beta, and Segment is actively working on this feature. During the public beta, Audience size change alerts only support Linked Audiences. Some functionality may change before it becomes generally available. + +To create an Audience size change alert: +1. From your Segment workspace's home page, navigate to **Engage > Audiences**. +2. Select the Linked Audience you want to create an alert for, select the Alerts tab, and click **Create alert**. +3. On the Create alert sidesheet, select the **Audience size change alert** and pick a destination for which you'd like to monitor event health. +4. Enter a percentage threshold to trigger audience size change notifications. +5. Select one or more of the following alert channels: + - **Email**: Select this to receive notifications at the provided email address. + - **Slack**: Select this to send alerts to one or more channels in your workspace. You can post messages to your channel with either a [webhook](https://api.slack.com/messaging/webhooks){:target="_blank”} or a [workflow](https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack){:target="_blank”}. + - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app. +6. Click **Save**. + +To make changes to an Audience size change alert, select the icon in the Actions column for the alert and click **Edit**. + +To delete a Audience size change alert, select the icon in the Actions column for the alert and click **Delete**. ## Access your Audiences using the Profiles API diff --git a/src/engage/audiences/linked-audiences.md b/src/engage/audiences/linked-audiences.md index 2b05ab718f..54baf1c245 100644 --- a/src/engage/audiences/linked-audiences.md +++ b/src/engage/audiences/linked-audiences.md @@ -260,6 +260,61 @@ Linked Audiences have the following steps in Delivery Overview's pipeline view: - **Failed delivery**: Events that Segment _attempted_ to deliver to your destination, but that ultimately _failed_ to be delivered. Failed delivery might indicate an issue with the destination, like invalid credentials, rate limits, or other error statuses received during delivery. - **Successful delivery**: Events that Segment successfully delivered to your destination. You’ll see these events in your downstream integrations. +## Linked Audience Alerts + +You can create alerts related to the performance and throughput of Linked Audience syncs and receive in-app, email, and Slack notifications when event volume fluctuations occur. + +> info "Generate a Slack webhook to receive Slack notifications" +> To receive an alert in a Slack channel, you must first create a Slack webhook. For more information about Slack webhooks, see Slack's [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks){:target="_blank”} documentation. + +To access Linked Audience alerting, navigate to **Engage > Audiences**, select a Linked Audience, and click the **Alerts** tab. + +On the **Alerts** tab, you can create new alerts and view all active alerts for this connection. You can only edit or delete the alerts that you create, unless you have the [Workspace Owner role](/docs/segment-app/iam/roles/). + +> info "Deleting alerts created by other users requires Workspace Owner role" +> All users can delete alerts that they created, but only those with [Workspace Owner role](/docs/segment-app/iam/roles/) can delete alerts created by other users. + +#### Activation event health spikes or drops + +You can create an Activation event health spikes or drops alert that notifies you when events sent from your audience to a downstream destination have failures to a destination above a certain threshold. For example, if you set a change percentage of 4% and your destination received 100 events from your audience over the first 24 hours, Segment would notify you the following day if your destination ingested fewer than 96 or more than 104 events. + +To create an Activation event health spikes or drops alert: +1. From your Segment workspace's home page, navigate to **Engage > Audiences**. +2. Select the Audience you want to create an alert for, select the Alerts tab, and click **Create alert**. +3. On the Create alert sidesheet, select the **Activation event health spikes or drops** alert and pick a destination for which you'd like to monitor event health. +4. Enter a percentage threshold to trigger activation event health notifications. +5. Select one or more of the following alert channels: + - **Email**: Select this to receive notifications at the provided email address. + - **Slack**: Select this to send alerts to one or more channels in your workspace. You can post messages to your channel with either a [webhook](https://api.slack.com/messaging/webhooks){:target="_blank”} or a [workflow](https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack){:target="_blank”}. + - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app. +6. Click **Save**. + +To make changes to an Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Edit**. + +To delete a Activation event health spikes or drops alert, select the icon in the Actions column for the alert and click **Delete**. + +#### Audience size change + +You can create an Audience size change alert that notifies you when your audience increases or decreases by a certain threshold. For example, if you set a change percentage of 4% and your destination had 100 members over the first 24 hours, Segment would notify you the following day if your audience had fewer than 96 or more than 104 members. + +> info "Audience size change alerts are currently in Public Beta" +> Audience size change alerts are in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. + +To create an Audience size change alert: +1. From your Segment workspace's home page, navigate to **Engage > Audiences**. +2. Select the Linked Audience you want to create an alert for, select the Alerts tab, and click **Create alert**. +3. On the Create alert sidesheet, select the **Audience size change alert** and pick a destination for which you'd like to monitor event health. +4. Enter a percentage threshold to trigger audience size change notifications. +5. Select one or more of the following alert channels: + - **Email**: Select this to receive notifications at the provided email address. + - **Slack**: Select this to send alerts to one or more channels in your workspace. You can post messages to your channel with either a [webhook](https://api.slack.com/messaging/webhooks){:target="_blank”} or a [workflow](https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack){:target="_blank”}. + - **In-app**: Select this to receive notifications in the Segment app. To view your notifications, select the bell next to your user icon in the Segment app. +6. Click **Save**. + +To make changes to an Audience size change alert, select the icon in the Actions column for the alert and click **Edit**. + +To delete a Audience size change alert, select the icon in the Actions column for the alert and click **Delete**. + ## Maintaining Linked Audiences You can maintain your Linked Audience by accessing these tabs on the main page of your Linked Audience: diff --git a/src/monitor/alerts/default-alerts.md b/src/monitor/alerts/default-alerts.md index 5d4b7dca16..5e4ca88392 100644 --- a/src/monitor/alerts/default-alerts.md +++ b/src/monitor/alerts/default-alerts.md @@ -117,7 +117,7 @@ your identity-resolved profiles to your data warehouse. - **Audience Run Failed**: Segment was unable to compute your Audience. To resolve this error, please [contact Segment support](https://segment.com/help/contact/){:target="_blank”}. > info "Custom Engage alerts" -> During the Monitor public beta, you can configure custom [Activation event health spikes or drops](/docs/engage/audiences/#activation-event-health-spikes-or-drops) alerts, but these alerts won't appear in the Monitor tab. +> During the Monitor public beta, you can configure custom [Activation event health spikes or drops](/docs/engage/audiences/#activation-event-health-spikes-or-drops) and [Audience size change](/docs/engage/audiences/#audience-size-change) alerts, but these alerts won't appear in the Monitor tab. ## Users alerts - **Access Request Created**: A user in your workspace requested access to a resource that they don't currently have permission to view. For more information, see the [Request Access](/docs/segment-app/iam/membership/#request-access) documentation. diff --git a/src/unify/profiles-sync/tables.md b/src/unify/profiles-sync/tables.md index 3e495600b7..4329c9dcd6 100644 --- a/src/unify/profiles-sync/tables.md +++ b/src/unify/profiles-sync/tables.md @@ -105,7 +105,9 @@ Profile raw tables contain records of changes to your Segment profiles and Ident With raw tables, you have full control over the materialization of Profiles in your warehouse, as well as increased observibility. -Raw tables contain complete historical data when using historical backfill. +Raw tables contain complete historical data when using historical backfill. + +The `Timestamp` column will be empty for backfilled data because, during backfill, historical profile changes are inferred from the current state of the profile and do not reflect the actual change history. ### The id_graph_updates table