> ## Documentation Index
> Fetch the complete documentation index at: https://docs.northbeam.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Rakuten Setup

> Add Northbeam link parameters in Rakuten and send Northbeam two scheduled reports so spend and revenue line up.

When you're done, Northbeam shows your Rakuten spend, impressions, visits, and attributed revenue on the same campaigns, publishers, and ads.

<Info>
  **Before you start**, make sure you have:

  * Access to your [Rakuten Advertising Dashboard](https://dashboard.linkshare.com/) to edit link parameters and schedule reports
  * Rakuten reports set to **USD** (if your account isn't in USD, contact Rakuten support to change the report output currency)
  * Access to [Connections](https://dashboard.northbeam.io/settings/connections) in your Northbeam dashboard
</Info>

<span id="setup-steps" style={{ display: "block", scrollMarginTop: "7rem" }} />

<CardGroup cols={3}>
  <Card title="1. Add Northbeam parameters" icon="link" href="#add-northbeam-parameters-to-your-ads">
    Add four link parameters once in Rakuten.
  </Card>

  <Card title="2. Send your reports" icon="plug" href="#send-northbeam-your-rakuten-reports">
    Schedule two daily reports, then turn on the integration.
  </Card>

  <Card title="3. Confirm tracking" icon="circle-check" href="#confirm-tracking">
    Check that parameters and spend are reaching Northbeam.
  </Card>
</CardGroup>

<Steps titleSize="h2">
  <Step title="Add Northbeam parameters to your ads">
    <span id="step-1-insert-click-utms" style={{ display: "block", scrollMarginTop: "7rem" }} />

    <span id="step-1-inserting-click-utms" style={{ display: "block", scrollMarginTop: "7rem" }} />

    Do this first. You'll confirm it's done when you turn on the integration in the next step.

    1. Open your [Rakuten Advertising Dashboard](https://dashboard.linkshare.com/).
    2. In the header, click **Links**, then **Link Parameters**.
    3. Add these four parameters:

    | Parameter type | Parameter name | Parameter value | Mapping in Northbeam |
    | :- | :- | :- | :- |
    | Advertiser | `nb_platform` | `rakuten` | Categorizes traffic under the "Rakuten" channel |
    | Linkshare | `nb_offer_id` | Offer ID *(selected from the Linkshare dropdown)* | Pulls Campaign Names into the Campaign Level of the Sales Page |
    | Linkshare | `nb_publisher_sid` | Publisher SID *(selected from the Linkshare dropdown)* | Pulls Publisher Names into the Adset Level of the Sales Page |
    | Linkshare | `nb_creative_id` | Creative ID *(selected from the Linkshare dropdown)* | Pulls Ad Names into the Adset Level of the Sales Page |

    <Frame caption="Links > Link Parameters">
      <img src="https://mintcdn.com/northbeam/EpMPeQ8Ec2Yrg9EI/images/readme/216ced53-Untitled_design_2.png?fit=max&auto=format&n=EpMPeQ8Ec2Yrg9EI&q=85&s=e89cc238e26a7b7a296e12e07650acee" alt="Rakuten Link Parameters with the four Northbeam parameters added" style={{ maxWidth: "560px", maxHeight: "440px", width: "auto", height: "auto", margin: "0 auto" }} width="2013" height="1085" data-path="images/readme/216ced53-Untitled_design_2.png" />
    </Frame>

    **If you skip this step:** Northbeam can't tie visits and orders to your Rakuten ads, so spend and revenue show up on separate lines.
  </Step>

  <Step title="Send Northbeam your Rakuten reports">
    <span id="step-2-set-up-scheduled-reports" style={{ display: "block", scrollMarginTop: "7rem" }} />

    <span id="step-2-creating-a-scheduled-report" style={{ display: "block", scrollMarginTop: "7rem" }} />

    Northbeam gets your Rakuten campaign and ad names, spend, and impressions from scheduled email reports. Impressions also power Northbeam's view-through modeling. Create **two** reports for full coverage:

    * **This Month**, named `nb_reporting_tm`
    * **Last Month**, named `nb_reporting_lm`

    <Warning>
      **Reports must be in USD.** Northbeam assumes all Rakuten data is in USD. If your Northbeam dashboard uses another currency, Northbeam converts spend with the daily exchange rate, but the conversion will be wrong if your Rakuten reports aren't in USD. If your Rakuten account isn't in USD, contact Rakuten support to change the report output currency.
    </Warning>

    **Get your Northbeam report email**

    1. In Northbeam, open [Connections](https://dashboard.northbeam.io/settings/connections).
    2. Scroll to **Rakuten** and copy the **Email Address**. It looks like `[your_client_id]zzznbzzzrakuten@robot.northbeam.io`.

    <span id="report-1-“this-month”-report-nb_reporting_tm" style={{ display: "block", scrollMarginTop: "7rem" }} />

    <span id="report-1-this-month-report-nb_reporting_tm" style={{ display: "block", scrollMarginTop: "7rem" }} />

    **Report 1: This Month (`nb_reporting_tm`)**

    1. Open your [Rakuten Advertising Dashboard](https://dashboard.linkshare.com/).
    2. In the header, click **Reports > Reporting > Create New Report**.
    3. Add these fields and metrics:
       ```
       # of clicks
       # of impressions
       Offer ID
       Offer Name
       Publisher ID
       Publisher Name
       Publisher Encrypted ID
       Total Commission
       Transaction Date
       Publisher Group ID
       Publisher Group ID Name
       Link ID
       Link Name
       ```
    4. Click **Save Report** and name it `nb_reporting_tm`.
    5. Click **Manage Report > Schedule Report**.
    6. Set these fields:
       * **Date Range:** This Month
       * **Time Zone:** (GMT+00:00) GMT
       * **Date Type:** Transaction Date
       * Uncheck **Include Summary**
       * **Schedule Time:** Daily, with the hour set anywhere between 10AM and 6PM
       * Check **Deliver report to Email** and paste the email address you copied from Northbeam
    7. Click **Set Scheduling**.

    <span id="report-2-“last-month”-report-nb_reporting_lm" style={{ display: "block", scrollMarginTop: "7rem" }} />

    **Report 2: Last Month (`nb_reporting_lm`)**

    Repeat the steps above with two changes. Everything else stays the same.

    * **Report name:** `nb_reporting_lm`
    * **Date Range:** Last Month

    <span id="step-3-enable-rakuten-integration" style={{ display: "block", scrollMarginTop: "7rem" }} />

    **Turn on the integration**

    1. Open [Connections](https://dashboard.northbeam.io/settings/connections) and scroll to **Rakuten**.
    2. Check the boxes to confirm you've set up **Click UTMs** and **Scheduled Report**.
    3. Click **Connect**.

    <Frame>
      <img src="https://mintcdn.com/northbeam/EpMPeQ8Ec2Yrg9EI/images/readme/a49addf7-Screen_Shot_2024-12-31_at_2.19.18_PM.png?fit=max&auto=format&n=EpMPeQ8Ec2Yrg9EI&q=85&s=5afdc6940d6d761075b653b0e77b9429" alt="Rakuten connection in Northbeam with the Click UTMs and Scheduled Report boxes checked" style={{ maxWidth: "560px", maxHeight: "440px", width: "auto", height: "auto", margin: "0 auto" }} width="890" height="312" data-path="images/readme/a49addf7-Screen_Shot_2024-12-31_at_2.19.18_PM.png" />
    </Frame>

    **If you skip this step:** Rakuten campaign and ad names are missing, along with spend and impressions.
  </Step>

  <Step title="Confirm tracking">
    * **Parameters captured:** follow [Checking UTM tracking](/docs/checking-utm-tracking) to confirm the Northbeam parameters reach your landing pages.
    * **Connection syncing:** follow [Checking platform connections](/docs/checking-api-connections) to confirm the account shows as connected and data is arriving.

    If a check fails, see [Troubleshooting Northbeam data](/docs/troubleshooting-tracking-issues).
  </Step>
</Steps>

## Need help?

<CardGroup cols={1}>
  <Card title="Troubleshooting Northbeam data" icon="wrench" href="/docs/troubleshooting-tracking-issues">
    Start here if a check above fails.
  </Card>
</CardGroup>