Announcement
The Player Network Announcement service offers an easy-to-use interface for games to display various in-game announcements, including scheduled updates and marketing campaigns. Through Player Network, create and publish announcements efficiently by using diverse templates and a rich text editor.
Multiple display formats, such as announcements and popups, can be configured to deliver critical information through different channels. For example, legal updates can be configured to be displayed before login, while marketing campaigns can be configured to appear as post-login popups.
Prerequisites
Before integrating the Announcement service module, reach out to the Player Network representative.
-
Integrate the Player Network SDK.
Games should design custom announcement assets before fetching configured announcements from Player Network Console. As announcements are delivered to clients as code snippets, frontend developers will be responsible for parsing the content. The developers and operations team are required to determine the parsing methodology and display implementation for these announcements.
-
Establish the UI design and configuration processes for announcements in Player Network Console.
Process requests for announcement data
Developers can register the following callbacks regarding announcement events. This allows developers to detect and process the requests for announcement data.
- Unity
- Unreal Engine
| API | Function |
|---|---|
| AddNoticeResultObserver | Registers the NoticeResult callback. Used to manage the callback of RequestNoticeData. |
| RemoveNoticeResultObserver | Unregisters the NoticeResult callback. |
| API | Function |
|---|---|
| SetNoticeResultObserver | Sets the NoticeResult callback. Used to manage the callback of RequestNoticeData. |
| GetNoticeResultObserver | Gets the NoticeResult callback. |
| OnNoticeRequestData_Implementation | Implements the NoticeResult callback for RequestNoticeData. |
Request for announcement data
- Unity
- Unreal Engine
Call the RequestNoticeData function with the following parameters to retrieve the announcement data configured in Player Network Console and display them in the game:
- An integer representing the ISO 3166-1 code of the region, with 0 standing for all regions.
- A string representing the RFC 4646 language code of the announcement content.
- An optional string to filter announcement content.
string seqid = INTLAPI.RequestNoticeData("0", "zh-Hans", extraJson);
Call the NoticeRequestData function with the following parameters to retrieve the announcement data configured in Player Network Console and display them in the game:
- An integer representing the ISO 3166-1 code of the region, with 0 standing for all regions.
- A string representing the RFC 4646 language code of the announcement content.
- An optional string to filter announcement content.
UINTLSDKAPI::NoticeRequestData("0","zh-Hans","{}");