Skip to content

Commit 67d7e1e

Browse files
stayseesongstayseesong
authored
Merge pull request #5316 from segmentio/feature/rokt-destination-public-beta-support
Rokt Audiences (Actions) Destination docs
2 parents 2c87c01 + 18220ea commit 67d7e1e

File tree

2 files changed

+234
-0
lines changed

2 files changed

+234
-0
lines changed

‎src/_data/catalog/destinations_private.yml

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -838,6 +838,168 @@ items:
838838
dynamic: false
839839
allowNull: false
840840
presets: []
841+
- id: 643697130067c2f408ff28ca
842+
display_name: Rokt Audiences (Actions)
843+
name: Rokt Audiences (Actions)
844+
slug: rokt-audiences-actions
845+
previous_names:
846+
- Rokt Audiences (Actions)
847+
url: connections/destinations/catalog/rokt-audiences-actions
848+
website: http://www.segment.com
849+
status: PRIVATE_BETA
850+
logo:
851+
url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
852+
mark:
853+
url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
854+
methods:
855+
track: true
856+
identify: true
857+
group: true
858+
alias: true
859+
screen: false
860+
page: true
861+
platforms:
862+
browser: true
863+
mobile: false
864+
server: true
865+
warehouse: false
866+
components: []
867+
browserUnbundlingSupported: false
868+
browserUnbundlingPublic: false
869+
replay: false
870+
settings:
871+
- name: apiKey
872+
type: password
873+
defaultValue: ''
874+
description: >-
875+
APIKey used for Rokt API authorization before sending custom audiences
876+
data
877+
required: true
878+
label: API Key provided by Rokt integration
879+
actions:
880+
- id: oNpU37CaJbuxq7PqBGEYz4
881+
name: Sync Engage Audience to Rokt
882+
slug: upsertCustomAudiences
883+
description: >-
884+
Add/Remove users from Rokt custom audience list. Both identify() and
885+
track() calls are supported
886+
platform: CLOUD
887+
hidden: false
888+
defaultTrigger: type = "track" or type = "identify"
889+
fields:
890+
- id: hkunPAdr3JHSMDGCW8Hr7P
891+
sortOrder: 0
892+
fieldKey: custom_audience_name
893+
label: Custom Audience Name
894+
type: STRING
895+
description: Name of custom audience list to which emails should added/removed
896+
placeholder: ''
897+
defaultValue:
898+
'@path': $.context.personas.computation_key
899+
required: true
900+
multiple: false
901+
choices: null
902+
dynamic: false
903+
allowNull: false
904+
- id: k8zCN8YH12e6N9EqeTbK3m
905+
sortOrder: 1
906+
fieldKey: segment_computation_action
907+
label: Segment Computation Action
908+
type: STRING
909+
description: >-
910+
Segment computation class used to determine if action is an
911+
'Engage-Audience'
912+
placeholder: ''
913+
defaultValue:
914+
'@path': $.context.personas.computation_class
915+
required: true
916+
multiple: false
917+
choices: null
918+
dynamic: false
919+
allowNull: false
920+
- id: 4rPpCohUqos6N47caU35ct
921+
sortOrder: 2
922+
fieldKey: email
923+
label: Email
924+
type: STRING
925+
description: User's email address for including/excluding from custom audience
926+
placeholder: ''
927+
defaultValue:
928+
'@if':
929+
exists:
930+
'@path': $.context.traits.email
931+
then:
932+
'@path': $.context.traits.email
933+
else:
934+
'@path': $.traits.email
935+
required: true
936+
multiple: false
937+
choices: null
938+
dynamic: false
939+
allowNull: false
940+
- id: ab4jivj6fXuTQ4TM68JERi
941+
sortOrder: 3
942+
fieldKey: traits_or_props
943+
label: traits or properties object
944+
type: OBJECT
945+
description: >-
946+
Object which will be computed differently for track and identify
947+
events
948+
placeholder: ''
949+
defaultValue:
950+
'@if':
951+
exists:
952+
'@path': $.properties
953+
then:
954+
'@path': $.properties
955+
else:
956+
'@path': $.traits
957+
required: true
958+
multiple: false
959+
choices: null
960+
dynamic: false
961+
allowNull: false
962+
- id: vH5iWCWZpV15WjgDFTnCXd
963+
sortOrder: 4
964+
fieldKey: enable_batching
965+
label: enable batching to rokt api
966+
type: BOOLEAN
967+
description: >-
968+
Set as true to ensure Segment infrastructure uses batching when
969+
possible.
970+
placeholder: ''
971+
defaultValue: true
972+
required: false
973+
multiple: false
974+
choices: null
975+
dynamic: false
976+
allowNull: false
977+
presets:
978+
- actionId: oNpU37CaJbuxq7PqBGEYz4
979+
name: Sync Engage Audience to Rokt
980+
fields:
981+
custom_audience_name:
982+
'@path': $.context.personas.computation_key
983+
segment_computation_action:
984+
'@path': $.context.personas.computation_class
985+
email:
986+
'@if':
987+
exists:
988+
'@path': $.context.traits.email
989+
then:
990+
'@path': $.context.traits.email
991+
else:
992+
'@path': $.traits.email
993+
traits_or_props:
994+
'@if':
995+
exists:
996+
'@path': $.properties
997+
then:
998+
'@path': $.properties
999+
else:
1000+
'@path': $.traits
1001+
enable_batching: true
1002+
trigger: type = "track" or type = "identify"
8411003
- id: 643fdf094cfdbcf1bcccbc42
8421004
display_name: Usermaven (Actions)
8431005
name: Usermaven (Actions)

‎src/connections/destinations/catalog/action-rokt-audiences/index.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Rokt Audiences (Actions) Destination
3+
hide-personas-partial: true
4+
hide-boilerplate: true
5+
hide-dossier: false
6+
private: true
7+
hidden: true
8+
beta: true
9+
id: 643697130067c2f408ff28ca
10+
redirect_from:
11+
- "/connections/destinations/catalog/actions-rokt-audiences"
12+
---
13+
{% include content/plan-grid.md name="actions" %}
14+
15+
Rokt Audiences (Actions) destination enables advertisers to send Segment Persona Audiences to Rokt using Rokt's Audience API.
16+
17+
By using Segment's Persona Audiences with Rokt, you can increase the efficiency of your ad campaigns through suppression and targeting of existing or new customers.
18+
19+
## Benefits of Rokt Audiences (Actions)
20+
21+
Benefits of the Rokt Audiences (Actions) destination include:
22+
- **Improved email matching**: This integration creates a direct connection between Segment and Rokt for a 100% match rate of email identifiers.
23+
24+
- **Easy setup**: This destination only requires your Advertiser API key.
25+
26+
- **Batching events and support for large audiences**: This destination supports batching which enables Rokt to receive large audiences without discrepancies.
27+
28+
- **Near real-time audience updates**: The actions destination helps Rokt receive real-time events and add or remove users from Rokt audiences appropriately.
29+
30+
## Getting started
31+
32+
### Prerequisites:
33+
34+
Before connecting to the Rokt Audiences destination, you must have an account with Rokt and receive your API key.
35+
36+
### Add the destination:
37+
To add the Rokt Audiences (Actions) destination:
38+
39+
1. From your Segment workspace, go to **Connections > Catalog** and select the **Destinations** tab of the catalog.
40+
41+
2. Search for **Rokt Audiences (Actions)** and select the destination.
42+
43+
3. Click **Add destination**.
44+
45+
4. Select the space in Engage to use as the Source as this destination only supports sending Engage Audiences to Rokt.
46+
47+
5. On the **Settings** tab, enter the name of your destination. For example, `Rokt audiences – <audience name>`.
48+
49+
6. Enter your Rokt **API key**.
50+
51+
7. Click **Save Changes**.
52+
53+
8. In the **Mappings** tab, click **+ New Mapping** and select **Add Users to Audience**. Don't change any defaults.
54+
55+
9. Under the **Configure actions fields**, set **Enable Batching** to *Yes* and click **Save**.
56+
57+
7. Repeat steps 8 and 9 for **Remove Users from Audience**.
58+
59+
8. **Enable** both mappings.
60+
61+
9. Go to the **Settings** tab and select the toggle to **Enable** the destination.
62+
63+
10. Select your space, and navigate to **Engage > Audiences**. Select the source audience that you want to send to your Rokt Audiences (Actions) destination.
64+
65+
11. Click **Add Destinations** and select the Rokt Audience (Actions) destination you created. In the settings that appear on the right-hand side, toggle the **Send Track** option on and **Send Identify**. Click **Save**.
66+
67+
Your Rokt Audiences (Actions) destination is now ready to receive audiences, and your Persona audiences are now accessible in your Rokt Advertiser dashboard. Keep in mind that it can take 12-24 hours for the first sync when the number of email identifies are in the millions.
68+
69+
> warning ""
70+
> You can only connect **one** Engage audience to a single instance of the Rokt Audience (Actions) destination. If you have multiple audiences, repeat the above process to create a new Rokt Audience (Actions) destination and connect the audience to a new destination each time.
71+
72+
{% include components/actions-fields.html %}

0 commit comments

Comments
 (0)