简介
本文档提供关于文档预览的相关的 API 概览以及 SDK 示例代码。
API | 操作名 | 操作描述 |
文档转码 | 文档转码同步请求 | 获取文档转码的请求 URL |
文档转码同步请求
功能说明
文档转码同步请求,获取文档转码的请求 URL。注意:使用此接口前,请确保已打开官网控制台中数据处理下的文档处理开关,否则会报错 doc bucket unbinded, bucket's host is unavailable
。如需使用文档转 HTML 功能,可直接将请求参数置于 URL 后方,SDK 仅负责签名计算操作。
示例代码
<?php
require dirname(__FILE__, 2) . '/vendor/autoload.php';
$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\Cos\Client( array( 'region' => $region, 'scheme' => 'https', //协议头部,默认为http 'credentials'=> array( 'secretId' => $secretId , 'secretKey' => $secretKey)));try { // 1. 文档转码 https://cloud.tencent.com/document/product/460/47074 $bucket = 'examplebucket-1250000000'; $key = 'exampleobject'; $url = $cosClient->getObjectUrl($bucket, $key); $params = array( 'ci-process' => 'doc-preview',// 'srcType' => '', 'page' => 3, 'dstType' => 'png',// 'password' => '',// 'comment' => '',// 'sheet' => '',// 'excelPaperDirection' => '',// 'excelRow' => '',// 'excelCol' => '',// 'excelPaperSize' => '',// 'txtPagination' => '', 'ImageParams' => 'imageMogr2/thumbnail/!50p',// 'quality' => '',// 'scale' => '',// 'imageDpi' => '', ); $query = http_build_query($params); echo $url . $query; // 生成的可访问链接} catch (\Exception $e) { // 请求失败 echo($e);}
参数说明
通用请求参数:
名称 | 描述 | 类型 | 是否必选 |
Key | 对象文件名,例如 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 参数不生效;txt:转成 txt 格式文件。如果传入的格式未能识别,默认使用 jpg 格式。 | String | 否 |
password | Office 文档的打开密码,如果需要转换有密码的文档,请设置该字段 | String | 否 |
comment | 是否隐藏批注和应用修订,默认为0。0:隐藏批注,应用修订 1:显示批注和修订 | Int | 否 |
适用于表格文件(Excel)的参数:
名称 | 描述 | 类型 | 是否必选 |
sheet | 表格文件参数,转换第 X 个表,默认为1 | Int | 否 |
excelPaperDirection | 表格文件转换纸张方向,0代表垂直方向,非0代表水平方向,默认为0 | Int | 否 |
excelRow | 值为1 表示将所有列放到1页进行排版,默认值为0 |
Int | 否 |
excelCol | 值为1 表示将所有行放到1页进行排版,默认值为0 |
Int | 否 |
excelPaperSize | 设置纸张(画布)大小,对应信息为: 0 → A4 、 1 → A2 、 2 → A0 ,默认 A4 纸张 (需配合 excelRow 或 excelCol 一起使用) |
Int | 否 |
适用于转码成 txt 的参数:
名称 | 描述 | 类型 | 是否必选 |
txtPagination | 是否转换成长文本,设置为 true 时,可以将需要导出的页中的文字合并导出,分页范围可以通过 Ranges 控制。默认值为 false ,按页导出 txt。( ExportType="txt" 时生效) |
Bool | 否 |
适用于转码成 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 | 否 |
注意:目前支持的输入文件类型包含如下格式:演示文件:pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm。文字文件:doc、dot、wps、wpt、docx、dotx、docm、dotm。表格文件:xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets。
表格文件,一张表可能分割为多页转换,生成多张图片。其他格式文件: pdf、 lrc、 c、 cpp、 h、 asm、 s、 java、 asp、 bat、 bas、 prg、 cmd、 rtf、 txt、 log、 xml、 htm、 html。输入文件大小限制在200MB之内。输入文件页数限制在5000页之内。
返回结果示例
同步请求URLhttps://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/example.ppt?sign=q-sign-algorithmxxxxxxxxxxxxx&ci-process=doc-preview&page=1&dstType=png
对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/145956.html