Skip to main content

Leaderboard

1. Overview​

The file engagement_leaderboard.yaml in exported package contains all configuration of Leaderboard module from exported title region. You can add, delete or update some items in the file and then re-import to the title region.

2. An Example of The File Content​

# AUTO-GENERATED FILE.
#
# Export information
# @export_time: Fri, 17 Nov 2023 09:36:39 GMT
#
# This file was automatically generated by PGOS Portal.
# Copyright 2023 Proxima Beta, Inc. All Rights Reserved.

engagement_leaderboard:
  snapshot_tag: "20231117173620153"
  title_id: 4basx
  title_region_id: t_4basx_546_test
  list:
    - identification:
        name: name
      leaderboard_id: "38168262046161"
      description: ""
      stat_id: statid
      stat_name: statname
      cycle_name: ""
      value_order: 1
      secondary_value_order:
        is_used: true
        order: 2
      update_time_order:
        is_used: true
        order: 2

3. Field Description​

  • identification: The unique identifier for the current resource, it contains multiple fields:
    • name: the name of leaderboard. Type: string. Length: 1-100.
  • leaderboard_id: the id of leaderboard for unique. Type: string. Length: 1-100.
  • description: the description of leaderboard. Type: string. Length: 1-1024.
  • stat_id: the id of stat related to leaderboard. Type: string.
  • stat_name: the name of stat related to leaderboard. Type: string.
  • cycle_name: the cycle name of related to leaderboard. Type: string.
  • value_order: the order of value. Type: number. 1-Ascending/2-Descending
  • secondary_value_order:
    • is_used: use secondary value or not. Type:boolean
    • order: the order of secondary value. Type: number. 1-Ascending/2-Descending
  • update_time_order:
    • is_used: use update time order or not. Type:boolean
    • order: the order of update time. Type: number. 1-Ascending/2-Descending