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 Platforms

Authentication

The VNGGames SDK provides features to authenticate users, returning the correct credentials and any requested properties.

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.

Logout

  • Support call to Logout Function.

Delete Account (iOS-only)

  • This function is supported in order to adapt the requirement of Apple when submit app to Appstore.

  • Support call to Delete Function.

Decree 13

This is the function to adapt the requirement of Vietnamese Goverment about the Privacy Policies and Term of Services. This feature include:

  • The form that show the consent and link of Privacy Policies and Term of Services. User should check the box to confirm that we already read and agreed in order to continue to access to game.
  • Write log tracking the “agreement action” of user to VNGGames’s log system.

In-App Purchase

Purchase Items

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

Pre-Registration Reward (Android-only)

Enables the verification of a user’s pre-registration status to determine eligibility for special rewards.

Analytics

VNGGames SDK Analytics offers multiple analytics options including Facebook, Firebase, Data Platform, and Appsflyer. It helps you understand user behavior within your app, providing valuable insights.

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.

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.

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.

Customer support

CS Portal

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

AI Help

  • This is the feature to send the support requests by using AIHelp platform (VNGGames’s CS Platform system has integrated with AIHelp).

  • When the user creates a request in this feature, the ticket will be sent to the CS Platform system. Product’s CS Team can process tickets the same way as ticket which is submitted on https//support.vnggames.com.

  • Support some features that are provided by AIHelp such as creating Story Q&A (details of features that are supported by AIHelp, Product team please contact team CS of CTS for more information).

Engage

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

Push Notification

Remote Push

VNGGames SDK offers you messaging solutions that lets you reliably send messages at no cost:

  • Firebase Cloud Messaging (FCM)

  • PNP

Firebase Cloud Messaging (FCM)
  • 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.

PNP
  • Message to user from server-side.

  • Product can use backend tool to setup push content

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.

In-App Messaging

  • 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.

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.

Show 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

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

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.