05/15/2024 15:19:45

Notice Module

I. Overview

The notice module is the information notification system provided by MSDK for games. The notice system only provides data. The specific UI style needs to be customized by the user. Through Notice console configuration, the following text, image, URL and other information can be released.
The following diagram is a simple notice display:

II. Access Guide

Precondition

1. Unity layer's CShalp file has been imported to Unity project
   
2. Import the related files of iOS and Android into Unity project directory: Assets/Plugins/iOS (Android)
   
3. Follow the steps below to complete access to the notice module.
   

2.1 Configure the Callback

1) Function description

MSDK notice module's callback; the game needs to register a callback function for processing;

2) Interface declaration

/// <summary>
/// Notice's callback interface 
/// </summary>
public static event OnMSDKRetEventHandler<MSDKNoticeRet>  NoticeRetEvent;

class MSDKNoticeObserver
{
public:
// Notice's callback interface 
    virtual void OnLoadNoticeData (const MSDKNoticeRet &noticeRet) {}; 
};

3) Demo code

MSDKNotice.NoticeRetEvent += OnNoticeRetEvent; 

public void OnNoticeRetEvent (MSDKNoticeRet noticeRet) 
{
    string methodTag = "";
    if (noticeRet.MethodNameId == (int) MSDKMethodNameID.MSDK_NOTICE_LOAD_DATA) {
        methodTag = "LoadNotice";
    }

    SampleInstance.showRetDialog (methodTag, noticeRet); 
}

//Need to remove the listener when destroying it
private void OnDestroy()
{
    MSDKNotice.NoticeRetEvent -= OnNoticeRetEvent; 
}

MSDKNotice:: SetNoticeObserver (new MyNoticeObserver ()); 

class MyNoticeObserver: public MSDKNoticeObserver {
public:
    void OnLoadNoticeData (const MSDKNoticeRet &noticeRet) {
        String ret = MSDKUtils::FormatJson(MSDKJsonManager::ToJson(noticeRet));
        UMSDKDemoBase::showNormalAlert(ret);
    }
};

4) Data structure

MSDKNoticeRet explanation
Inherited from MSDKBaseRet; contain the basic information

MSDKNoticeInfo explanation
notice's struct, including various notice information

Description: extraJson in MSDKNoticeRet can return the values of the input parameters, including: noticeGroup, language, region and partition. These parameters can be used to identify which drawn notice is empty when multiple notice draws are made and one of the drawn notices is empty.

MSDKNoticeTextInfo: Detailed text description of the notice

2.2 Get Notice Data

1) Function description

Get the configured notice information

2) Interface declaration

public static void LoadNoticeData (string noticeGroup, string language, int region, string partition, string extra);

static void LoadNoticeData (const String &noticeGroup, const String &language, int region, 
                               const String &partition, const String &extra);

3) Parameter description

4) Call example

MSDKNotice.LoadNoticeData ("1", "zh-CN", "1", "0");

MSDKNotice:: LoadNoticeData ("1", "zh-CN", "1", "0", "extra params");

III. Configuration Notice

[info]The address of the notice management: SDK Access->Notice Management in the left menu in http://dev.ied.com/

3.1 Configure Notices at the Management Console

The issued notice should pay attention to whether the environment is a test environment or a formal environment

After the management system selects the notice language, the content of the notice language box will display "Selected. Please see the notice content tab", and the selected notice language will be displayed at the top of the notice content box.

[info]

The "Local time zone" field must be set correctly, otherwise it will affect the issue time of the notice

Set a whitelist for the notice. You can set the visibility of the notice to the specified user

If the set parameter is a user-defined parameter, the backend will not filter notices based on the user-defined parameter but will return it to the game when drawing notices

The return examples of the user-defined parameter configuration and drawing are as follows:

IV. Notice filter field rules

4.1 Overview

The notice filtering field rule is controlled by the MSDK backend logic. The backend filter and issue the notice data according to the filtering fields transparently transmitted from the Feiying configuration notice. When the client gets the notice data, it can only get the notice data that meets the filtering rule. The game itself chooses whether to configure the filtering fields.

4.2 Filtering field types

1) Fixed filtering fields

The fixed filtering fields include operation system, channel, openid, device id, version number, partition, among which, except that partition needs to be transparently transmitted through the partition parameter when the notice data is gotten, other fixed filtering fields are all automatically assembled into the backend request and don't need the game to transmit parameters.

[info] Version number acquisition description

Android reads versionCode and versionName in AndroidManifest.xml; iOS reads CFBundleVersionKey (i.e. versionCode) and CFBundleShortVersionString (i.e. versionName) in info.plist

2) User-defined (Extra) filtering fields

User-defined (Extra) filtering fields support up to 10 fields, which can be numbers or English characters and are set according to the game-defined configuration. Any notice that sets user-defined (Extra)filtering fields must be passed in via the Json forma in extra when the client get it; otherwise, the corresponding notice cannot be drawn.

[warning] Special description of user-defined (Extra) filtering fields

If Feiying configures user-defined (Extra) filtering fields

1. When the game client gets notices, the corresponding data must be passed in via the json format in extra. The client can get notices that conform to the user-defined (Extra)filtering fields and all other notices that don't set user-defined (Extra)filtering fields (if other filtering fields are set, other filtering field rules need to be met).
   
2. When the game client gets notice data, if extra is not passed, then the client can only get notices which don't set user-defined (Extra) filtering fields.
   

4.3 Example of filtering rules

1) Configure the operation system filtering

1、 Configure filtering field-operation system is Android. The notice configuration UI is as shown below:

2、 When the game client gets notice data, it doesn't need to transparently transmit the operation system parameter. MSDK will assemble the parameter into the request by itself. Only when operation system is Android, that is, os=1, the corresponding notices can be obtained by the client. The backend request example is as follows:

request url : https://hktest.itop.qq.com/v2/notice/get_notice?channelid=3&gameid=11&os=&seq=11-ad1e7e0c-db53-47d8-8c0a-46f4db9a2c2e-1585646332-91&ts=1585646332&version=5.9.000.2031&sig=b3286fc66bada707aaf7c4fda46e500e with postBody : {"language":"zh-CN","device_info":{"uuid":"0efd653e-8966-4eb2-b3a0-0804ec585ae5","device_language":"zh","app_version":"4.1.1316(1)","screen_dpi":3.0,"resolution":"1080*1920","trade_mark":"OPPO","manufacturer":"OPPO","model":"OPPO R9 Plusm A","apn":"null#WIFI","ram_info":"3770527744","rom_info":"58177896448","cpu_info":"1804","imei":"862022039840336","qimei":"862022039840336","oaid":"","xid":""},"region":156,"partition":"0","last_time":0,"extra_info":{"versionCode":"1","versionName":"4.1.1316"}} opt:3 reqSeq:10101, reqTime:0

2) Configure the openid filtering field

1、 Configure filtering field-openid and upload TXT file. The Notice configuration UI is shown in the figure below:

2、 When the game client gets notice data, it doesn't need to transparently transmit the openid parameter, but the login status is needed so that MSDK assembles openid into the request. Only when openid matches the openid configured by Feiying can the corresponding notices be gotten. The backend request example is as follows:

request url : https://hktest.itop.qq.com/v2/notice/get_notice?channelid=2&gameid=11&os=1&seq=11-ad1e7e0c-db53-47d8-8c0a-46f4db9a2c2e-1585641369-68&ts=1585641369&version=5.9.000.2031&sig=764ae7e85ade2fdd913951282c20c01f with postBody : {"language":"zh-CN","device_info":{"uuid":"0efd653e-8966-4eb2-b3a0-0804ec585ae5","device_language":"zh","app_version":"4.1.1316(1)","screen_dpi":3.0,"resolution":"1080*1920","trade_mark":"OPPO","manufacturer":"OPPO","model":"OPPO R9 Plusm A","apn":"null#WIFI","ram_info":"3770527744","rom_info":"58177896448","cpu_info":"1804","imei":"862022039840336","qimei":"862022039840336","oaid":"","xid":""},"region":156,"partition":"0","last_time":0,"extra_info":{"versionCode":"1","versionName":"4.1.1316"},"token":"745C7327CE7121D79A119E56B9AD81ED","openid":"8820471424767347317"} opt:3 reqSeq:10071, reqTime:0

3) Configure filtering fields - user-defined (Extra) fields

1、 Configure filtering field - user-defined (Extra) field as myExtra1. The notice configuration UI is shown in the figure below:

2、 When the game client gets notice data, it must pass in {"myExtra1":"myValue1"} in the Json format in extra, so as to get the corresponding notice. The example of the client transmitting parameters is shown as follows:

3、 A backend request example is shown as follows:

 request url : https://hktest.itop.qq.com/v2/notice/get_notice?channelid=2&gameid=11&os=1&seq=11-ad1e7e0c-db53-47d8-8c0a-46f4db9a2c2e-1585549132-37&ts=1585549132&version=5.9.000.2031&sig=1efefb378ac29b7e2e201044b7d342f4 with postBody : {"language":"zh-CN","device_info":{"uuid":"0efd653e-8966-4eb2-b3a0-0804ec585ae5","device_language":"zh","app_version":"4.1.1316(1)","screen_dpi":3.0,"resolution":"1080*1920","trade_mark":"OPPO","manufacturer":"OPPO","model":"OPPO R9 Plusm A","apn":"null#WIFI","ram_info":"3770527744","rom_info":"58177896448","cpu_info":"1804","imei":"862022039840336","qimei":"862022039840336","oaid":"","xid":""},"region":156,"partition":"0","last_time":0,"extra_info":{"versionCode":"1","versionName":"4.1.1316","myExtra1":"myValue1"},"token":"745C7327CE7121D79A119E56B9AD81ED","openid":"8820471424767347317"} opt:3 reqSeq:10011, reqTime:0

4) Example of configuring multiple filtering rules

If multiple filtering rules are configured, when the game client gets notice data, it needs to satisfy all filtering rules before it can draw the corresponding notice. The filtering rules of the fixed filtering fields and user-defined (Extra) are the same and can be mixed.

1、 If filtering field-operating system +openid are configured at the same time, the game client can get the corresponding notice only when operating system must be Android and openid matches the Feiying configuration. The Feiying configuration and the backend request are shown as follows:

request url : https://hktest.itop.qq.com/v2/notice/get_notice?channelid=2&gameid=11&os=1&seq=11-ad1e7e0c-db53-47d8-8c0a-46f4db9a2c2e-1585641369-68&ts=1585641369&version=5.9.000.2031&sig=764ae7e85ade2fdd913951282c20c01f with postBody : {"language":"zh-CN","device_info":{"uuid":"0efd653e-8966-4eb2-b3a0-0804ec585ae5","device_language":"zh","app_version":"4.1.1316(1)","screen_dpi":3.0,"resolution":"1080*1920","trade_mark":"OPPO","manufacturer":"OPPO","model":"OPPO R9 Plusm A","apn":"null#WIFI","ram_info":"3770527744","rom_info":"58177896448","cpu_info":"1804","imei":"862022039840336","qimei":"862022039840336","oaid":"","xid":""},"region":156,"partition":"0","last_time":0,"extra_info":{"versionCode":"1","versionName":"4.1.1316"},"token":"745C7327CE7121D79A119E56B9AD81ED","openid":"8820471424767347317"} opt:3 reqSeq:10071, reqTime:0

2、 When two filtering fields - user-defined (Extra) are configured at the same time, the Feiying configuration is shown in the figure below:

When the game client gets notice data, it must pass in {"myExtra1":"myValue1","myExtra2":"myValue2"} in the Json format in extra. An example of the client transmitting parameters is shown as follows:

The backend request is shown as follows:

request url : https://hktest.itop.qq.com/v2/notice/get_notice?channelid=2&gameid=11&os=1&seq=11-ad1e7e0c-db53-47d8-8c0a-46f4db9a2c2e-1585549269-41&ts=1585549269&version=5.9.000.2031&sig=31de3f361c7752891c3cfd11ee94bf06 with postBody : {"language":"zh-CN","device_info":{"uuid":"0efd653e-8966-4eb2-b3a0-0804ec585ae5","device_language":"zh","app_version":"4.1.1316(1)","screen_dpi":3.0,"resolution":"1080*1920","trade_mark":"OPPO","manufacturer":"OPPO","model":"OPPO R9 Plusm A","apn":"null#WIFI","ram_info":"3770527744","rom_info":"58177896448","cpu_info":"1804","imei":"862022039840336","qimei":"862022039840336","oaid":"","xid":""},"region":156,"partition":"0","last_time":0,"extra_info":{"versionCode":"1","versionName":"4.1.1316","myExtra1":"myValue1","myExtra2":"myValue2"},"token":"745C7327CE7121D79A119E56B9AD81ED","openid":"8820471424767347317"} opt:3 reqS

[warning] Special Description:

When the game client get notice data, it must pass in {"myExtra1":"myValue1","myExtra2":"myValue2"} in extra in json format before it can get notices which are separately configured with myExtra1 or myExtra2. Fixed filtering fields also apply to this rule.

V. Others

5.1 Some region' code

5.2 Some language abbreviation code (language)