生成同步预览链接

最近更新时间:2023-05-17 10:47:37

我的收藏

简介

本文档提供关于数据万象文档处理任务的相关 API 概览以及 SDK 示例代码。
API
操作描述
生成同步预览转图片链接
生成同步预览转 HTML 链接

基本操作

同步预览转图片/HTML

功能说明

生成同步预览转图片或 HTML 链接,通过同一接口的不同参数实现。

方法原型

String GenerateDocPreviewUrl(DocHtmlRequest docJobRequest);

参数说明

DocHtmlRequest 中的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
objectKey
COS 存储桶中的图片文件名称,COS 存储桶由Host指定,例如在北京的 examplebucket-1250000000存储桶中的目录 test 下的文件 img.jpg,则 Host 填写 examplebucket-1250000000.cos.ap-beijing.myqcloud.com,ObjectKey 填写 test/img.jpg
String
srcType
源数据的后缀类型,当前文档转换根据 COS 对象的后缀名来确定源数据类型。当 COS 对象没有后缀名时,可以设置该值
String
page
需转换的文档页码,默认从1开始计数;表格文件中 page 表示转换的第 X 个 sheet 的第 X 张图
Int
dstType
转换输出目标文件类型:
png,转成 png 格式的图片文件
jpg,转成 jpg 格式的图片文件
pdf,转成 pdf 格式文件。 无法选择页码,page 参数不生效
html,转成 html 在线文档
如果传入的格式未能识别,默认使用 jpg 格式,SDK 默认值为 html
String
password
Office 文档的打开密码,如果需要转换有密码的文档,请设置该字段
String
comment
是否隐藏批注和应用修订,默认为0
0:隐藏批注,应用修订
1:显示批注和修订
Int
ImageParams
转换后的图片处理参数,支持 基础图片处理 所有处理参数,多个处理参数可通过 管道操作符 分隔,从而实现在一次访问中按顺序对图片进行不同处理
String
quality
生成预览图的图片质量,取值范围为 [1, 100],默认值100。 例如取值为100,代表生成图片质量为100%
Int
scale
预览图片的缩放参数,取值范围为 [10, 200], 默认值100。 例如取值为200,代表图片缩放比例为200%即放大两倍
Int
imageDpi
按指定 dpi 渲染图片,该参数与 scale 共同作用,取值范围 96-600 ,默认值为 96 。转码后的图片单边宽度需小于65500像素
Int

返回结果说明

成功:返回预览链接。
失败:发生错误(如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

请求示例

//1.创建请求对象
DocHtmlRequest request = new DocHtmlRequest();
//2.添加请求参数,参数详情请见 API 接口文档
request.setBucketName("markjrzhang-1251704708");
//如果需要转为图片 dstType 为 DocHtmlRequest.DocType.jpg
request.setDstType(DocHtmlRequest.DocType.html);
request.setObjectKey("1.pptx");
request.setPage("1");
//3.调用接口,获取任务响应对象
String previewUrl = client.GenerateDocPreviewUrl(request);
System.out.println(previewUrl);