排行榜配置

表示排行榜的配置。

有关此资源的方法列表,请参阅此页末尾。

资源表示

这是一个排行榜配置资源的 JSON 模板。

{
  "kind": "gamesConfiguration#leaderboardConfiguration",
  "token": string,
  "id": string,
  "scoreOrder": string,
  "scoreMin": long,
  "scoreMax": long,
  "draft": {
    "kind": "gamesConfiguration#leaderboardConfigurationDetail",
    "name": {
      "kind": "gamesConfiguration#localizedStringBundle",
      "translations": [
        {
          "kind": "gamesConfiguration#localizedString",
          "locale": string,
          "value": string
        }
      ]
    },
    "iconUrl": string,
    "sortRank": integer,
    "scoreFormat": {
      "numberFormatType": string,
      "suffix": {
        "zero": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "one": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "two": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "few": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "many": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "other": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        }
      },
      "numDecimalPlaces": integer,
      "currencyCode": string
    }
  },
  "published": {
    "kind": "gamesConfiguration#leaderboardConfigurationDetail",
    "name": {
      "kind": "gamesConfiguration#localizedStringBundle",
      "translations": [
        {
          "kind": "gamesConfiguration#localizedString",
          "locale": string,
          "value": string
        }
      ]
    },
    "iconUrl": string,
    "sortRank": integer,
    "scoreFormat": {
      "numberFormatType": string,
      "suffix": {
        "zero": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "one": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "two": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "few": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "many": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        },
        "other": {
          "kind": "gamesConfiguration#localizedStringBundle",
          "translations": [
            {
              "kind": "gamesConfiguration#localizedString",
              "locale": string,
              "value": string
            }
          ]
        }
      },
      "numDecimalPlaces": integer,
      "currencyCode": string
    }
  }
}
属性名称 描述 备注
kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#leaderboardConfiguration
token 字符串 此资源的令牌。
id 字符串 排行榜的 ID。
scoreOrder 字符串 排行榜的类型。
可能的值为
  • "LARGER_IS_BETTER" - 发布的较高分数排名更高。
  • "SMALLER_IS_BETTER" - 发布的较低分数排名更高。
scoreMin 长整型 可以发布到此排行榜的最低分数。
scoreMax 长整型 可以发布到此排行榜的最高分数。
draft 嵌套对象 排行榜的草稿数据。
draft.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#leaderboardConfigurationDetail
draft.name 嵌套对象 排行榜名称的本地化字符串。
draft.name.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
draft.name.translations[] 列出 语言环境字符串。
draft.name.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
draft.name.translations[].locale 字符串 语言环境字符串。
draft.name.translations[].value 字符串 字符串值。
draft.iconUrl 字符串 此排行榜的图标网址。对此字段的写入操作将被忽略。
draft.sortRank 整数 此排行榜的排序等级。对此字段的写入操作将被忽略。
draft.scoreFormat 嵌套对象 排行榜的分数格式。
draft.scoreFormat.numberFormatType 字符串 数字的格式。
可能的值为
  • "NUMERIC" - 数字的格式不包含任何数字或根据语言环境在小数点后具有固定数量的数字。可以添加可选的自定义单位。
  • "TIME_DURATION" - 数字的格式为小时、分钟和秒。
  • "CURRENCY" - 数字的格式为根据语言环境的货币。
draft.scoreFormat.suffix 嵌套对象 NUMERIC 格式类型的可选后缀。这些字符串遵循与所有 Android 字符串资源相同的复数规则
draft.scoreFormat.suffix.zero 嵌套对象 当语言需要对数字 0 进行特殊处理时(如阿拉伯语)。
draft.scoreFormat.suffix.zero.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
draft.scoreFormat.suffix.zero.translations[] 列出 语言环境字符串。
draft.scoreFormat.suffix.zero.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
draft.scoreFormat.suffix.zero.translations[].locale 字符串 语言环境字符串。
draft.scoreFormat.suffix.zero.translations[].value 字符串 字符串值。
draft.scoreFormat.suffix.one 嵌套对象 当语言需要对诸如“一”之类的数字进行特殊处理时(如英语和大多数其他语言中的数字 1;在俄语中,任何以 1 结尾但不以 11 结尾的数字都属于此类)。
draft.scoreFormat.suffix.one.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
draft.scoreFormat.suffix.one.translations[] 列出 语言环境字符串。
draft.scoreFormat.suffix.one.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
draft.scoreFormat.suffix.one.translations[].locale 字符串 语言环境字符串。
draft.scoreFormat.suffix.one.translations[].value 字符串 字符串值。
draft.scoreFormat.suffix.two 嵌套对象 当语言需要对诸如“二”之类的数字进行特殊处理时(如威尔士语中的 2 或斯洛文尼亚语中的 102)。
draft.scoreFormat.suffix.two.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
draft.scoreFormat.suffix.two.translations[] 列出 语言环境字符串。
draft.scoreFormat.suffix.two.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
draft.scoreFormat.suffix.two.translations[].locale 字符串 语言环境字符串。
draft.scoreFormat.suffix.two.translations[].value 字符串 字符串值。
draft.scoreFormat.suffix.few 嵌套对象 当语言需要对“小”数字进行特殊处理时(例如捷克语中的 2、3 和 4;或波兰语中以 2、3 或 4 结尾但不是 12、13 或 14 的数字)。
draft.scoreFormat.suffix.few.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
draft.scoreFormat.suffix.few.translations[] 列出 语言环境字符串。
draft.scoreFormat.suffix.few.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
draft.scoreFormat.suffix.few.translations[].locale 字符串 语言环境字符串。
draft.scoreFormat.suffix.few.translations[].value 字符串 字符串值。
draft.scoreFormat.suffix.many 嵌套对象 当语言需要对“大”数字进行特殊处理时(例如马耳他语中以 11-99 结尾的数字)。
draft.scoreFormat.suffix.many.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
draft.scoreFormat.suffix.many.translations[] 列出 语言环境字符串。
draft.scoreFormat.suffix.many.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
draft.scoreFormat.suffix.many.translations[].locale 字符串 语言环境字符串。
draft.scoreFormat.suffix.many.translations[].value 字符串 字符串值。
draft.scoreFormat.suffix.other 嵌套对象 当语言不需要对给定数量进行特殊处理时(例如汉语中的所有数字,或英语中的 42)。
draft.scoreFormat.suffix.other.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
draft.scoreFormat.suffix.other.translations[] 列出 语言环境字符串。
draft.scoreFormat.suffix.other.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
draft.scoreFormat.suffix.other.translations[].locale 字符串 语言环境字符串。
draft.scoreFormat.suffix.other.translations[].value 字符串 字符串值。
draft.scoreFormat.numDecimalPlaces 整数 数字的小数位数。仅用于 NUMERIC 格式类型。
draft.scoreFormat.currencyCode 字符串 货币代码字符串。仅用于 CURRENCY 格式类型。
published 嵌套对象 排行榜的已发布数据。此数据为只读。
published.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#leaderboardConfigurationDetail
published.name 嵌套对象 排行榜名称的本地化字符串。
published.name.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
published.name.translations[] 列出 语言环境字符串。
published.name.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
published.name.translations[].locale 字符串 语言环境字符串。
published.name.translations[].value 字符串 字符串值。
published.iconUrl 字符串 此排行榜的图标网址。对此字段的写入操作将被忽略。
published.sortRank 整数 此排行榜的排序等级。对此字段的写入操作将被忽略。
published.scoreFormat 嵌套对象 排行榜的分数格式。
published.scoreFormat.numberFormatType 字符串 数字的格式。
可能的值为
  • "NUMERIC" - 数字的格式不包含任何数字或根据语言环境在小数点后具有固定数量的数字。可以添加可选的自定义单位。
  • "TIME_DURATION" - 数字的格式为小时、分钟和秒。
  • "CURRENCY" - 数字的格式为根据语言环境的货币。
published.scoreFormat.suffix 嵌套对象 NUMERIC 格式类型的可选后缀。这些字符串遵循与所有 Android 字符串资源相同的复数规则
published.scoreFormat.suffix.zero 嵌套对象 当语言需要对数字 0 进行特殊处理时(如阿拉伯语)。
published.scoreFormat.suffix.zero.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
published.scoreFormat.suffix.zero.translations[] 列出 语言环境字符串。
published.scoreFormat.suffix.zero.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
published.scoreFormat.suffix.zero.translations[].locale 字符串 语言环境字符串。
published.scoreFormat.suffix.zero.translations[].value 字符串 字符串值。
published.scoreFormat.suffix.one 嵌套对象 当语言需要对诸如“一”之类的数字进行特殊处理时(如英语和大多数其他语言中的数字 1;在俄语中,任何以 1 结尾但不以 11 结尾的数字都属于此类)。
published.scoreFormat.suffix.one.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
published.scoreFormat.suffix.one.translations[] 列出 语言环境字符串。
published.scoreFormat.suffix.one.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
published.scoreFormat.suffix.one.translations[].locale 字符串 语言环境字符串。
published.scoreFormat.suffix.one.translations[].value 字符串 字符串值。
published.scoreFormat.suffix.two 嵌套对象 当语言需要对诸如“二”之类的数字进行特殊处理时(如威尔士语中的 2 或斯洛文尼亚语中的 102)。
published.scoreFormat.suffix.two.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
published.scoreFormat.suffix.two.translations[] 列出 语言环境字符串。
published.scoreFormat.suffix.two.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
published.scoreFormat.suffix.two.translations[].locale 字符串 语言环境字符串。
published.scoreFormat.suffix.two.translations[].value 字符串 字符串值。
published.scoreFormat.suffix.few 嵌套对象 当语言需要对“小”数字进行特殊处理时(例如捷克语中的 2、3 和 4;或波兰语中以 2、3 或 4 结尾但不是 12、13 或 14 的数字)。
published.scoreFormat.suffix.few.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
published.scoreFormat.suffix.few.translations[] 列出 语言环境字符串。
published.scoreFormat.suffix.few.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
published.scoreFormat.suffix.few.translations[].locale 字符串 语言环境字符串。
published.scoreFormat.suffix.few.translations[].value 字符串 字符串值。
published.scoreFormat.suffix.many 嵌套对象 当语言需要对“大”数字进行特殊处理时(例如马耳他语中以 11-99 结尾的数字)。
published.scoreFormat.suffix.many.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
published.scoreFormat.suffix.many.translations[] 列出 语言环境字符串。
published.scoreFormat.suffix.many.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
published.scoreFormat.suffix.many.translations[].locale 字符串 语言环境字符串。
published.scoreFormat.suffix.many.translations[].value 字符串 字符串值。
published.scoreFormat.suffix.other 嵌套对象 当语言不需要对给定数量进行特殊处理时(例如汉语中的所有数字,或英语中的 42)。
published.scoreFormat.suffix.other.kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedStringBundle
published.scoreFormat.suffix.other.translations[] 列出 语言环境字符串。
published.scoreFormat.suffix.other.translations[].kind 字符串 唯一标识此资源的类型。值始终是固定字符串gamesConfiguration#localizedString
published.scoreFormat.suffix.other.translations[].locale 字符串 语言环境字符串。
published.scoreFormat.suffix.other.translations[].value 字符串 字符串值。
published.scoreFormat.numDecimalPlaces 整数 数字的小数位数。仅用于 NUMERIC 格式类型。
published.scoreFormat.currencyCode 字符串 货币代码字符串。仅用于 CURRENCY 格式类型。

方法

删除
删除具有给定 ID 的排行榜配置。
获取
检索具有给定 ID 的排行榜配置的元数据。
插入
在此应用程序中插入新的排行榜配置。
列出
返回此应用程序中排行榜配置的列表。
更新
更新具有给定 ID 的排行榜配置的元数据。