DocumentationCheatsheet

VNGGames SDK Cheatsheet

How to request VNGGames SDK

Step 1

Go to https://op.mto.zing.vn/sdk-request/create

Step 2

Choose your game and your desired platform (For native platform, you might need to request both android and ios SDK)

Step 3

Choose your desired features and setup the related configs.

Step 4

Double check your SDK info and send the request.

β€” The SDK will be prepared and delivered to you within a maximum of three days. β€”

See this video for reference.



Feature List

Supported features by platform:

CategoryFeatureiOSAndroidUnityUnrealWindows
AuthenticationShow login formβœ…βœ…βœ…βž–βœ…
Auto loginβœ…βœ…βœ…βœ…βž–
Direct loginβœ…βœ…βœ…βž–βœ…
Quick loginβœ…βœ…βœ…βž–βž–
LevelUp multiple accountsβž–βž–βž–βœ…βœ…
In-App Purchaseβœ…βœ…βœ…βœ…βž–
AnalyticsAppsFlyerβœ…βœ…βœ…βœ…βœ…
Firebaseβœ…βœ…βœ…βœ…βž–
Data Platformβœ…βœ…βœ…βœ…βœ…
Facebookβœ…βœ…βœ…βœ…βž–
CleverTapβœ…βœ…βœ…βœ…βž–
ThinkingDataβœ…βœ…βœ…βœ…βœ…
Customer SupportCS portalβœ…βœ…βœ…βœ…βœ…
In-App AdsironSourceβœ…βœ…βœ…βž–βž–
Meta Audience Networkβœ…βœ…βœ…βž–βž–
EngagePre-registration rewardβž–βœ…βœ…βž–βž–
Firebase Cloud Messagingβœ…βœ…βœ…βœ…βž–
CleverTap push notificationβœ…βœ…βœ…βž–βž–
Local push notificationβœ…βœ…βœ…βœ…βž–
Firebase in-app messageβœ…βœ…βœ…βœ…βž–
CleverTap in-app messageβœ…βœ…βœ…βž–βž–
CleverTap app inboxβœ…βœ…βœ…βž–βž–
Firebase remote configβœ…βœ…βœ…βœ…βž–
Apollo push notificationβœ…βœ…βœ…βœ…βž–
Apollo in-app messageβœ…βœ…βœ…βœ…βž–
Apollo app inboxβœ…βœ…βœ…βœ…βž–
In-app WebViewβœ…βœ…βœ…βœ…βœ…
SocialFacebookβœ…βœ…βœ…βœ…βž–
Instagramβœ…βœ…βœ…βž–βž–
User ExperienceIn-app reviewβœ…βœ…βœ…βœ…βž–
Google Translateβœ…βœ…βœ…βž–βœ…

βœ… Supported Β· βž– Not available on this platform

Authentication

VNGGames SDK authenticates players across Guest, Facebook, ZingID, Google, Sign in with Apple, and Email & Phone, returning the correct credentials and requested properties for each. Studios choose how sign-in behaves β€” show a login form, auto login, direct login, or quick login β€” and on Windows, LevelUp adds support for managing multiple accounts.

Multi-channel Supported

  • Guest
  • Facebook
  • ZingID
  • Google
  • Sign in with Apple
  • Email & Phone

Login method

Support various login mechanism, game can choose one of them base on business requirement:

Show login form

  • Each time app open and call login function, the login form will be shown so that user can choose login channel at anytime.

Auto login

  • Login form will be shown at the first time user open app and login function is called. After that, SDK will process auto-login with the last login channel that user chose.

Direct login

  • Support call to Login Function in case of Product cannot use login form of VNG.

Quick login

  • The fastest way to start playing β€” no login form to load and no user interaction required.

LevelUp multiple accounts (Windows-only)

Manage and switch between multiple VNGGames accounts inside the game, for players who run more than one account on Windows.

In-App Purchase

VNGGames SDK queries available products and guides players through payment using Google Play billing and App Store in-app purchase.

Purchase Items

Efficiently query a list of available products ready for user purchase and guide the user through the payment process.

Analytics

VNGGames SDK Analytics connects your game to AppsFlyer, Firebase Analytics, Facebook App Events, Data Platform (VNG’s internal analytics tool), ThinkingData, and CleverTap. Use these providers to understand player behavior and measure campaign and ad performance.

AppsFlyer

AppsFlyer analytics suite simplifies complex data and gives you a unified view of campaign performance so you can make better, faster marketing choices at every stage of the user journey

Firebase Analytics

VNGGames SDK offers you the way to easily enable Firebase Analytics, an app measurement solution, available at no charge, that provides insight on app usage and user engagement.

Data Platform

The Data Platform is an internal analytics tool provided by VNG, designed for easy data management and flexibility to meet your specific business requirements.

Facebook App Events

App Events allows you to track actions that occur in your game such as app installs and purchase events. By tracking these events you can measure ad performance and build audiences for ad targeting.

CleverTap

Use CleverTap as an analytics provider to track user engagement and segment players, alongside CleverTap’s push and in-app messaging features.

ThinkingData

Enable ThinkingData as an additional analytics provider to track player behavior and game events alongside your other analytics platforms.

Customer support

VNGGames SDK keeps support in-game so players never have to leave the app. CS Portal opens the game’s support page (support.vnggames.com) in a webview, logs the player in automatically, and collects the details needed to raise a support ticket.

CS Portal

This feature open the support page of game directly (which is the same as page https://support.vnggames.com) in webview.

In-App Ads

VNGGames SDK turns gameplay into revenue with rewarded and interstitial ads β€” mediated through ironSource and served by Meta Audience Network β€” so you can reward players for watching ads with a lightweight integration.

ironSource

VNGGames SDK provides the IAA (In-app Ads) - Ads Reward feature using Iron Source - an Ad Mediation Platform. This feature facilitates easy implementation of reward mechanisms for players when they watch advertisements. Currently, the Ads Networks integrated into the SDK (via Iron Source) include:

Android

  • AdColony Network
  • Applovin Network
  • Digital Turbine (Fyber) Network
  • Google Ads Network
  • InMobi Network
  • Meta Audience (Facebook) Network
  • Mintegral Network
  • Pangle Network
  • Tapjoy Network
  • Vungle Network
  • UnityAds Network

iOS

  • Meta
  • GoogleAdMob
  • DT Exchange (Digital Turbine, Fyber)
  • Unity Ads

Meta Audience Network

Monetize your game with Meta Audience Network interstitial, rewarded video, and rewarded interstitial ads.

Engage

VNGGames SDK Engage brings your re-engagement tools into one place: pre-registration rewards, push notifications through Firebase Cloud Messaging, CleverTap, and Apollo (plus local push), in-app messaging via Firebase, CleverTap, and Apollo, an app inbox (CleverTap, Apollo), Firebase Remote Config, and an in-app WebView for surfacing content without leaving the game.

Pre-Registration Reward (Android-only)

Verify a player’s pre-registration status and grant the reward β€” a Play Store–supported promotion that boosts viral efficiency during pre-registration campaigns before a game officially launches.

Firebase Cloud Messaging

  • This feature support to receive and display Push notification content that is pushed from Firebase’s system through Firebase Console (similar to the usual Push Notification feature that games are using).

  • Push Notification’s content is displayed outside the app, when the app is not active (the user doesn’t open the app)

  • Supporting push to a set of users under certain conditions supported by Firebase Cloud Message system.

CleverTap push notification

Send push notifications through CleverTap, an additional push provider alongside Firebase Cloud Messaging and Apollo.

Local Push

  • Message is set up as calendar in local device. The notification will be shown in time as define everyday.

  • Product can setup time to show notification and content of message on Operation Tool -> SDK Config.

Firebase in-app message

  • This feature allow app to receive and display Push Notification’s content INSIDE APP WHEN THE APP IS ACTIVE (user is playing game).

  • Content is push from the Firebase Console tool.

  • You can push to 1 set of users under a number of conditions supported by the Firebase Console system.

CleverTap in-app message

Deliver targeted, contextual in-app messages through CleverTap, an additional in-app messaging provider alongside Firebase and Apollo.

CleverTap app inbox

Give players a persistent, in-app inbox (CleverTap-backed) to revisit push and in-app messages they may have missed.

Firebase Remote Config

  • This is the feature that supports getting configuration information (actions to be taken) from the Firebase system. The Firebase system relies on tracking information (obtained from in-app tracking events of the Firebas Tracking feature) to determine which targeting group the user belongs to, and returns the client the corresponding configuration file (this configuration information is set up by the product’s Marketing administrator on Firebase Console).

  • The application when receiving configuration information will process to have the appropriate action (for example: show promotion information suitable loaded package / increase the rate of item in a short time …) for the user corresponding.

Apollo push notification

Send push notifications through Apollo, an additional push provider alongside Firebase Cloud Messaging and CleverTap.

Apollo in-app message

Deliver targeted, contextual in-app messages through Apollo, an additional in-app messaging provider alongside Firebase and CleverTap.

Apollo app inbox

Give players an in-app inbox powered by Apollo, an alternative provider to the CleverTap-backed app inbox.

In-app WebView

The VNGGames SDK supports two main types of WebView:

  • Display a custom URL within a WebView inside your game.

  • Show a WebView with a URL configured on the SDK server to gather information before displaying it in your game.

Social

VNGGames SDK lets players share and invite friends without leaving the game, using Facebook (profile, photo and link sharing, friend list, invite friends) and Instagram (share to feed or Stories).

Facebook

Main supported features:

  • Get profile: get user’s profile.

  • Share photo: share the photo on your wall.

  • Share link: share the URL (URL website, URL app on store, Onelink URL…), combined with photo on your wall. When your friend click on your post, they will be redirect to the URL that you shared.

  • Get Friend List: get list of Facebook’s friend that is using app.

  • Invite friend: invite your Facebook friend to use this app.

Instagram

Main supported features:

  • Share feed: share the content to your feed.
  • Share stories: share the content to your story.

User Experience

VNGGames SDK smooths everyday interactions with In-App Reviews, so players can submit Play Store or App Store ratings without leaving the game, and Google Translator, which translates chat messages into the user’s language in-app.

In-App Reviews

VNGGames SDK provides a convenient way for users to submit Play Store and App Store ratings and reviews without leaving your app or game, utilizing Google Play and App Store In-App Reviews.

Google Translator

Google Translator feature in VNGGames SDK is a powerful tool designed to seamlessly translate any text into any language, or the user’s preferred language. This feature make your game even cooler and more enjoyable for everyone!

  • Game need to design a button appear with each chat message so that user can click in it and game will call the translate function.

  • Each message just translate one time and show directly to user in chat.