gacha 招募

招募信息处理模块。

from bestdori import gacha

类型定义

GachaInfo 招募信息

招募详细信息字典。 all.{index}.json 信息字典为该字典中选取部分字段信息。

字段名	类型	描述
gachaName	List[str | None]	招募名定长列表
resourceName	str	资源库名称
bannerAssetBundleName	str	横幅图片资源库名称
publishedAt	List[str | None]	招募发布时间戳定长列表
type	str	招募类型
newCards	List[int]	新卡牌 ID 列表
closedAt	List[str | None]	招募结束时间戳定长列表
details	List[Dict[str, Detail] | None]	招募详细信息字典定长列表
rate	List[Dict[str, Rate] | None]	招募比率字典定长列表
paymentMethods	List[PaymentMethod]	付费方式列表
description	List[str | None]	招募描述定长列表
annotation	List[str | None]	招募注释定长列表
gachaPeriod	List[str | None]	招募时间戳定长列表
information	Information	招募信息

Detail 招募详细信息

字段名	类型	描述
rarityIndex	int	稀有度索引
weight	int	权重
pickup	bool	是否为 UP 卡

Rate 招募比率

字段名	类型	描述
rate	float	招募比率
weightTotal	int	权重总和

PaymentMethod 付费方式

字段名	类型	描述
gachaId	int	招募 ID
paymentMethod	str	付费方式
quantity	int	购买数量
paymentMethodId	int	付费方式 ID
count	int	购买次数
behavior	str	购买行为
pickup	bool	是否为 UP 卡
costItemQuantity	int	消耗物品数量
discountType	int	折扣类型
ticketId NotRequired	int	票券 ID

Information 招募信息

字段名	类型	描述
description	List[str | None]	招募详细描述定长列表
term	List[str | None]	招募时期说明定长列表
newMemberInfo	List[str | None]	新成员说明定长列表
notice	List[str | None]	招募备注信息定长列表

def get_all() async

参数名	类型	默认值	描述
index	int	0	指定获取的 JSON 信息
me keyword	Optional[Me]	None	登录用户类

获取总招募信息，返回以招募 ID 为字段名、 GachaAllInfo 为字段值的信息字典， GachaAllInfo 为从 GachaInfo 中截取出的部分信息。根据 index 参数值不同，获取到的 GachaAllInfo 所包含的信息也不同。

特别地，当 index 值为 0 时，返回值为以招募 ID 为字段名、 NoneDict 为字段值的字典

index 可用参数值

参数值	获取字段值末项字段名
0	-
1	gachaName
3	newCards
5	closedAt

返回值: Dict[str, GachaAllInfo | NoneDict]

class Gacha()

招募类，包含各种招募相关资源整合。

def init()

参数名	类型	默认值	描述
id	int	-	招募 ID
me keyword	Optional[Me]	None	登录用户类

def get_info() async

获取招募信息。

返回值: GachaInfo

def get_comment() async

参数名	类型	默认值	描述
limit	int	20	获取到的帖子数量上限
offset	int	0	获取帖子时的偏移量
order	Order	'TIME_ASC'

获取招募的社区评论列表。

返回值: PostList

def get_banner() async

参数名	类型	默认值	描述
server	ServerName	-	服务器名

获取招募缩略图资源。

返回值: bytes

def get_pickups() async

参数名	类型	默认值	描述
server	ServerName	-	服务器名

获取招募 pickup 图像资源。

返回值: List[bytes]

def get_logo() async

参数名	类型	默认值	描述
server	ServerName	-	服务器名

获取招募 LOGO 图像资源。

返回值: bytes