spread · 推广

import { SpreadDomain } from '@hfyidu/api/spread'

推广领域负责根据推广 ID 拉取推广落地页所需的推广信息（分销/裂变落地页配置、跳转目标、企业微信客服链接等），服务前缀 spread。

用例总览

用例	说明	请求方式
`SpreadDomain.cases.info`	获取推广信息	`GET spread/info`

const { data } = await SpreadDomain.cases.info.run({
  spread_id: 1001,
})

console.log(data) // SpreadInfoDto

字段	类型	必填	说明
`spread_id`	`number`	是	推广 ID

SpreadInfoDto

字段	类型	后台原始字段	说明
`id`	`number`	`id`	推广记录 ID，必填
`installNumber`	`number`	`force_desk_num`	要求安装/加桌数量，默认 `0`
`appId`	`number`	`app_id`	关联的应用 ID，默认 `0`
`type`	`number`	`spread_type`	推广类型，默认 `1`
`theatre_id`	`number \| null`	`theatre_id`	关联的短剧剧场 ID，默认 `null`
`collect_id`	`number \| null`	`collect_id`	关联的合集 ID，默认 `null`
`collect_number`	`number \| null`	`collect_number`	合集集数，默认 `null`
`book_id`	`number \| null`	`book_id`	关联的小说 ID，默认 `null`
`chapter_id`	`number \| null`	`chapter_id`	关联的章节 ID，默认 `null`
`chapter_number`	`number \| null`	`chapter_number`	章节序号，默认 `null`
`ad_id`	`number \| null`	`ad_id`	关联的广告 ID，默认 `null`
`remark`	`string`	`remark`	备注，默认 `''`
`is_active`	`number`	`is_active`	是否启用，默认 `0`
`check_status`	`number`	`check_status`	审核状态，默认 `0`
`open_status`	`number`	`open_status`	开启状态，默认 `1`
`corpId`	`string`	`corp_id`	企业微信企业 ID，默认 `''`
`baseCorpId`	`string`	`base_corpid`	企业微信基准企业 ID，默认 `''`
`wecomCustomerUrl`	`string`	`wecom_customer_url`	企业微信客服链接，默认 `''`
`config`	`SpreadInfoConfigDto`	`rollback_config`	落地页兜底跳转配置，默认新建一个 `SpreadInfoConfigDto` 实例，见下表

SpreadInfoDto 还内部持有两个私有字段（不建议业务代码直接读取，请使用下方对应的只读 getter）：

私有字段	类型	后台原始字段	说明
`force_desk_switch`	`number`	`force_desk_switch`	是否强制要求加桌的开关原始值，默认 `1`
`spread_with_video`	`number`	`spread_with_video`	是否伴随短剧推广的原始值，默认 `0`

对应的只读 getter：

Getter	类型	说明
`installMustStatus`	`boolean`	是否强制要求安装/加桌，等价于 `force_desk_switch !== 0`
`spreadWithVideo`	`boolean`	是否为短剧类推广，等价于 `spread_with_video === 1`

SpreadInfoConfigDto

字段	类型	后台原始字段	说明
`appInfo`	`SpreadInfoConfigAppDto`	`appInfo`	兜底跳转的目标应用信息，默认新建一个 `SpreadInfoConfigAppDto` 实例，见下表
`page`	`string \| null`	`page`	兜底跳转的目标页面路径，默认 `null`
`type`	`number`	`rollback_type`	兜底跳转类型，默认 `0`

SpreadInfoConfigAppDto

字段	类型	后台原始字段	说明
`id`	`number`	`id`	目标应用 ID，默认 `0`
`appName`	`string`	`app_name`	目标应用名称，默认 `''`
`type`	`string`	`app_type`	目标应用类型，默认 `''`
`appId`	`string`	`mini_app_id`	目标小程序 AppID，默认 `''`
`originalId`	`string`	`original_app_id`	目标小程序原始 ID，默认 `''`

该领域暂未定义业务枚举。