Rakuten Advertising is an affiliate marketing platform that connects advertisers with publishers to drive sales through performance-based partnerships.

This tap extracts data from multiple Rakuten Advertising APIs, organized into three groups: the Core API (advertisers, events, partnerships, offers, coupons, product search, link locator data, and more), the Advanced Reports API (payment history, advertiser payments, and payment details), and the Reporting Platform (custom reports). Incremental replication is supported for transaction-based streams (events, publisher contributed conversions), while reference data streams use full-table replication.

Prerequisites

To connect Rakuten Advertising, you need a Rakuten Advertising account with API access. Depending on which streams you want to sync, you may need up to three separate credentials as described below.

Bearer Token (auth_token) — Required

The Bearer token is the primary credential and is required for all core streams (advertisers, events, advertiser_search, partnerships, publisher_contributed_conversions, offers, commissioning_lists, coupons, product_search, text_links, banner_links, drm_links, creative_categories).

To obtain a Bearer token:

1. Log in to your Rakuten Advertising account.
2. Navigate to developers.rakutenadvertising.com.
3. Go to Manage > Applications and create a new application (or use an existing one).
4. Once the application is created, use the authorization flow to generate a Bearer token.
5. Copy the token — this is your auth_token.

You can optionally configure a start_date (ISO 8601 format, e.g. 2024-01-01T00:00:00Z) to control how far back incremental streams sync. If not set, it defaults to 6 months ago.

Security Token (security_token) — Optional, for Advanced Reports

The Security Token is a separate credential from the Bearer token. It is required only if you want to sync the Advanced Reports streams: advanced_reports_payment_history, advanced_reports_advertiser_payments_v1, advanced_reports_payment_details_v1, advanced_reports_advertiser_payments_v2, and advanced_reports_payment_details_v2.

To obtain the Security Token:

1. Log in to the Rakuten Advertising publisher dashboard.
2. Navigate to Reports > Advanced Reports.
3. Your Security Token is displayed on the Advanced Reports page, or can be found in the Advanced Reports API URL.
4. Copy the token — this is your security_token.

Additional optional settings for Advanced Reports:

• advanced_reports_pay_id — Payment ID, required for advertiser payments streams (report IDs 2 and 22). Retrieve this from the payment history summary report.
• advanced_reports_invoice_id — Invoice ID, required for payment details streams (report IDs 3 and 23). Retrieve this from the advertiser payments report.
• advanced_reports_network_id — Optional network ID filter (valid values: 1, 3, 5, 41).

Reporting Platform (reporting_api_token & reporting_report_keys) — Optional, for Custom Reports

The Reporting Platform allows you to sync custom reports you have built in Rakuten Advertising. Each report key you configure becomes a separate stream. Both reporting_api_token and reporting_report_keys are required to enable these streams.

Step 1: Create a report

1. Log in to your Rakuten Advertising account.
2. Go to Reports > Reporting.
3. Click Build a new report. If you have an existing report, select it from the Choose Report dropdown menu.
4. Click Add and Remove Columns and select the columns you want to include in your report.
5. In the Convert Currency to... dropdown menu, select Do Not Convert.
6. Click Save to save the report.

Step 2: Find report key and API token

1. In your Rakuten Advertising account, open the report you created in Step 1.
2. Click the dropdown menu next to the View report option and select Get API.
3. Find your report key and API token in the API URL. The URL has the following format:

ran-reporting.rakutenmarketing.com/{region}/reports/{REPORT-KEY}/filters?date_range=this-month&include_summary=Y&tz=GMT&date_type=transaction&token={API-TOKEN}

1. Copy the {REPORT-KEY} — this is your reporting_report_keys value.
2. Copy the {API-TOKEN} — this is your reporting_api_token value.

To sync multiple reports, enter the report keys as comma-separated values (e.g. sales-and-activity-report,offer-report,product-success-report). Each key becomes a separate stream named reporting_{report_key}.

Additional optional settings for the Reporting Platform:

• reporting_region — Region code for the API (default: en).
• reporting_date_type — Date type for reports, one of transaction or process (default: transaction).

Settings

Reporting Platform API Token

API token for the Rakuten Reporting Platform (ran-reporting.rakutenmarketing.com). Found in the report URL under the token= parameter. Required for reporting_* streams.

Reporting Platform Report Keys

Comma-separated report keys for the Reporting Platform (e.g. revenue-report-by-day,sales-and-activity-report). Each key becomes a separate stream.

Start Date

Earliest date to sync data. ISO 8601 format, e.g. 2025-01-01T00:00:00Z. Used as the custom date range start when set; otherwise defaults to last 30 days.

Reporting Platform Region

Region code for the Reporting Platform API.

Reporting Platform Date Type

Date type for Reporting Platform reports. One of transaction, process.