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

# RewardGUM Bundle Integration Guide

> This guide is for developers and app owners who want to monetize their applications by offering Bright Data (in this integration guide example: RewardGUM on Windows) as an additional offer within their app platforms.

Integrating [RewardGUM](https://rewardgum.com/) is the first step toward earning revenue. Once you've released your app bundle you can start earning per install!

This document provides a step-by-step walkthrough for seamlessly incorporating Bright Data products into your application.

Implementation is simple - there are 3 steps:

1. Register your app in the dashboard.
2. Integrate RewardGUM bundle.
3. Final review.

<Info>
  **Bright Data must review your application before you start distributing your app with a bundle offer.**
</Info>

### Important Notes

* Users must **ALWAYS** decide if they want to **VOLUNTARILY** install RewardGUM after seeing the offer and consent screen. Additionally, users should **ALWAYS** have a straightforward means to opt out of the installation process.
* Take care when implementing the offer screen and the opt-out mechanisms in a way which follows guidelines in this document.
* Follow consent screen implementation guidelines in order to return true value from user interaction. **DO NOT install anything on users' devices if they have not opted-in**.
* **Bright Data products do not do any user tracking of any kind**. You can read more about RewardGUM and privacy in its [FAQ](https://help.rewardgum.com/en/).
* It's important to follow the guidelines in this document to avoid violation of our company's policy which may lead to termination of agreement.

<Steps>
  <Step title="Register Your App in the Dashboard" titleSize="h3">
    1. Go to [Monetized Bundles](https://bright-sdk.com/cp/bundles) → Click on the **(+) Add Bundle** button (top of the page).
    2. In the Bundle Creation popup: Choose the **Product** you would like to promote, the **Operating System** your app is offered in, and the **Offer Type** from the dropdown menu (description of each is available under the offer type box).
    3. Under "URL" enter the current download link of your app for our team to review.
    4. Click **"Create"** button.

    <img src="https://mintcdn.com/brightdata-31a14106/5LBFU4CHN9Xl8VaV/snippets/image/bundles_register_app.png?fit=max&auto=format&n=5LBFU4CHN9Xl8VaV&q=85&s=6bbf0d6a616d1b07bcef830e56881d6f" alt="Alt text" width="400" data-path="snippets/image/bundles_register_app.png" />

    <Note>
      As part of our service to select partners, we include them in the respected [AppEsteem certification program](https://customer.appesteem.com/certified?vendor=BDATA), recognized by major AV vendors. Once implementation is confirmed and installs look good, we'll notify you to begin.
    </Note>

    The process involves app review, addressing any violations, and finally, code signing with a new certificate (handled by the app developer).

    <Check>
      Bright SDK covers the entire certification process and maintenance - at no cost to you!
    </Check>
  </Step>

  <Step title="Choose Your Offer Type" titleSize="h3">
    <Note>
      More offers coming soon.
    </Note>

    #### Scenario 1 – Installation Wizard Offer

    Offer your users the benefits of RewardGUM by adding a screen to your install wizard.

    * Promotional offer is shown within product installation wizard (start with offer screen setup and then implement exe file).

    <Warning>
      Make sure RewardGUM offer screen does not interrupt the user's expected flow. Ideally it should show AFTER your install wizard process is complete. Otherwise, you need to have the user's permission to view optional offers before showing it.
    </Warning>

    * User clicks **Agree**.
    * exe file downloads in the background.
    * RewardGUM setup is launched and presents the Bright SDK consent screen **only after** your app installation is complete.

    <Note>
      For offer screen setup and technical integration, continue to [**Set Up Your Offer Screen**](#set-up-your-offer-screen) and [**Technical Integration**](#technical-integration).
    </Note>
  </Step>

  <Step title="Set Up Your Offer Screen" titleSize="h3">
    <Warning>
      **Important!** Please follow the guidelines below to assure compliance with our policies. If you violate the guidelines, Bright Data reserves the right to terminate your account.
    </Warning>

    **Optional:** You may design the opt-in any way you choose (we recommend the design to be as close as possible to your installation wizard). However, the RewardGUM offer screen must always include an opt-in consent screen with the mandatory text below.

    * You may implement the [RewardGUM offer screen](https://drive.google.com/file/d/1vcbR12rMGVHN-uzXxdHxCG6E1yRtKkjA/view) onto your wizard (make sure to include all the links provided below).
    * In case you want to design your own RewardGUM offer, please read below.
    * In the [**Assets**](https://drive.google.com/drive/folders/1YtNCEJKdHTCPnJzKuC0nngWgZXN4Y4S0) section you may find all the imagery needed.
          <img src="https://mintcdn.com/brightdata-31a14106/d1-ejOgu7fpAA-ib/integration-guides/image/rgum_integration_1.png?fit=max&auto=format&n=d1-ejOgu7fpAA-ib&q=85&s=fe20531e7ab4782225195841b5b66271" alt="Alt text" width="400" data-path="integration-guides/image/rgum_integration_1.png" />

    1. **Mandatory Text**
       Optional offer by <a href="https://rewardgum.com/"><img src="https://mintcdn.com/brightdata-31a14106/d1-ejOgu7fpAA-ib/integration-guides/image/rgum_integration_2.png?fit=max&auto=format&n=d1-ejOgu7fpAA-ib&q=85&s=799be1b6e2eaf0791d3f7c0e842cb9e5" alt="RewardGUM" noZoom style={{height: "1em", width: "auto", display: "inline"}} width="232" height="57" data-path="integration-guides/image/rgum_integration_2.png" /></a>
       When you click "Accept", you agree to install "RewardGUM" and consent to its [Privacy Policy](https://rewardgum.com/privacy/) and [EULA](https://rewardgum.com/user-agreement/).
    2. **Buttons**
       "Decline" / "Accept"
           <Warning>
             Make sure buttons return true value from user interaction ("Decline" = opt-out / "Accept" = opt-in). **DO NOT install anything on users' devices if they have not opted-in.**
           </Warning>
    3. **Required Links**
       | Text           | URL                                                                          |
       | -------------- | ---------------------------------------------------------------------------- |
       | RewardGUM      | [https://rewardgum.com/](https://rewardgum.com/)                             |
       | EULA           | [https://rewardgum.com/user-agreement](https://rewardgum.com/user-agreement) |
       | Privacy Policy | [https://rewardgum.com/privacy](https://rewardgum.com/privacy)               |
  </Step>

  <Step title="AV Guidelines" titleSize="h3">
    As mentioned above, it is vital to us to keep all of our partners' apps certified and cleared from any Anti Virus detection. Based on our experience, and partnership with Appesteem, we will provide some consulting about the implemented flow, to avoid any AV detection.

    For more details, we recommend you visit [this page](https://customer.appesteem.com/home/checklist), and filter the list for "**In-bundle offers**", "**Bundler-made offers**" and "**Ads inside apps**".

    These guidelines were not written specifically for any of Bright Data's applications, and are relevant for any bundler.
  </Step>

  <Step title="Assets" titleSize="h3">
    * Drive folder: [Link](https://drive.google.com/drive/folders/1YtNCEJKdHTCPnJzKuC0nngWgZXN4Y4S0).
  </Step>

  <Step title="Restricted Countries" titleSize="h3">
    **Important Note before integrating:** Due to local restrictions, RewardGUM should not be offered in the following countries and/or regions. Please make sure you **disable the offer** for:

    * Iran
    * Iraq
    * Syria
    * Lebanon
    * Palestine
    * Russia
    * Belarus
    * North Korea
    * Cuba
    * Sudan
    * Crimea region of Russia
  </Step>

  <Step title="Technical Integration" titleSize="h3">
    1. **Dynamically download** the bundler using the link present in your bundle page in the [<u>Bright SDK control panel.</u>](https://bright-sdk.com/cp/bundles)
           <img src="https://mintcdn.com/brightdata-31a14106/d1-ejOgu7fpAA-ib/integration-guides/image/rgum_integration_3.png?fit=max&auto=format&n=d1-ejOgu7fpAA-ib&q=85&s=995e97cbb1ddc45e32926ada62a7adb7" alt="Alt text" width="400" data-path="integration-guides/image/rgum_integration_3.png" />
       **Download URL format:** `https://cdn.bright-sdk.com/static/rewardgum_bundler.exe?filename=RewardGum-[your_bundle_code].exe`\
       **Downloaded filename format:** `RewardGUM-XXXXX.exe`\
       **Example:** `RewardGUM-zx76b.exe`
           <Warning>
             **Important:** Make sure that the bundler executable file has your bundle code in its filename - if it isn't present it will fail. The filename must end with `-XXXXX.exe`, where `XXXXX` is your unique bundle code.
           </Warning>
    2. **Save the user's** **choice** when the offer is displayed.
    3. Once your installer has finished - if the user clicked "**I agree**" on the offer screen, run the **bundler executable.**

    <Note>
      **Troubleshooting:** If you encounter any issues during the installation of the Bundler application, you can access debug logs by executing it through the Windows Command Prompt (CMD). This will assist you in identifying the underlying problem.
    </Note>

    **<u>Validation Checklist:</u>**

    Before submitting for review, complete the following checklist:

    * Launch your app's install wizard.
    * Offer is displayed within the wizard (non-intrusive, with product description).
    * Privacy Policy and EULA links are visible and clickable:
      * EULA: [https://rewardgum.com/user-agreement](https://rewardgum.com/user-agreement)
      * Privacy Policy: [https://rewardgum.com/privacy](https://rewardgum.com/privacy)
    * Click "Install" / "Accept" to proceed.
    * Your app's install wizard completes successfully.
    * RewardGUM installer launches automatically.
    * Main Screen of RewardGUM is successfully launched.
  </Step>

  <Step title="Send for Final Review" titleSize="h3">
    <Warning>
      **Important!** To get paid for installs you must:

      * Send your app for review and get approved (details below).
      * [Set up your billing details](https://docs.bright-sdk.com/help-center/payment-information#what-is-the-process-to-get-the-monthly-payment).
    </Warning>

    Once you are done implementing, please upload your exe file for review under the **"Review Submission"** section in your dashboard app page:

    <img src="https://mintcdn.com/brightdata-31a14106/rKXt-nAzRJvAfdSm/integration-guides/image/holavpn_integration_10.png?fit=max&auto=format&n=rKXt-nAzRJvAfdSm&q=85&s=e9c5b302becc2c48868623e7007c0833" alt="Alt text" width="400" data-path="integration-guides/image/holavpn_integration_10.png" />

    <Note>
      Each offer type (Wizard, successful/uninstall page, in-app, etc.) requires separate dashboard setup and review.
    </Note>

    We will review the flow, send you feedback and add the right entities in our system and set it to **active** status in order to provide the right stats to start paying you for Hola VPN installs.

    Payments are done automatically according to the system's data - if you find any discrepancies, please let us know.
  </Step>

  <Step title="Get Your App Certified!" titleSize="h3">
    * We will assess the number of installations in the course of a **two-week period** and initiate the **AppEsteem certification process**, for which we will cover the associated costs. [Click here](https://customer.appesteem.com/certified?vendor=BDATA) to see the list of our partners' apps that have been certified.
    * As part of this process, it is necessary to implement a **new signing certificate** (this part is the partner's responsibility).

    <Note>
      When you add an offer (Wizard, successful/uninstall page, in-app offer, etc.), most likely you have a new build version. In that case, please share so we can recertify with AppEsteem.
    </Note>

    * If you have any inquiries, please feel free to contact our [Director of Security Partnerships](mailto:ofirm@brightdata.com).
  </Step>

  <Step title="Report and Payment Details" titleSize="h3">
    * We invite you to check into the [Bright SDK Dashboard](https://bright-sdk.com/cp), where you can manage your partnership activity, monitor your revenue and have access to other partner program assets.
    * In our dashboard, update your billing contact and payment details under **"[Company Profile](https://bright-sdk.com/cp/settings/company_profile)"**. [Learn more about our billing process](https://docs.bright-sdk.com/help-center/payment-information#what-is-the-process-to-get-the-monthly-payment).
    * Our team will notify you once they complete their review and approve your integration - you may then start distributing this build and start monetizing with Hola VPN!
    * Once active, your reports and payment details can be found and managed directly in the [Bright SDK Dashboard](https://bright-sdk.com/cp).
  </Step>
</Steps>