| 1 | # materials API |
| 2 | |
| 3 | ## 模块边界 |
| 4 | |
| 5 | OSS 上传、媒体库、草稿素材、素材组与公开素材查询。 |
| 6 | |
| 7 | ## 文件清单 |
| 8 | |
| 9 | - `material.api.ts` |
| 10 | - `material.constants.ts` |
| 11 | - `material.types.ts` |
| 12 | |
| 13 | ## 接口清单 |
| 14 | |
| 15 | | 方法 | 请求 | 说明 | |
| 16 | | ---------------------------- | ----------------------------------------- | ------------------------------- | |
| 17 | | `apiBatchDeleteMaterials` | `DELETE material/list` | 批量删除草稿 | |
| 18 | | `apiCreateMaterial` | `POST material` | 创建草稿 | |
| 19 | | `apiCreateMaterialGroup` | `POST material/group` | 创建草稿分组 | |
| 20 | | `apiDeleteMaterial` | `DELETE material/{param}` | 删除草稿 | |
| 21 | | `apiDeleteMaterialGroup` | `DELETE material/group/{param}` | 删除草稿分组 | |
| 22 | | `apiFilterDeleteMaterials` | `DELETE material/filter` | 按条件删除草稿 | |
| 23 | | `apiGetDraftInfo` | `GET material/info/{param}` | 获取草稿详情 | |
| 24 | | `apiGetMaterialGroupList` | `GET material/group/list/{param}/{param}` | 获取草稿分组列表 | |
| 25 | | `apiGetMaterialInfo` | `GET material/group/info/{param}` | 获取草稿分组详情 | |
| 26 | | `apiGetMaterialList` | `GET material/list/{param}/{param}` | 获取草稿列表 | |
| 27 | | `apiGetOptimalMaterial` | `GET /material/optimal` | 通过素材组 ID 获取最优素材 | |
| 28 | | `apiGetMaterialGroupByScene` | `GET /material/group/by-scene` | 按使用场景查询素材组 | |
| 29 | | `apiTransferMaterials` | `POST material/transfer` | 草稿转移到其他草稿箱 | |
| 30 | | `apiUpdateMaterial` | `PUT material/info/{param}` | 更新草稿信息 | |
| 31 | | `apiUpdateMaterialGroupInfo` | `POST material/group/info/{param}` | 更新草稿分组信息 | |
| 32 | | `batchDeleteMedia` | `DELETE media/ids` | 批量删除媒体资源 | |
| 33 | | `getMediaList` | `GET media/list/{param}/{param}` | 获取媒体资源列表 | |
| 34 | | `getVideoThumbnail` | `GET assets/thumbnail` | Get Video Thumbnail | |
| 35 | | `transferMedia` | `POST media/transfer` | 媒体资源转移到其他分组 | |
| 36 | | `uploadToOss` | `前端封装` | 上传文件到OSS (前端直传 AWS S3) | |
| 37 | |
| 38 | ## 类型清单 |
| 39 | |
| 40 | | 名称 | 类型 | 说明 | |
| 41 | | ------------------------------- | ----------- | ------------------------------------- | |
| 42 | | `ConfirmUploadData` | `interface` | ConfirmUploadData 数据结构。 | |
| 43 | | `CreateMaterialGroupParams` | `interface` | CreateMaterialGroupParams 请求参数。 | |
| 44 | | `CreateMaterialGroupVo` | `interface` | 创建素材组响应。 | |
| 45 | | `CreateMaterialParams` | `interface` | 创建草稿请求参数。 | |
| 46 | | `GetMaterialGroupBySceneParams` | `interface` | 按使用场景查询素材组请求参数。 | |
| 47 | | `MaterialFilterDeleteParams` | `interface` | MaterialFilterDeleteParams 请求参数。 | |
| 48 | | `MaterialGenerationParams` | `interface` | MaterialGenerationParams 请求参数。 | |
| 49 | | `MaterialGroupBySceneData` | `type` | 按使用场景查询素材组原始响应数据。 | |
| 50 | | `MaterialGroupListFilters` | `interface` | MaterialGroupListFilters 类型。 | |
| 51 | | `MaterialGroupListVo` | `interface` | 素材组列表响应。 | |
| 52 | | `MaterialGroupSceneVo` | `interface` | MaterialGroupSceneVo 响应数据。 | |
| 53 | | `MaterialGroupUseScene` | `type` | MaterialGroupUseScene 类型。 | |
| 54 | | `MaterialListFilters` | `interface` | MaterialListFilters 类型。 | |
| 55 | | `MaterialListQueryParams` | `interface` | 素材列表查询参数。 | |
| 56 | | `MaterialListVo` | `interface` | 素材列表响应。 | |
| 57 | | `MaterialOpenApiResponse` | `type` | 公开素材接口响应包装。 | |
| 58 | | `MaterialPagination` | `interface` | 素材分页信息。 | |
| 59 | | `MediaGroup` | `interface` | MediaGroup 类型。 | |
| 60 | | `MediaItem` | `interface` | MediaItem 数据结构。 | |
| 61 | | `MediaListFilters` | `interface` | 媒体列表查询参数。 | |
| 62 | | `MediaListResponse` | `interface` | 媒体列表响应。 | |
| 63 | | `MediaMetadata` | `interface` | MediaMetadata 类型。 | |
| 64 | | `OptimalMaterialVo` | `interface` | 公开推广码最优素材响应数据。 | |
| 65 | | `PlanStatistics` | `interface` | PlanStatistics 数据结构。 | |
| 66 | | `PromotionMaterial` | `interface` | PromotionMaterial 类型。 | |
| 67 | | `PromotionPlan` | `interface` | PromotionPlan 类型。 | |
| 68 | | `PublishRecord` | `interface` | PublishRecord 数据结构。 | |
| 69 | | `ThumbnailVo` | `interface` | ThumbnailVo 响应数据。 | |
| 70 | | `TransferMaterialParams` | `interface` | TransferMaterialParams 请求参数。 | |
| 71 | | `TransferMediaParams` | `interface` | TransferMediaParams 请求参数。 | |
| 72 | | `TransferMediaResult` | `interface` | 素材转移结果。 | |
| 73 | | `UpdateMaterialGroupParams` | `interface` | 素材组更新请求参数。 | |
| 74 | | `UpdateMaterialParams` | `interface` | 更新草稿请求参数。 | |
| 75 | | `UploadSignData` | `interface` | UploadSignData 数据结构。 | |
| 76 | | `UploadToOssOptions` | `interface` | UploadToOssOptions 数据结构。 | |
| 77 | |
| 78 | ## 常量清单 |
| 79 | |
| 80 | | 名称 | 类型 | 说明 | |
| 81 | | ----------- | ------ | ---------------- | |
| 82 | | `AssetType` | `enum` | AssetType 枚举。 | |
| 83 |