Skip to content

Commit e53b64a

Browse files
committed
Merge branch 'develop' of https://github.com/samir-moloco/segment-docs into develop
2 parents c06a1af + 90f7a88 commit e53b64a

File tree

1 file changed

+39
-89
lines changed
  • src/connections/destinations/catalog/actions-moloco-rmp

1 file changed

+39
-89
lines changed
Lines changed: 39 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,56 @@
11
---
22
title: Moloco Commerce Media Destination
3+
id: 65f05e455b125cddd886b793
34
beta: true
5+
private: true
46
---
57

6-
[Moloco Commerce Media](https://www.moloco.com/products/moloco-retail-media-platform) (MCM) is a technology solution that empowers marketplaces and online retailers to build and scale a retail media business (i.e., sponsored ads). Moloco’s solution helps platforms leverage and activate their first-party data to deliver highly relevant and performant ads, automate ad decision-making, and scale their ads business.
8+
[Moloco Commerce Media](https://www.moloco.com/products/moloco-retail-media-platform){:target="_blank”} (MCM) is a technology solution that empowers marketplaces and online retailers to build and scale a retail media business (for example, sponsored ads). Moloco’s solution helps platforms leverage and activate their first-party data to deliver highly relevant and performant ads, automate ad decision-making, and scale their ads business.
79

8-
This Moloco Commerce Media destination can send user events collected using the Segment SDK to Moloco’s platform for simplified performance ads integration.
10+
The Moloco Commerce Media destination can send user events collected using the Segment SDK to Moloco’s platform for a simplified performance ads integration.
911

1012
This allows you to run performance advertising without having to build your own backend system to ingest and send user events data in realtime to Moloco.
1113

12-
## Getting Started
14+
## Getting started
1315

14-
Before you configure the Moloco Commerce Media destination, make sure that your source data is configured correctly and that you are able to see events flowing in the event stream debugger.
16+
### Prerequisites
17+
Before you configure the Moloco Commerce Media destination, add a source to Segment and use the [Source Debugger](/docs/connections/sources/debugger/) to verify Segment is receiving events.
1518

16-
To configure the Moloco Commerce Media destination, you need to get the following 2 elements from your Moloco representative.
19+
Before you configure the Moloco Commerce Media destination, reach out to your Moloco representative about the following account information:
20+
- Moloco Platform ID
21+
- Moloco Event Service API key
1722

18-
1. Moloco Platform ID
19-
2. Moloco Event Service API key
23+
After you obtain that account information, you can move on to the Segment app.
2024

21-
Once you obtain those 2 pieces of information, you can move on to the Segment console.
22-
23-
1. From the Segment web console, click Catalog.
24-
2. On the Catalog page, from the destination tab, Search for “Moloco”, select it, and click on Add destination.
25+
### Set up your Moloco destination
26+
1. From the Segment web console, click **Catalog**.
27+
2. On the Catalog page, search for “Moloco”, select it, and click **Add destination**.
2528
3. Choose which of your sources to connect the destination to.
26-
4. In the Moloco MCM destination settings page, fill the Platform ID and API key fields with the previously collected information and select “APP or SITE” depending on your source endpoint (mobile or website).
29+
4. In the Moloco MCM destination settings page, fill the Platform ID and API key fields with your Moloco Platform ID and Event Service API key.
30+
5. Select “APP" if your source endpoint is a mobile app, and "SITE" if it is a website.
2731

2832
## Identify
2933

30-
We strongly recommend that you identify your logged-in users using the [Identify method provided by Segment](https://segment.com/docs/connections/spec/identify/). We also recommended hashing the user ID before sending.
34+
Moloco strongly recommends that you identify your logged-in users using Segment's [Identify method](/docs/connections/spec/identify/) and that you hash the user ID before sending it to Moloco.
3135

32-
Please find below an example call to identify:
36+
Please find an example Identify call below:
3337

3438
```js
3539
analytics.identify('361b1fdfbeaa9d64a13c033eb9f970dc6740f6bc', {
3640
3741
});
3842
```
3943

40-
Once a user is identified, each call to the [Track method](https://segment.com/docs/connections/spec/track/) will automatically record the user ID.
41-
For non logged-in users, you can still track them using an [anonymous ID](https://segment.com/docs/connections/spec/identify/#anonymous-id) (something like UUID as recommended by Segment) but on the Moloco Commerce Media side, we do not use that field for non logged-in users.
42-
43-
_Note_: if you decided to hash the user ID before sending it to Moloco for event tracking, please make sure you reuse the same hashed ID when calling other Moloco’s APIs like Decision API.
44-
45-
## Moloco Commerce Media’s available presets
46-
47-
MCM currently supports the following [user event data specifications](https://mcm-docs.moloco.com/docs/51-user-event-data-specifications).
48-
49-
<table>
50-
<tr>
51-
<td>**Event type**</td>
52-
<td>**Trigger**</td>
53-
<td>**Description**</td>
54-
</tr>
55-
<tr>
56-
<td>HOME</td>
57-
<td>Event type = "page" AND event = "Home"</td>
58-
<td>HOME event type is when a shopper views your website's main or home page.</td>
59-
</tr>
60-
<tr>
61-
<td>LAND</td>
62-
<td>Event type = "page" AND event = "Land"</td>
63-
<td>LAND event type is when a shopper is visiting your website from an external source (ex. Google Shopping)</td>
64-
</tr>
65-
<tr>
66-
<td>ITEM_PAGE_VIEW</td>
67-
<td>Event type = "track" AND event = "Product Viewed"</td>
68-
<td>ITEM_PAGE_VIEW event type is when a shopper visits a product detail page.</td>
69-
</tr>
70-
<tr>
71-
<td>ADD_TO_CART</td>
72-
<td>Event type = "track" AND event = "Product Added"</td>
73-
<td>ADD_TO_CART event type is when a shopper adds an item to the cart.</td>
74-
</tr>
75-
<tr>
76-
<td>ADD_TO_WISHLIST</td>
77-
<td>Event type = "track" AND event = "Product Added to Wishlist"</td>
78-
<td>ADD_TO_WISHLIST event type is when a shopper puts an item into the wish list.</td>
79-
</tr>
80-
<tr>
81-
<td>SEARCH</td>
82-
<td>Event type = "track" AND event = "Product Searched"</td>
83-
<td>SEARCH event type is when a shopper searches items with keywords or phrases from your site.</td>
84-
</tr>
85-
<tr>
86-
<td>PAGE_VIEW</td>
87-
<td>Event type = "page" AND event != "Home"</td>
88-
<td>PAGE_VIEW event type is when a shopper visits a page other than the product detail pages or the homepage of your site.</td>
89-
</tr>
90-
<tr>
91-
<td>PURCHASE</td>
92-
<td>Event type = "track" AND event = "Order Completed"</td>
93-
<td>PURCHASE event type is when a shopper purchases a product.</td>
94-
</tr>
95-
</table>
44+
Once a user is identified, each call to Segment's [Track method](/docs/connections/spec/track/) automatically records the user ID.
45+
Users that are not logged in can be tracked using an [anonymousID](/docs/connections/spec/identify/#anonymous-id). Moloco Commerce Media does not use anonymousIDs for users that are not logged in. Segment recommends formatting your anonymousID in UUID format.
46+
47+
> info" "
48+
> If you hash the user ID before sending it to Moloco, ensure you reuse the same hashed ID when calling other Moloco APIs.
49+
9650

9751
## Track
9852

99-
If you’re not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. The mappings in the Moloco Commerce Media destination are pre-built based on the [Segment’s Ecommerce Events](https://segment.com/docs/connections/spec/ecommerce/v2/).
53+
If you’re not familiar with the Segment Spec, take a look to understand what the [Track method](/docs/connections/spec/track/) does. The mappings in the Moloco Commerce Media destination are built based on the Segment [Ecommerce Spec](/docs/connections/spec/ecommerce/v2/).
10054

10155
Please find below an example call to track a product detail page (PDP) view event:
10256

@@ -107,21 +61,21 @@ analytics.track("Product Viewed", {
10761
price: 19.99
10862
currency: "USD"
10963
quantity: 1,
110-
image_url: "https://www.example.com/iamge.png"
64+
image_url: "https://www.example.com/image.png"
11165
});
11266
```
11367

11468
## Page
11569

116-
If you’re not familiar with the Segment Specs, take a look to understand what the [Page method](https://segment.com/docs/connections/spec/page/) does.
70+
If you’re not familiar with the Segment Spec, take a look to understand what the [Page method](/docs/connections/spec/page/) does.
11771

11872
Please find below an example call to page:
11973

12074
```js
12175
analytics.page();
12276
```
12377

124-
If you are using the Segment’s Web SDK, this call will automatically collect the page information. Here’s an example of page info automatically collected using the Segment’s Web SDK.
78+
If you use Segment’s Web SDK, this call automatically collects the page information. Here’s an example of page information automatically collected using Segment’s Web SDK.
12579

12680
```js
12781
"page": {
@@ -135,14 +89,14 @@ If you are using the Segment’s Web SDK, this call will automatically collect t
13589

13690
However for iOS and Android, it won’t collect page information.
13791

138-
In Moloco Commercial Media, the [page_id](https://mcm-docs.moloco.com/docs/51-user-event-data-specifications#page_view-event-type) attribute is required for the PAGE_VIEW event. Using the Web SDK, the page_id can be associated with the path attribute. However for iOS/Android, as we do not have an appropriate field for page_id, we recommend using the **Page Identifier Token** field.
92+
Moloco Commercial Media requires the [page_id](https://mcm-docs.moloco.com/docs/51-user-event-data-specifications#page_view-event-type){:target="_blank”} attribute for a PAGE_VIEW event. Using the Web SDK, the page_id can be associated with the path attribute. However for iOS/Android, Moloco Commercial Media recommends using the Page Identifier Token field.
13993

140-
This field accepts key:value pairs of strings that can identify the page.
94+
The Page Identifier Token field accepts key:value pairs of strings that can identify the page.
14195
Stringification Logic is: {key}:{value}s concatenated by ";"
14296

143-
As page_id has a higher priority, **Page Identifier Token** will be ignored if page_id is passed
97+
Moloco Commercial Media ignores the Page Identifier Token if page_id is passed, as page_id has a higher priority.
14498

145-
Here’s an example of **Page Identifier Token** that could be tracked in a mobile app.
99+
Here’s an example of a Page Identifier Token that could be tracked in a mobile app.
146100

147101
Say the input had the following schema:
148102

@@ -165,30 +119,26 @@ and user chose the following mapping:
165119
// "Which action happened on which vertical"
166120
```
167121

168-
The tokens be stringified into:
122+
The tokens are stringified into the following:
169123

170124
```js
171125
"event:Product List Viewed;vertical:fruit"
172126
```
173127

174-
Logic:
128+
The tokens are stringified in the format of the above example because they are key-value pairs concatenated by a semicolon (;).
175129

176-
```js
177-
{key}:{value} concatenated by ";"
178-
```
179-
180-
_Note_: if you decided to use the **Page Identifier Token** in your mobile app, please make sure you reuse the same **Page Identifier Token** in place of page_id when calling other Moloco’s APIs like Decision API.
130+
> info " "
131+
> if you decide to use the Page Identifier Token in your mobile app, reuse the same Page Identifier Token in place of page_id when calling Moloco’s APIs.
181132
182133
## Mappings
183134

184-
In the mappings tab, some fields are chosen by default if some common fields map to Moloco Event’s fields. If the mapped key does not exist in the input data, it won’t trigger an error and will just not pass any value.
135+
In the Mappings tab, some fields are chosen by default if some common fields map to Moloco Event’s fields. If the mapped key does not exist in the input data, it won’t trigger an error. Instead, the mapping will not pass any value.
185136

186137
If you are using **the default fields in a custom way**, please confirm that your mapping meets Moloco's requirements.
187138

188139
Default Mappings are not hard rules. They can be modified to your convenience.
189140

141+
{% include components/actions-fields.html %}
190142
## Monitoring
191143

192-
Once the mappings are configured correctly, you can verify the flow of events from your source to Moloco’s destination in the “**Delivery Overview**” tab. If things are configured correctly, it should show a growing **Successful delivery** count.
193-
194-
For more details about the monitoring tool, take a look at the [Delivery Overview](https://segment.com/docs/connections/delivery-overview/) docs.
144+
Once the mappings are configured correctly, you can verify the flow of events from your source to Moloco’s destination in the [Delivery Overview](/docs/connections/delivery-overview/) tab of your Moloco destination. If you correctly configured your destination, you should see a growing **Successful delivery** count.

0 commit comments

Comments
 (0)