Skip to main content

Goal

1. Overview​

The file engagement_goal.yaml in exported package contains all configuration of Goals 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_goal:
  snapshot_tag: "20231117173620153"
  title_id: "5"
  title_region_id: d_5_812179_dev
  list:
      - identification:
        id: goal_i5qcym110
      name: goal
      type: Simple
      desc: "desc"
      icon: ""
      tags: []
      rewards:
        reward_id: ""
        item_contents:
          - item_id: item_MvQGlq1uES
            amount: 1
            item_name: item_MvQGlq1uES
            is_unique: false
        vc_contents: 
          - currency_code: AKGOLD
            amount: 2
      achieve_value: 20
      achieve_data:
        algorithm_type: Absolute Value
        data_key: rayaTest02
        data_src: Player Data
      passes:
        - pass_id: pass_tbjrmr4k
          name: default
          desc: ""
          icon: ""
          item_id: ""
          item_name: ""
      tiers:
        - tier_id: tier_494r9f6b
          name: t1
          achieve_value: 10
          rewards_list:
            - pass_id: pass_tbjrmr4k
              rewards:
                reward_id: reward_tbjrmr4k494r9f6b
                item_contents:
                  - item_id: item_MvQGlq1uES
                    amount: 1
                vc_contents: []

3. Field Description​

  • identification: The unique identifier for the current resource, it contains multiple fields:

    • id: the id of goal. Type: string. Length: 1-100.

  • name: the name of goal. Type: string. Length: 1-100.

  • type: the type of goal. Type: string, Simple/Hyper

  • desc: the description of goal. Type: string. Length: 1-1024.

  • icon: the icon of goal. Type: string. Length: 1-100.

  • tags: the tag array. Type: array\<string>.

  • rewards: the array of reward. Type: array.

    • reward_id: the id of reward. Type: string.

    • item_contents: the array of reward item. Type: array.

      • item_id:the id of item. Type: string.

      • amount: the amount of item. Type: number.

      • item_name:the id of item. Type: string.

      • is_unique: the item is unique or not. Type: boolean.

    • vc_contents:the array of virtual currency. Type: array.

      • currency_code:currency code. Type: string.
      • amount: the amount of currency. Type: number.

  • achieve_value: the value of achieve data. Type: number.

  • achieve_data:

    • algorithm_type : the type of algorithm. Type: string, Absolute Value/Increment Value
    • data_key: the key of achieve data.Type: string.
    • data_src: the type of achieve data.Type: string, Player Data/Virtual Currency

  • passes: the array of passes in hyper goal. Type: array.

    • pass_id: the id of pass.Type: string.
    • name: the name of pass.Type: string.
    • desc: the desc of pass.Type: string.
    • icon: the icon of pass.Type: string.
    • item_id: the id of item in pass.Type: string.
    • item_name: the name of item in pass.Type: string.

  • tiers: the array of tiers in hyper goal. Type: array.

    • tier_id: the id of tier.Type: string.

    • name: the name of tier.Type: string.

    • achieve_value: the achieve value of tier.Type: string.

    • rewards_list: the array of rewards.Type: array.

      • pass_id: the id of pass related to tier.Type: string.

      • rewards: the array of rewards.Type: array.

        • reward_id: the id of reward. Type: string.

        • item_contents: the array of reward item. Type: array.

          • item_id:the id of item. Type: string.
          • amount: the amount of item. Type: number.

        • vc_contents:the array of virtual currency. Type: array.

          • currency_code:currency code. Type: string.
          • amount: the amount of currency. Type: number.