Branded Mini-Games Support
  • Welcome
  • Branded Mini-Games
    • Create a campaign
      • Method 1
      • Method 2
      • Campaign Types
        • Website
        • Mobile App
        • Playable ads
        • Brand Hosting
    • Game Settings
      • Game Customization: Easy Mode
      • Game Customization: Pro Mode
        • Other Features
      • How to Modify Graphics
      • Configurations
        • Minimum Game Score Setting
        • Using Hearts (Game Life)
      • Activating the prepared game
      • Instant Win
    • Campaign Settings
      • Campaign Profiles and SEO
      • Campaign URL
      • CNAME
      • How to Add a Game to Your Website
      • Deleting Games
    • Page Settings
      • Landing Page
      • Login
      • Results and Calls to Action
        • Leaderboard
        • No Leaderboard
        • Sharing
        • Call-to-Action
      • Changing Background Music and Favicon
      • Coupon
      • Skin Editor
    • Website
      • Website -> Leaderboard
      • Website -> UserID & Leaderboard
      • Website -> Participate & Win
      • Website -> UserID & Webhook
    • Mobile App Settings
      • Android App
      • iPhone iOS App
      • Mobile App -> Leaderboard
      • Mobile App -> UserID & Leaderboard
      • Mobile App -> UserID and Webhook
      • Close button
    • Play & Redeem
      • Select a Service Group
      • Choosing a Login Method & Service Start URL
      • Exchange game points to Shopping credits
      • Exchange game points to Coupons
      • Daily Missions settings for the game
    • UserID & Webhook
      • Website
      • Mobile App
      • Brand Hosting
    • Playable Ads
      • Customer acquisition through events
      • App installation
    • Data & Export
      • Participation
      • Sign up
      • Coupon Management
    • Google Analytics
    • Paid Plan & Publish
      • Publish
      • Subscribing to a Paid Plan
      • Purchase additional CPP
      • Invoice
      • Change credit card, update billing information, cancel service
    • Brand Hosting
      • Add game
      • Server setting test
      • Webhook and return values
  • Run actual Branded Mini-Games.
  • Terms of Use
    • Terms of Use
    • Privacy policy
    • Cookie Policy
    • Data Processor Agreement
    • GDPR
      • Understanding GDPR: Overview of Data Protection Regulation
      • Personal Data and Compliance: Key Considerations
      • GDPR Compliance in Studio Operations: User Sign-Up and Privacy Policies
      • Data Management: Retention, Analytics, and Reporting
    • Coupon Town - Terms and Conditions
  • Game Development Request
  • Deutsche / German
    • Marken-Mini-Spiele
  • Français / French
    • Mini-jeux de Marque
  • Italiano / Italian
    • Mini-Giochi Brandizzati
  • Español / Spanish
    • Mini-Juegos de Marca
  • Português / Portuguese
    • Mini-Jogos de Marca
  • Türkçe / Turkish
    • Markalı Mini Oyunlar
  • हिन्दी / Hindi
    • ब्रांडेड मिनी गेम्स
  • 한국어 / Korean
    • 브랜드 미니 게임
  • 日本語 / Japanese
    • ブランドミニゲーム
  • 简体中文 / Chinese
    • 品牌小游戏
  • Arabic (العربية)
    • ألعاب صغيرة ذات علامة تجارية
Powered by GitBook
On this page
  • 1. Server Location of the Unzipped File
  • 2. Webhook URL
  • 3. Download test ZIP file.
  • 4. Register and run the game file on the brand server.
  • 5. Do a test.
  1. Branded Mini-Games
  2. Brand Hosting

Server setting test

PreviousAdd gameNextWebhook and return values

Last updated 2 months ago

You can download the test ZIP file and test the server setup without a paid subscription.

1. Server Location of the Unzipped File

After unzipping the downloaded ZIP file, enter the URL where the extracted files will be uploaded. In other words, specify the server location where the unzipped HTML5 game will be executed.

2. Webhook URL

Enter the Webhook URL to which the result values will be sent after the game ends. The result values can be received in JSON format or as x-www-form-urlencoded in a POST request.

Return URL

This is where you enter the website URL to which the screen will transition when the Continue button is pressed after the game ends. For example, pressing Continue after the game can redirect the screen to https://www.google.com. At this point, the following JavaScript will be automatically added to the script window below:

location.replace('https://www.google.com');

Additionally, you can add any extra JavaScript code to this screen as needed.

After entering the information, you must click the update button.

3. Download test ZIP file.

Once the server location for the unzipped files, the Webhook URL, and the Return URL are all entered and the update button is clicked, the “Test ZIP download” button at the bottom will turn blue. After that, you will be able to download the ZIP file.

4. Register and run the game file on the brand server.

When running the mini-game in a web browser, the ‘userid’ parameter and its value must be included using the GET method.

Parameter

Name
Description
Format
Sample

userid

Unique ID generated from the brand's system

Alphanumeric (case-sensitive) + up to 20 digits

T4g4fLTaorjames

Example, Original campaign URL address https://brand.server.com/ The brand's system must call this URL and send the "userid".

https://brand.server.com/?php=userid=T4g4fLTa

5. Do a test.

Unzip the downloaded ZIP file and upload it to the brand test server.

Open the web browser and enter the server address. If there is no user ID, the following guidance screen will appear.

Add the userid using the GET method. Set the userid value to T4g4fLTaorjames. Then, click the “Run test” button.

The Block Breaker game will start.

The game ends. Then, click the “Continue” button.

Redirect to the entered Return URL.

The result value in JSON format is successfully sent to the Webhook server.

Name
Description
Sample

userid

User's unique ID

T4g4fLTa or james

time

Datetime when the game player attempted to play

Unix Timestamp (Milliseconds)

result

Game Score obtained by the game player

3500

playtime

Duration of play by the game player (in seconds)

20

If return data is selected as POST (x-www-form-urlencoded), the values will be returned as shown below. However, for server security, it is recommended to select JSON.

Please refer to the following help guide for Webhooks and Return values.