简介
本文档提供关于文档预览同步请求的 API 概览以及 SDK 示例代码。
API | 说明 |
用于同步请求文档预览功能 |
同步请求接口
功能说明
文档转码同步请求。
示例代码
function previewDocumentAsync() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var key = 'test.docx';var host = config.Bucket + '.cos.' + config.Region + '.myqcloud.com/' + key;var url = 'https://' + host;cos.request({Method: 'GET',Key: key,Url: url,Query: {ObjectKey: key, /* 对象文件名 */'ci-process': 'doc-preview', /* 必须,数据万象处理能力,文档预览固定为 doc-preview */},},function(err, data){console.log(err || data);});}previewDocumentAsync();
参数说明
通用请求参数
名称 | 描述 | 类型 | 是否必选 |
ObjectKey | 对象文件名,例如 folder/document.pdf | String | 是 |
ci-process | 数据万象处理能力,文档预览固定为 doc-preview | String | 是 |
srcType | 源数据的后缀类型,当前文档转换根据 COS 对象的后缀名来确定源数据类型。当 COS 对象没有后缀名时,可以设置该值 | String | 否 |
page | 需转换的文档页码,默认从1开始计数;表格文件中 page 表示转换的第 X 个 sheet 的第 X 张图 | Int | 否 |
dstType | 转换输出目标文件类型: png,转成 png 格式的图片文件 jpg,转成 jpg 格式的图片文件 pdf,转成 pdf 格式文件。 无法选择页码,page 参数不生效 如果传入的格式未能识别,默认使用 jpg 格式 | String | 否 |
password | Office 文档的打开密码,如果需要转换有密码的文档,请设置该字段 | String | 否 |
comment | 是否隐藏批注和应用修订,默认为0 0:隐藏批注,应用修订 1:显示批注和修订 | Int | 否 |
适用于表格文件(Excel)的参数
名称 | 描述 | 类型 | 是否必选 |
sheet | 表格文件参数,转换第 X 个表,默认为1 | Int | 否 |
excelPaperDirection | 表格文件转换纸张方向,0代表垂直方向,非0代表水平方向,默认为0 | Int | 否 |
excelPaperSize | 设置纸张(画布)大小,对应信息为: 0 → A4 、 1 → A2 、 2 → A0 ,默认 A4 纸张 | Int | 否 |
适用于转码成 png/jpg 图片的参数
名称 | 描述 | 类型 | 是否必选 |
ImageParams | String | 否 | |
quality | 生成预览图的图片质量,取值范围为 [1, 100],默认值100。 例如取值为100,代表生成图片质量为100% | Int | 否 |
scale | 预览图片的缩放参数,取值范围为 [10, 200], 默认值100。 例如取值为200,代表图片缩放比例为200% 即放大两倍 | Int | 否 |
imageDpi | 按指定 dpi 渲染图片,该参数与 scale 共同作用,取值范围 96-600 ,默认值为 96 。转码后的图片单边宽度需小于65500像素 | Int | 否 |