Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
Warehouse Sync API Overview
Warehouse Sync API Tutorial
Warehouse Sync API Reference
Data Mapping
Warehouse Sync SQL Reference
Warehouse Sync Troubleshooting Guide
ComposeID
Warehouse Sync API v2 Migration
Calculated Attributes Seeding API
Bulk Profile Deletion API Reference
Group Identity API Reference
Custom Access Roles API
Data Planning API
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
AMP SDK
Initialization
Configuration
Network Security Configuration
Event Tracking
User Attributes
IDSync
Screen Events
Commerce Events
Location Tracking
Media
Kits
Application State and Session Management
Data Privacy Controls
Error Tracking
Opt Out
Push Notifications
WebView Integration
Logger
Preventing Blocked HTTP Traffic with CNAME
Linting Data Plans
Troubleshooting the Android SDK
API Reference
Upgrade to Version 5
Cordova Plugin
Identity
Direct URL Routing FAQ
Web
Android
iOS
Initialization
Configuration
Event Tracking
User Attributes
IDSync
Screen Tracking
Commerce Events
Location Tracking
Media
Kits
Application State and Session Management
Data Privacy Controls
Error Tracking
Opt Out
Push Notifications
Webview Integration
Upload Frequency
App Extensions
Preventing Blocked HTTP Traffic with CNAME
Linting Data Plans
Troubleshooting iOS SDK
Social Networks
iOS 14 Guide
iOS 15 FAQ
iOS 16 FAQ
iOS 17 FAQ
iOS 18 FAQ
API Reference
Upgrade to Version 7
Getting Started
Identity
Upload Frequency
Getting Started
Opt Out
Initialize the SDK
Event Tracking
Commerce Tracking
Error Tracking
Screen Tracking
Identity
Location Tracking
Session Management
Initialization
Configuration
Content Security Policy
Event Tracking
User Attributes
IDSync
Page View Tracking
Commerce Events
Location Tracking
Media
Kits
Application State and Session Management
Data Privacy Controls
Error Tracking
Opt Out
Custom Logger
Persistence
Native Web Views
Self-Hosting
Multiple Instances
Web SDK via Google Tag Manager
Preventing Blocked HTTP Traffic with CNAME
Facebook Instant Articles
Troubleshooting the Web SDK
Browser Compatibility
Linting Data Plans
API Reference
Upgrade to Version 2 of the SDK
Getting Started
Identity
Web
Alexa
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
Overview
Step 1. Create an input
Step 2. Verify your input
Step 3. Set up your output
Step 4. Create a connection
Step 5. Verify your connection
Step 6. Track events
Step 7. Track user data
Step 8. Create a data plan
Step 9. Test your local app
Overview
Step 1. Create an input
Step 2. Verify your input
Step 3. Set up your output
Step 4. Create a connection
Step 5. Verify your connection
Step 6. Track events
Step 7. Track user data
Step 8. Create a data plan
Step 1. Create an input
Step 2. Create an output
Step 3. Verify output
Introduction
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
Data Hosting Locations
Glossary
Migrate from Segment to mParticle
Migrate from Segment to Client-side mParticle
Migrate from Segment to Server-side mParticle
Segment-to-mParticle Migration Reference
Rules Developer Guide
API Credential Management
The Developer's Guided Journey to mParticle
Overview
Overview
User Profiles
Overview
Create and Manage Group Definitions
Calculated Attributes Overview
Using Calculated Attributes
Create with AI Assistance
Calculated Attributes Reference
What are predictive attributes?
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
Usage and Billing Report
Observability Overview
Observability User Guide
Observability Troubleshooting Examples
Observability Span Glossary
The new mParticle Experience
The Overview Map
Event Forwarding
System Alerts
Trends
Introduction
Data Retention
Data Catalog
Connections
Activity
Data Plans
Live Stream
Filters
Rules
Blocked Data Backfill Guide
Tiered Events
mParticle Users and Roles
Analytics Free Trial
Troubleshooting mParticle
Usage metering for value-based pricing (VBP)
Audiences Overview
Create an Audience
Connect an Audience
Manage Audiences
Real-time Audiences (Legacy)
Standard Audiences (Legacy)
Predictive Audiences Overview
Using Predictive Audiences
IDSync Overview
Use Cases for IDSync
Components of IDSync
Store and Organize User Data
Identify Users
Default IDSync Configuration
Profile Conversion Strategy
Profile Link Strategy
Profile Isolation Strategy
Best Match Strategy
Aliasing
Introduction
Core Analytics
Sync and Activate Analytics User Segments in mParticle
User Segment Activation
Welcome Page Announcements
Project Settings
Roles and Teammates
Organization Settings
Global Project Filters
Portfolio Analytics
Analytics Data Manager Overview
Events
Event Properties
User Properties
Revenue Mapping
Export Data
UTM Guide
Analyses Introduction
Getting Started
Visualization Options
For Clauses
Date Range and Time Settings
Calculator
Numerical Settings
Assisted Analysis
Properties Explorer
Frequency in Segmentation
Trends in Segmentation
Did [not] Perform Clauses
Cumulative vs. Non-Cumulative Analysis in Segmentation
Total Count of vs. Users Who Performed
Save Your Segmentation Analysis
Export Results in Segmentation
Explore Users from Segmentation
Getting Started with Funnels
Group By Settings
Conversion Window
Tracking Properties
Date Range and Time Settings
Visualization Options
Interpreting a Funnel Analysis
Group By
Filters
Conversion over Time
Conversion Order
Trends
Funnel Direction
Multi-path Funnels
Analyze as Cohort from Funnel
Save a Funnel Analysis
Explore Users from a Funnel
Export Results from a Funnel
Saved Analyses
Manage Analyses in Dashboards
Data Dictionary
Query Builder Overview
Modify Filters With And/Or Clauses
Query-time Sampling
Query Notes
Filter Where Clauses
Event vs. User Properties
Group By Clauses
Annotations
Cross-tool Compatibility
Apply All for Filter Where Clauses
Date Range and Time Settings Overview
User Attributes at Event Time
Understanding the Screen View Event
User Aliasing
Dashboards––Getting Started
Manage Dashboards
Organize Dashboards
Dashboard Filters
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
The Demo Environment
Keyboard Shortcuts
User Segments
Warehouse Sync
Data Privacy Controls
Data Subject Requests
Default Service Limits
Feeds
Cross-Account Audience Sharing
Approved Sub-Processors
Import Data with CSV Files
CSV File Reference
Glossary
Video Index
Single Sign-On (SSO)
Setup Examples
Introduction
Introduction
Introduction
Rudderstack
Google Tag Manager
Segment
Advanced Data Warehouse Settings
AWS Kinesis (Snowplow)
AWS Redshift (Define Your Own Schema)
AWS S3 (Snowplow Schema)
AWS S3 Integration (Define Your Own Schema)
BigQuery (Snowplow Schema)
BigQuery Firebase Schema
BigQuery (Define Your Own Schema)
GCP BigQuery Export
Snowflake (Snowplow Schema)
Snowplow Schema Overview
Snowflake (Define Your Own Schema)
Aliasing
Event
Event
Audience
Feed
Audience
Event
Audience
Cookie Sync
Server-to-Server Events
Platform SDK Events
Audience
Audience
Audience
Feed
Event
Event
Event
Audience
Event
Data Warehouse
Event
Event
Audience
Event
Event
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Audience
Feed
Event
Event
Event
Custom Feed
Data Warehouse
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Event
Audience
Event
Event
Audience
Data Warehouse
Event
Cookie Sync
Audience
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Event
Audience
Event
Event
Audience
Event
Event
Event
Feed
Audience
Event
Event
Audience
Audience
Event
Audience
Audience
Audience
Audience
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Feed
Event
Audience
Event
Event
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Audience
Event
Audience
Feed
Loyalty Feed
Audience
Audience
Event
Audience
Audience
Feed
Audience
Cookie Sync
Event
Audience
Event
Event
Audience
Event
Event
Audience
Event
Event
Audience
Cookie Sync
Feed
Audience
Cookie Sync
Audience
Event
Rakuten Advertising delivers cutting-edge marketing and advertising solutions that harness advanced data and insights to connect brands with engaged audiences worldwide. Their comprehensive suite of affiliate, display, and search offerings empowers marketers to drive conversions, build lasting customer relationships, and accelerate business growth.
This integration requires some set-up before integrating with mParticle. These steps come directly from Rakuten’s documentation and any questions here will likely be best answered by them.
Publisher links in Rakuten Affiliate will typically direct users to a gateway page. While a gateway page isn’t strictly required, the functionality is, e.g., every page on your site could perform the functions of the gateway page.
The gateway page has two functions. The first is to set a cookie and the second is to redirect users to another site if Rakuten Affiliate passes to the gateway page the parameter url. For more detailed implementation info, please ask your Implementation Specialist for Entry Gateway Page Function Implementation Guidelines.
Incoming HTTP requests to the gateway page may or may not include a url value:
http://www.yoursite.com/rakuten?siteID=1KW2Xiq9xN0-4.c_9w1X8XpO94TU14hg3D&ranMID=1234&ranEAID=1KW2Xiq9xN0&ranSiteID=1KW2Xiq9xN0-4.c_9w1X8XpO94TU14hg3Dhttp://www.yoursite.com/cgi-bin/rakuten?siteID=1KW2Xiq9xN0-4.c_9w1X8XpO94TU14hg3D&url=http%3A//www.yoursite.com/anotherpage.htm%3FranMID%3D1234%26ranEAID%3D1KW2Xiq9xN0%26ranSiteID%3D1KW2Xiq9xN0-4.c_9w1X8XpO94TU14hg3DYou will set a persistent server-side cookie (rmStoreGateway) on your web server using the Set-Cookie HTTP response header mapping values to cookie key-value pairs in the following table:
Note: These cookies will be required when sending data to mParticle
| Name | Cookie Key | Source | Example Value |
|---|---|---|---|
| Merchant ID | amid | ranMID query string parameter | 1234 |
| Tracking ID | atrv | ranSiteID query string parameter | 1KW2Xiq9xN0-4.c_9w1X8XpO94TU14hg3D |
| UTC Landing Timestamp | ald | Generated by you | 20240101_1446 |
The cookie you set should expire two years from the current date. Set or overwrite a new cookie every time a user enters the gateway page with a ranSiteID value in the query string. There is no need to retrieve values from cookies that may have been set during prior visits. The last click to refer a user to your site identifies the publisher who receives the commission.
When a user comes to the gateway page, in addition to checking for ranSiteID also check for a url value. If a url value exists, redirect the user to that site. If no url value exists, redirect the user to your home page. In redirecting users, do not pass the ranSiteID value from page to page.
For the incoming HTTP request examples from the previous section, Rakuten is the gateway page that you will build. All Rakuten affiliate-referred traffic will be directed to this page. Inform your Rakuten Implementation Specialist what you would like to call the gateway page. In the second example, the url parameter contains the URL-encoded http://www.yoursite.com/anotherpage.htm with the Rakuten Affiliate parameters ranMID, ranEAID, and ranSiteID.
When an order checkout is complete, two additional fields need to be recorded to your database: the ranSiteID value and the date-time entered. The database fields may be defined as:
| Name | Type |
|---|---|
| ranSiteId | VarChar(255) |
| date-time entered | Date |
These values can be retrieved from the cookie set by the gateway page in Step 1. Next, match the ranSiteID and date-time entered information with the order information.
Once you have set-up and can use these cookie values, you may use them to leverage mParticle’s Rakuten integration.
The mParticle event integration for Rakuten supports connections with the following inputs:
mParticle can forward the following user identities to Rokt:
| mParticle Field | Type | Rakuten Field | Required |
|---|---|---|---|
| Merchant ID | Config Setting | mid | True |
| transaction_id | Transaction Field | ord | True |
| Rakuten.Tr | Custom Flag | tr | True |
| Rakuten.Land | Custom Flag | land | True |
| timestamp_unixtime_ms | Event Attribute | date | True |
| mParticle Field | Type | Rakuten Field | Required |
|---|---|---|---|
| Price * Quantity | Product Attributes | amtlist | True |
| ID | Product Attribute | skulist | True |
| Quantity | Product Attribute | qlist | True |
| Name | Product Attribute | namelist | True |
| Brand | Product Attribute | brandlist | False |
| Category | Product Attribute | catlist | False |
| Coupon Code | Product Attribute | couponlist | False |
| Currency Code | Product Attribute | cur | True |
| Custom Attribute Field | Type | Rakuten Field |
|---|---|---|
| altord | Custom Event Attribute | altord |
| catidlist | Custom Event Attribute | catidlist |
| cc | Custom Event Attribute | cc |
| commreason | Custom Event Attribute | commreason |
| coupon | Custom Event Attribute | coupon |
| custscore | Custom Event Attribute | custscore |
| custstatus | Custom Event Attribute | custstatus |
| disamt | Custom Event Attribute | disamt |
| disamtlist | Custom Event Attribute | disamtlist |
| distypelist | Custom Event Attribute | distypelist |
| isclearancelist | Custom Event Attribute | isclearancelist |
| iscomm | Custom Event Attribute | iscomm |
| ismarketplacelist | Custom Event Attribute | ismarketplacelist |
| issalelist | Custom Event Attribute | issalelist |
| Itmstatuslist | Custom Event Attribute | Itmstatuslist |
| marginlist | Custom Event Attribute | marginlist |
| markdownlist | Custom Event Attribute | markdownlist |
| ordstatus | Custom Event Attribute | ordstatus |
| segment | Custom Event Attribute | segment |
| sequencelist | Custom Event Attribute | sequencelist |
| shipbylist | Custom Event Attribute | shipbylist |
| shipcountry | Custom Event Attribute | shipcountry |
| shipidlist | Custom Event Attribute | shipidlist |
| shipped | Custom Event Attribute | shipped |
| sitename | Custom Event Attribute | sitename |
| storecat | Custom Event Attribute | storecat |
| storeid | Custom Event Attribute | storeid |
| taxexemptlist | Custom Event Attribute | taxexemptlist |
Rakuten.TrCookie value “atrv” (ranSiteID) set by your gateway page
Rakuten.LandCookie value “ald” (UTC Landing Timestamp) set by your gateway page
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| Rakuten Merchant ID | Integer | Rakuten Merchant ID we’re tracking events on. Same as ranMID used for gateway page. | |
| External User Identity Type | Identity Type Enum | Identity Type to send to Rakuten as Rakuten’s Customer ID |