返回介绍

Request v3

发布于 2023-04-06 17:51:14 字数 5620 浏览 0 评论 0 收藏 0

参数说明: 更新 Doc 文档的单个请求

{
  // 下列字段只能填写其中一个
  "ReplaceText":{
    object(ReplaceText)
  },
  "insertText":{
    object(InsertText)
  },
  "DeleteContent":{
    object(DeleteContent)
	},
  "insertImage":{
    object(InsertImage)
  },
  "insertPageBreak":{
    object(InsertPageBreak)
  },
  "insertTable":{
    object(InsertTable)
  },
  "insertParagraph": {
    object(InsertParagraph)
  },
  "updateTextProperty":{
    object(UpdateTextProperty)
  },
  "insertComment": {
    object(InsertComment)
  }, 
  "deleteComment": {
    object(DeleteComment)
  }
  // TODO: 待补充
}
参数名称 类型 描述
replaceText object(ReplaceText

说明: 替换指定位置的文本内容。

{
  "text": string,
  "ranges": [
    object(Range)
  ]
}
参数名称 类型 描述
text string 要替换的文本
ranges[] Object(Range

说明: 文档范围。

{
  "startIndex": int,
  "length": int
}
参数名称 类型 描述
startIndex integer 文档指定范围的起始位置
length integer 文档指定范围的长度

InsertText

说明: 在指定位置插入文本内容。

{
  "text": string,
  "location": object(Location)
}
参数名称 类型 描述
text string 要插入的文本内容
location Object(Location

说明: 文档指定位置。

{
  "index": int,
}
参数名称 类型 描述
index integer 文档指定位置

DeleteContent

说明: 删除指定位置的内容。

{
  "range": object(Range)
}
参数名称 类型 描述
range Object(InsertImage

说明: 在指定位置插入图片

{
  "imageId": string,
  "location": object(Location)
}
参数名称 类型 描述
imageId string 使用图片上传接口获取 imageId
location Object(InsertPageBreak

说明: 在指定位置插入分页符

{
  "location": object(Location)
}
参数名称 类型 描述
location Object(InsertTable

说明: 在指定位置插入表格

{
  "rows": int,
  "cols": int
  "location": object(Location)
}

注意: 插入的表格单元格数量不能超过1000。

参数名称 类型 是否必填 描述
rows integer 插入的表格的行数,行数需要大于0,小于100
cols integer 插入的表格的列数,列数需要大于0,小于60
location Object(InsertParagraph

说明: 在指定位置插入段落

{
  "location": object(Location)
}
参数名称 类型 描述
location Object(UpdateTextProperty

说明: 更新指定位置文本属性

{
  "textProperty": object(TextProperty),
  "ranges": [
    object(Range)
  ]
}
参数名称 类型 描述
textProperty Object(TextProperty

说明: 文本属性

{
  "bold": bool,
  "color": string,
  "backgroundColor": string
}
参数名称 类型 描述
bold bool 是否加粗
color string 文字的颜色,颜色使用十六进制,RRGGBB 格式
backgroundColor string 文字的背景颜色,颜色使用十六进制,RRGGBB 格式

InsertComment

说明: 在指定位置插入批注

{
  "text":  string,
  "Range": object(Range)
}
参数名称 类型 描述
text string 评论内容
range Object(DeleteComment

说明: 删除指定批注

{
  "id":  string,
  "refId": string
}
参数名称 类型 描述
id string 批注 ID, 可通过 获取 Doc 文档内容 获取
refId string 批注组 ID, 可通过 获取 Doc 文档内容 获取

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文