Skip to main content

Overview

Engagement Service provides a set of services to help developers organize events and attract players, including Mail, Leaderboards and Goals.

1. Mail​

1.1 What is Mail​

Developers can send in-game mail to players via PGOS Web Portal or Virtual Server, which can be triggered by events or set to run periodically.

1.2 Features​

sequenceDiagram participant A as Portal/VirtualServer participant B as Mail Service participant C as Game Client A->>B: Request SendMail B->>C: Push Mail C->>B: Mark As Read C->>B: Claim Attachment C->>B: Delete Mail

  1. Send Mail

    • Send a mail in multiple languages to players from different countries, and each player will receive a mail text according to player language info.
    • Add attachments to a mail that include in-game items or virtual currency from the economy system.
    • Set custom data in mail structure and Mail service will pass it directly to game client.
    • The action of sending an email will generate a record in the mail service, which can be viewed on the portal.

  2. Mail Management

    • Fetch mails in pages by category.
    • Mark mails as read in batch.
    • Delete mails in batch.

  3. Claim Attachment

    • Players can claim the attachment in a mail. PGOS will ensure that the attachment can only be claimed successfully at most once.
    • The claim action will generate a grant record in inventory service, which can be viewed on web portal.

2. Goals​

2.1 What is Goals​

Goals is a service that allows you to set numerous challenges for players and then package these challenges into a variety of outer loop features, for example Achievement, Quests, Battle Pass, etc. Games can use the client SDK to access goals service to retrieve the player's challenge progress.

2.2 Features​

  1. Goals Definition
    • Simple Goal. A simple reward object that defines the conditions and rewards to achieve a goal.
    • Hyper Goal. A two-dimensional layered reward object. One dimension is defined as Tiers and the other dimension is defined as Passes.
  2. Goals Schedule
    • Multiple available periods to support more diverse customization of the goals publish time line.
    • Custom goals arrangement in available periods.
  3. Goals' Rewards
    • Players can gain rewards in form of virtual currency and in-game item by achieving goals.

3. Leaderboards​

3.1 What is Leaderboards​

The leaderboard is almost an essential feature for online games. By displaying the Leaderboard and player ranking details, you can create a great competitive atmosphere for the players.

3.2 Features​

  1. Persistent and cycled leaderboard
    • The ranking data in persistent leaderboard will be not reset, while ranking data in cycled leaderboard will be reset periodically according to the stat cycle you chose for creating the leaderboard.
  2. Multi-values sorting
    • In case the value in ranking item is equal, the leaderboard can be sorted by second value and then updated time according to your configuration. Both descending and ascending order is supported.
  3. Support retrieving ranking items with neighbor items
  4. Support retrieving any offset of the rank list