You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/actions-webhook-extensible/reddit-ads-audience-integration-recipe.md
+26-25Lines changed: 26 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,23 @@
2
2
title: Reddit Ads (Audience) Integration Recipe
3
3
---
4
4
5
-
This recipe will guide you through setting up a custom destination for Reddit Ads (Audiences) using Twilio Segment's Extensible Webhooks feature. By following these steps, you will be able to integrate your data source with Reddit Ads (Audiences).
5
+
This recipe will guide you through setting up a custom destination for [Reddit Ads (Audiences)](https://ads.reddit.com/){:target="_blank"} using Twilio Segment's [Extensible Webhooks](https://segment.com/docs/connections/destinations/catalog/actions-webhook-extensible/){:target="_blank"} feature. By following these steps, you will be able to integrate your data source with Reddit Ads (Audiences).
6
6
7
7
## Prerequisites
8
8
9
9
To integrate Reddit Ads with Segment, ensure you have the following:
10
10
11
-
A Segment account: an account with the Extensible Webhooks feature enabled (private beta access).
12
-
A Reddit Ads (Audiences) account: an active account or API access to Reddit Ads (Audiences).
13
-
Authentication credentials: necessary credentials for authentication, for example, API keys and tokens.
14
-
Data mapping information: knowledge of the data fields required by Reddit Ads (Audiences).
11
+
-A Segment account: an account with the Extensible Webhooks feature enabled (private beta access).
12
+
-A Reddit Ads (Audiences) account: an active account or API access to Reddit Ads (Audiences).
13
+
-Authentication credentials: necessary credentials for authentication, for example, API keys and tokens.
14
+
-Data mapping information: knowledge of the data fields required by Reddit Ads (Audiences).
15
15
16
16
## Getting started
17
17
18
-
### 1. Configure Extensible Webhook as a destination
18
+
### 1. Configure Extensible Webhooks as a destination
19
19
20
20
1. In your Segment workspace, navigate to **Connections** > **Catalog** > **Destinations**.
21
-
2. Use the search bar to search for **Extensible Webhook** and select **Add destination**.
21
+
2. Use the search bar to search for "Extensible Webhooks" and select **Add destination**.
22
22
23
23
### 2. Select the data source
24
24
@@ -36,8 +36,8 @@ When creating your app, specify the following details:
36
36
- Description (optional): Add a brief description of the integration.
37
37
- Endpoint URL: Provide the webhook URL or endpoint provided by Reddit Ads (Audiences).
38
38
39
-
> info: Redirect URI
40
-
The redirect URI used when creating a Reddit web app is “https://app.segment.com/oauth-service/webhook/callback”.
39
+
> info "Redirect URI"
40
+
> The redirect URI used when creating a Reddit web app is `https://app.segment.com/oauth-service/webhook/callback`.
41
41
42
42
### 4. Select the authentication type
43
43
@@ -47,11 +47,11 @@ To set up OAuth:
47
47
48
48
1. Go to **Authentication Method** and select **OAuth 2.0**.
- Scope: To update Audiences, you will need to add ‘adsedit’ as a scope. To add multiple scopes, separate the values by commas.
56
56
57
57
You can also find the Authorize URL, Token URL, and Refresh URL in the [Reddit documentation](https://ads-api.reddit.com/docs/v3/operations/Update%20Custom%20Audience%20Users){:target="_blank"}.
@@ -63,7 +63,7 @@ You can also find the Authorize URL, Token URL, and Refresh URL in the [Reddit d
63
63
64
64
#### Data transformation
65
65
66
-
The Reddit Custom Audience API expects data in a nested format. To format the payload correctly, you will have to write an insert function that appends a new property called “body” (for example).
66
+
The Reddit Custom Audience API expects data in a nested format. To format the payload correctly, you will have to write an insert function that appends a new property, such as "body".
67
67
68
68
This will have the following structure:
69
69
@@ -87,29 +87,29 @@ This will have the following structure:
87
87
88
88
The required parameters are:
89
89
90
-
-`action_type` which can take values “ADD” or “REMOVE” depending on whether a customer has to be added or removed from the list.
91
-
-`column_order` which can take two values, “EMAIL_SHA256” and “MAID_SHA256”. The order indicates the column order of the data being synced inside `user_data`
92
-
-`user_data` is an array of values which has hashed email id or MAID id or both. For the beta, Segment doesn’t support batching to iterate just over this array yet.
90
+
-`action_type` which can take values `ADD` or `REMOVE` depending on whether a customer has to be added or removed from the list.
91
+
-`column_order` which can take two values, `EMAIL_SHA256` and `MAID_SHA256`. The order indicates the column order of the data being synced inside `user_data`.
92
+
-`user_data` is an array of values which has hashed `email_id`or `MAID_id`or both. While in beta, Segment doesn’t support batching to iterate just over this array yet.
93
93
94
94
#### Data mapping
95
95
96
96
In this recipe, as an example, users are added to the existing audience but you can use one or multiple mappings to perform any `PUT`, `PATCH` or `POST` action types.
97
97
98
-
1. Create a new mapping from the **Mappings** tab, click on **Add Mapping** and select the “Send” HTTP action.
98
+
1. Create a new mapping from the Mappings tab, click on **Add Mapping** and select the **Send** HTTP action.
99
99
2. Select events to send. Define the event triggers to send to Reddit Ads (Audiences) using the event filters.
100
100
3. Fill out mapping fields:
101
101
1. Specify the URL and method.
102
-
- For example, using the following URL: https://ads-api.reddit.com/api/v3/custom_audiences/{audience_id}/users
103
-
1. Replace `audience_id` with the actual audience ID you want to edit. You can find the iID below the name of the Audience List to be modified on Audience Manager.
104
-
2. Select `PATCH` as the HTTP method. The API expects a Patch operation on the endpoint.
102
+
- For example, using the following URL: `https://ads-api.reddit.com/api/v3/custom_audiences/{audience_id}/users`
103
+
1. Replace `audience_id` with the actual audience ID you want to edit. You can find the ID below the name of the Audience List to be modified on Audience Manager.
104
+
2. Select `PATCH` as the HTTP method. The API expects a `PATCH` operation on the endpoint.
105
105
4. 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.
106
106
5. Turn off batching for this operation.
107
107
108
-
Reddit supports three types of actions that can be performed via Extensible Webhook.
108
+
Reddit supports three types of actions that can be performed via Extensible Webhooks.
109
109
110
110
- Audiences
111
111
- Manage Audiences: Create a new audience or manage existing ones.
112
-
- Manage Audience Users: PATCH users in existing audiences or create a new audience and add users to it.
112
+
- Manage Audience Users: `PATCH` users in existing audiences or create a new audience and add users to it.
113
113
- Campaigns
114
114
- Manage Campaigns: Create a new campaign or manage existing ones.
115
115
@@ -120,7 +120,8 @@ Reddit supports three types of actions that can be performed via Extensible Webh
120
120
121
121
Troubleshooting:
122
122
123
-
- If the test fails, review the authentication details and data mappings.
123
+
If the test fails:
124
+
- Review the authentication details and data mappings.
124
125
- Check for error messages in Segment and Reddit Ads (Audiences).
0 commit comments