文档

文档转换

更新时间:

通过文档格式转换功能,您可以灵活地处理各种文档类型,将其转换为适合自身需求的输出文档类型,并根据需要将转换后的文档保存在指定的OSS路径中,以便后续的应用和使用。本文介绍文档转换处理功能参数及示例。

使用场景

  • 在线预览优化:用户上传不同格式的文档,如PDF、Word、Excel、PPT等至OSS,为了方便用户直接在网页端或者移动端应用中预览这些文档,无需下载到本地再打开,可以调用智能媒体管理服务提供的文档转换接口。文档会被转换成图片以适合在线展示。

  • 跨平台兼容性:不同设备和操作系统对各种文件格式支持程度不一,通过OSS文档转换服务,可以让所有用户无论使用何种设备都能顺畅地查看文档。

注意事项

  • 文档转换仅支持异步处理(x-oss-async-process处理方式)。

  • 使用文档转换前,需要先绑定IMM Project。关于控制台和API如何绑定,请参见快速入门AttachOSSBucket

  • 不支持匿名访问。

  • 必须拥有IMM处理所需的相关权限。更多信息,请参见权限

参数说明

操作名称:doc/convert

具体参数如下表所示。

参数名称

类型

是否必须

描述

target

string

目标文件类型。取值:

  • pdf

  • png

  • jpg

  • txt

    说明

    仅Word文档和PPT文档支持转换为TXT格式。

source

string

源文件类型,默认取文件扩展名。当OSS文件没有扩展名时,可以设置此参数,取值:

  • Word文档:doc、docx、wps、wpss、docm、dotm、dot、dotx、html

  • PPT文档:pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm、dpss

  • Excel文档:xls、xlt、et、ett、xlsx、xltx、csv、xlsb、xlsm、xltm、ets

  • PDF文档:pdf

pages

string

转换的页码,需经过URL安全的Base64编码。具体操作,请参见水印编码

例如:1,2,4-10表示转换第1页、第2页、第4页~第10页。

文档转换时也会用到sys/saveasnotify参数。更多信息,请参见另存为消息通知

使用REST API

转换信息

  • 转换前

    • 文档格式:DOCX

    • 文档名称:example.docx

  • 处理方式:文档格式转换

  • 转换后

    • 文件格式:PNG

    • 文件存储路径:oss://test-bucket/doc_images/{index}.png

      • b_dGVzdC1idWNrZXQ:转码完成后保存到名为test-bucket的Bucket中。(dGVzdC1idWNrZXQ是test-bucket进行Base64编码后的值)。

      • o_ZG9jX2ltYWdlcy97aW5kZXh9LnBuZw:object使用{index}变量以example.docx页码作为图片文件名保存到doc_images目录下(ZG9jX2ltYWdlcy97aW5kZXh9LnBuZw是doc_images/{index}.png进行Base64编码之后的值)。

    • 转换完成消息通知:发送到主题为doc_images的MNS

处理示例

 // 将文件example.docx转换为PNG格式的图片文件。
POST /exmaple.docx?x-oss-async-process HTTP/1.1
Host: doc-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 28 Oct 2022 06:40:10 GMT
Authorization: OSS qn6qrrqxo2oawuk53otf****:UNQDb7GapEgJkcde6OhZ9J****
 
x-oss-async-process=doc/convert,target_png,source_docx|sys/saveas,b_dGVzdC1idWNrZXQ,o_ZG9jX2ltYWdlcy97aW5kZXh9LnBuZw/notify,topic_ZG9jX2ltYWdlcw

使用SDK

文档转换仅支持异步处理,SDK使用方法请参见使用SDK

常见问题

OSS文档转换支持转换Excel表指定sheet页的内容么?

不支持。OSS文档转换仅支持转换Excel表所有sheet页的内容。如果您需要转换特定sheet页,建议调用IMM的CreateOfficeConversionTask - 创建文档转换任务接口,设置SheetIndex参数。

相关文档

文档格式转换

  • 本页导读 (1)
文档反馈