请求
要应用于演示的单个更新类型。
| JSON 表示法 |
|---|
{ // Union field |
| 字段 | |
|---|---|
联合字段 kind。更新类型。必须提供且只提供一个字段。
kind 只能是下列其中一项:
|
|
createSlide
|
创建新幻灯片。 |
createShape
|
创建新形状。 |
createTable
|
创建新表。 |
insertText
|
将文字插入形状或表格单元格。 |
insertTableRows
|
将行插入到表中。 |
insertTableColumns
|
将列插入到表中。 |
deleteTableRow
|
从表中删除行。 |
deleteTableColumn
|
从表中删除列。 |
replaceAllText
|
替换指定文本的所有实例。 |
deleteObject
|
从演示文稿中删除页面或页面元素。 |
updatePageElementTransform
|
更新页面元素的转换。 |
updateSlidesPosition
|
更新演示文稿中一组幻灯片的位置。 |
deleteText
|
从形状或表格单元格中删除文字。 |
createImage
|
创建图片。 |
createVideo
|
创建视频。 |
createSheetsChart
|
创建嵌入式 Google 表格图表。 |
createLine
|
创建一条线。 |
refreshSheetsChart
|
刷新 Google 表格图表。 |
updateShapeProperties
|
更新 |
updateImageProperties
|
更新 |
updateVideoProperties
|
更新 |
updatePageProperties
|
更新 |
updateTableCellProperties
|
更新 |
updateLineProperties
|
更新 |
createParagraphBullets
|
为段落创建项目符号。 |
replaceAllShapesWithImage
|
将符合某些条件的所有形状替换为图片。 |
duplicateObject
|
复制幻灯片或网页元素。 |
updateTextStyle
|
|
replaceAllShapesWithSheetsChart
|
将符合某些条件的所有形状替换为 Google 表格图表。 |
deleteParagraphBullets
|
从段落中删除项目符号。 |
updateParagraphStyle
|
|
updateTableBorderProperties
|
更新 |
updateTableColumnProperties
|
更新 |
updateTableRowProperties
|
更新 |
mergeTableCells
|
合并 |
unmergeTableCells
|
取消合并 |
groupObjects
|
对对象(例如网页元素)进行分组。 |
ungroupObjects
|
取消分组对象,例如 |
updatePageElementAltText
|
更新 |
replaceImage
|
用新图片替换现有图片。 |
updateSlideProperties
|
更新幻灯片的属性 |
updatePageElementsZOrder
|
更新 |
updateLineCategory
|
更新 |
rerouteLine
|
重新路由 |
CreateSlideRequest
创建幻灯片。
| JSON 表示法 |
|---|
{ "objectId": string, "insertionIndex": integer, "slideLayoutReference": { object ( |
| 字段 | |
|---|---|
objectId
|
用户提供的对象 ID。
如果您指定 ID,则该 ID 在演示中的所有页面和页面元素中必须是唯一的。ID 必须以字母数字字符或下划线开头(符合正则表达式 如果您未指定 ID,系统会生成一个唯一 ID。 |
insertionIndex
|
可选的从零开始的索引,用于指示要插入幻灯片的位置。 如果您未指定索引,系统会在末尾创建相应幻灯片。 |
slideLayoutReference
|
要插入的幻灯片的布局参考,基于当前母版,可以是以下值之一:
如果当前主布局中未找到 LayoutReference,则会返回 400 错误请求错误。
如果您未指定布局参考,幻灯片将使用预定义的 |
placeholderIdMappings[]
|
一个可选的对象 ID 映射列表,用于将布局中的 |
LayoutReference
幻灯片布局参考。这可能引用以下任一内容:
- 预定义的布局
- 演示文稿中的一种布局。
| JSON 表示法 |
|---|
{ // Union field |
| 字段 | |
|---|---|
联合字段 kind。LayoutReference 的种类。
kind 只能是下列其中一项:
|
|
predefinedLayout
|
预定义布局。 |
layoutId
|
布局 ID:演示中某个布局的对象 ID。 |
PredefinedLayout
预定义的布局类型。这些是演示文稿中常见的布局。不过,这些布局是否会出现在当前主布局中无法保证,因为它们可能已被删除或不属于所用主题。此外,每个布局中的占位符可能已更改。
| 枚举 | |
|---|---|
PREDEFINED_LAYOUT_UNSPECIFIED
|
未指定的布局。 |
BLANK
|
空白布局,不含任何占位符。 |
CAPTION_ONLY
|
底部带有字幕的布局。 |
TITLE
|
带有标题和副标题的布局。 |
TITLE_AND_BODY
|
包含标题和正文的布局。 |
TITLE_AND_TWO_COLUMNS
|
包含标题和两列的布局。 |
TITLE_ONLY
|
仅包含标题的布局。 |
SECTION_HEADER
|
包含版块标题的布局。 |
SECTION_TITLE_AND_DESCRIPTION
|
一侧显示标题和副标题,另一侧显示说明的布局。 |
ONE_COLUMN_TEXT
|
包含一个标题和一个正文的布局,排列在单列中。 |
MAIN_POINT
|
包含主要观点的布局。 |
BIG_NUMBER
|
包含大号数字标题的布局。 |
LayoutPlaceholderIdMapping
用户为将根据指定布局在幻灯片上创建的占位符指定的 ID 映射。
| JSON 表示法 |
|---|
{ "objectId": string, // Union field |
| 字段 | |
|---|---|
objectId
|
用户为上述占位符提供的对象 ID,该占位符将创建到幻灯片上。
如果您指定 ID,则该 ID 在演示中的所有页面和页面元素中必须是唯一的。ID 必须以字母数字字符或下划线开头(符合正则表达式 如果您未指定 ID,系统会生成一个唯一 ID。 |
联合字段 kind。用于标识布局上占位符的类型。
kind 只能是下列其中一项:
|
|
layoutPlaceholder
|
将应用于幻灯片的布局中的占位符。只需要 |
layoutPlaceholderObjectId
|
将应用于幻灯片的布局上占位符的对象 ID。 |
CreateShapeRequest
创建新形状。
| JSON 表示法 |
|---|
{ "objectId": string, "elementProperties": { object ( |
| 字段 | |
|---|---|
objectId
|
用户提供的对象 ID。
如果您指定 ID,则该 ID 在演示中的所有页面和页面元素中必须是唯一的。ID 必须以字母数字字符或下划线开头(符合正则表达式 |
elementProperties
|
形状的元素属性。 |
shapeType
|
形状类型。 |
PageElementProperties
网页元素的通用属性。
注意:首次创建 PageElement 时,API 可能会修改 size 和 transform 的值,但视觉大小不会发生变化。
| JSON 表示法 |
|---|
{ "pageObjectId": string, "size": { object ( |
| 字段 | |
|---|---|
pageObjectId
|
元素所在网页的对象 ID。 |
size
|
元素的大小。 |
transform
|
元素的转换。 |
CreateTableRequest
创建新表。
| JSON 表示法 |
|---|
{
"objectId": string,
"elementProperties": {
object ( |
| 字段 | |
|---|---|
objectId
|
用户提供的对象 ID。
如果您指定 ID,则该 ID 在演示中的所有页面和页面元素中必须是唯一的。ID 必须以字母数字字符或下划线开头(符合正则表达式 如果您未指定 ID,系统会生成一个唯一 ID。 |
elementProperties
|
表格的元素属性。 系统将按提供的大小创建表,但不得小于最小大小。如果未提供大小,系统将自动调整表格大小。 表格转换必须具有 1 的缩放比例,且不得包含剪切分量。如果未提供任何转换,表格将居中显示在网页上。 |
rows
|
表中的行数。 |
columns
|
表中的列数。 |
InsertTextRequest
将文字插入形状或表格单元格中。
| JSON 表示法 |
|---|
{
"objectId": string,
"cellLocation": {
object ( |
| 字段 | |
|---|---|
objectId
|
要插入文本的形状或表格的对象 ID。 |
cellLocation
|
如果文本要插入到表格单元格中,则为可选的表格单元格位置。如果存在,objectId 必须引用一个表。 |
text
|
要插入的文本。
插入换行符会在该索引处隐式创建新的
系统会自动确定插入文本的样式,通常会保留相邻文本的样式。在大多数情况下,文本将添加到插入索引处的现有 系统会从插入的文本中剥离某些控制字符 (U+0000-U+0008、U+000C-U+001F) 和来自 Unicode 基本多语言平面专用区 (U+E000-U+F8FF) 的字符。 |
insertionIndex
|
将插入文本的索引(以 Unicode 代码单元为单位),基于 索引从零开始,并从字符串的开头计算。系统可能会调整索引,以防止在 Unicode 字形集群内插入内容。在这种情况下,文字将紧跟在字形簇后面插入。 |
InsertTableRowsRequest
将行插入到表中。
| JSON 表示法 |
|---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
| 字段 | |
|---|---|
tableObjectId
|
要向其中插入行的表。 |
cellLocation
|
将插入行的参考表格单元格位置。 系统会在参考单元格所在的行上方(或下方)插入新行。如果参考单元格是合并的单元格,系统会在合并的单元格上方(或下方)插入新行。 |
insertBelow
|
是否在参考单元格位置下方插入新行。
|
number
|
要插入的行数。每个请求最多 20 个。 |
InsertTableColumnsRequest
将列插入到表中。
系统会调整表格中的其他列,以适应新列。
| JSON 表示法 |
|---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
| 字段 | |
|---|---|
tableObjectId
|
要向其中插入列的表。 |
cellLocation
|
要插入列的参考表格单元格位置。 系统会在参考单元格所在的列的左侧(或右侧)插入一个新列。如果参考单元格是合并单元格,系统会在合并单元格的左侧(或右侧)插入一个新列。 |
insertRight
|
是否在参考单元格位置的右侧插入新列。
|
number
|
要插入的列数。每个请求最多 20 个。 |
DeleteTableRowRequest
从表中删除一行。
| JSON 表示法 |
|---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
| 字段 | |
|---|---|
tableObjectId
|
要从中删除行的表。 |
cellLocation
|
要删除的行的参考表格单元格位置。 系统会删除此单元格所跨越的行。如果这是合并的单元格,系统将删除多行。如果删除后表中没有剩余行,则会删除整个表。 |
DeleteTableColumnRequest
从表中删除列。
| JSON 表示法 |
|---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
| 字段 | |
|---|---|
tableObjectId
|
要从中删除列的表。 |
cellLocation
|
要删除列的参考表格单元格位置。 系统会删除此单元格所跨越的列。如果这是合并的单元格,系统将删除多列。如果删除后表中没有剩余列,则会删除整个表。 |
ReplaceAllTextRequest
将所有符合条件的文本实例替换为 replace text。
| JSON 表示法 |
|---|
{ "replaceText": string, "pageObjectIds": [ string ], // Union field |
| 字段 | |
|---|---|
replaceText
|
将替换匹配文本的文本。 |
pageObjectIds[]
|
如果不为空,则将匹配项限制为仅在指定网页上的网页元素中查找。
如果给定 |
联合字段 criteria。用于匹配要替换的文本的条件。
criteria 只能是下列其中一项:
|
|
containsText
|
查找与此子字符串匹配的形状中的文本。 |
SubstringMatchCriteria
一种条件,用于匹配形状或表格中的特定文本字符串。
| JSON 表示法 |
|---|
{ "text": string, "matchCase": boolean, "searchByRegex": boolean } |
| 字段 | |
|---|---|
text
|
要在形状或表格中搜索的文字。 |
matchCase
|
指示搜索是否应区分大小写:
|
searchByRegex
|
可选。如果应将查找值视为正则表达式,则为 true。模式中的所有反斜杠都应进行转义。
|
DeleteObjectRequest
从演示文稿中删除对象(pages 或 page elements)。
| JSON 表示法 |
|---|
{ "objectId": string } |
| 字段 | |
|---|---|
objectId
|
要删除的网页或网页元素的相应对象 ID。
如果删除操作后, 如果布局中的占位符被删除,所有继承的空占位符也会被删除。 |
UpdatePageElementTransformRequest
更新页面元素的转换。
更新群组的转换会更改相应群组中页面元素的绝对转换,从而改变其视觉外观。如需了解详情,请参阅 PageElement.transform 的文档。
| JSON 表示法 |
|---|
{ "objectId": string, "transform": { object ( |
| 字段 | |
|---|---|
objectId
|
要更新的页面元素的 ID。 |
transform
|
用于更新网页元素的输入转换矩阵。 |
applyMode
|
转换更新的应用模式。 |
ApplyMode
转换更新的应用模式。
| 枚举 | |
|---|---|
APPLY_MODE_UNSPECIFIED
|
未指定模式。 |
RELATIVE
|
将新的 AffineTransform 矩阵应用于现有矩阵,并用得到的串联结果替换现有矩阵。 |
ABSOLUTE
|
用新的仿射转换矩阵替换现有的仿射转换矩阵。 |
UpdateSlidesPositionRequest
更新演示文稿中幻灯片的位置。
| JSON 表示法 |
|---|
{ "slideObjectIds": [ string ], "insertionIndex": integer } |
| 字段 | |
|---|---|
slideObjectIds[]
|
演示文稿中应移动的幻灯片的 ID。此列表中的幻灯片必须按现有演示文稿顺序排列,且不得重复。 |
insertionIndex
|
应插入幻灯片的索引,基于移动前的幻灯片排列顺序。必须介于零和演示文稿中的幻灯片数量之间(含首尾)。 |
DeleteTextRequest
从形状或表格单元格中删除文字。
| JSON 表示法 |
|---|
{ "objectId": string, "cellLocation": { object ( |
| 字段 | |
|---|---|
objectId
|
要从中删除文本的形状或表格的对象 ID。 |
cellLocation
|
可选的表格单元格位置(如果文本要从表格单元格中删除)。如果存在,objectId 必须引用一个表。 |
textRange
|
要删除的文本范围,基于
形状或表格单元格的文本末尾始终有一个无法删除的隐式换行符。
删除跨越段落边界的文本可能会导致段落样式和列表发生变化,因为这两个段落会合并。 仅包含代理对中一个代码单元的范围会扩展为包含两个代码单元。 |
范围
指定索引集合(例如文本中的字符)的连续范围。
| JSON 表示法 |
|---|
{
"startIndex": integer,
"endIndex": integer,
"type": enum ( |
| 字段 | |
|---|---|
startIndex
|
集合开头的可选索引(从零开始)。对于 |
endIndex
|
集合末尾的索引(从零开始,可选)。对于 |
type
|
范围的类型。 |
类型
范围的类型。
| 枚举 | |
|---|---|
RANGE_TYPE_UNSPECIFIED
|
未指定范围类型。不得使用此值。 |
FIXED_RANGE
|
固定范围。必须同时指定 startIndex 和 endIndex。
|
FROM_START_INDEX
|
从 startIndex 开始,一直持续到集合结束。不得指定 endIndex。
|
ALL
|
将范围设置为集合的整个长度。不得同时指定 startIndex 和 endIndex。
|
CreateImageRequest
创建图片。
| JSON 表示法 |
|---|
{ "objectId": string, "elementProperties": { object ( |
| 字段 | |
|---|---|
objectId
|
用户提供的对象 ID。
如果您指定 ID,则该 ID 在演示中的所有页面和页面元素中必须是唯一的。ID 必须以字母数字字符或下划线开头(符合正则表达式 如果您未指定 ID,系统会生成一个唯一 ID。 |
elementProperties
|
图片的元素属性。 如果所提供尺寸的宽高比与图片宽高比不一致,系统会缩放图片并将其居中放置在相应尺寸内,以保持宽高比。所提供的转换在此操作之后应用。
|
联合字段 image_source。图片来源的类型。
image_source 只能是下列其中一项:
|
|
url
|
图片网址。 图片会在插入时提取一次,并存储一份副本以在演示文稿中显示。图片大小必须小于 50 MB,像素数不得超过 2500 万,且必须采用 PNG、JPEG 或 GIF 格式。
提供的网址必须可公开访问,且长度不得超过 2 KB。网址会与图片一起保存,并通过 |
CreateVideoRequest
创建视频。
注意:如需通过 Google 云端硬盘制作视频,请求应用必须至少具有 drive、drive.readonly 或 drive.file OAuth 范围。
| JSON 表示法 |
|---|
{ "objectId": string, "elementProperties": { object ( |
| 字段 | |
|---|---|
objectId
|
用户提供的对象 ID。
如果您指定 ID,则该 ID 在演示中的所有页面和页面元素中必须是唯一的。ID 必须以字母数字字符或下划线开头(符合正则表达式 如果您未指定 ID,系统会生成一个唯一 ID。 |
elementProperties
|
视频的元素属性。
|
source
|
视频来源。 |
id
|
相应视频在视频来源中的唯一标识符。 例如,对于 YouTube 视频 https://www.youtube.com/watch?v=7U3axjORYZ0,ID 为 7U3axjORYZ0。对于 Google 云端硬盘视频 https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q ,ID 为 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q。 如需访问 Google 云端硬盘视频文件,您可能需要为部分旧文件向 HTTP 标头添加资源密钥。如需了解详情,请参阅使用资源密钥访问通过链接共享的文件。 |
CreateSheetsChartRequest
创建嵌入式 Google 表格图表。
注意:创建图表需要至少一个以下 OAuth 范围:spreadsheets.readonly、spreadsheets、drive.readonly、drive.file 或 drive。
| JSON 表示法 |
|---|
{ "objectId": string, "elementProperties": { object ( |
| 字段 | |
|---|---|
objectId
|
用户提供的对象 ID。 如果指定了 ID,则该 ID 在演示中的所有页面和页面元素中必须是唯一的。ID 应以字词字符 [a-zA-Z0-9_] 开头,后跟任意数量的以下字符 [a-zA-Z0-9_-:]。ID 的长度不应小于 5 个字符或大于 50 个字符。如果为空,系统会生成一个唯一标识符。 |
elementProperties
|
图表的元素属性。 如果所提供尺寸的宽高比与图表的宽高比不匹配,系统会根据该尺寸缩放图表并将其居中,以保持宽高比。所提供的转换在此操作之后应用。 |
spreadsheetId
|
包含图表的 Google 表格电子表格的 ID。 您可能需要为部分旧文件向 HTTP 标头添加资源密钥。如需了解详情,请参阅使用资源密钥访问通过链接共享的文件。 |
chartId
|
Google 表格中特定图表的 ID。 |
linkingMode
|
图表与源电子表格的关联模式。如果未指定,图表将是不带链接的图片。 |
LinkingMode
图表与源电子表格的关联模式。
| 枚举 | |
|---|---|
NOT_LINKED_IMAGE
|
该图表未与源电子表格相关联,因此无法更新。未关联的图表将以图片形式插入。 |
LINKED
|
关联图表后,即可更新图表,其他协作者也会看到指向电子表格的链接。 |
CreateLineRequest
创建一条线。
| JSON 表示法 |
|---|
{ "objectId": string, "elementProperties": { object ( |
| 字段 | |
|---|---|
objectId
|
用户提供的对象 ID。
如果您指定 ID,则该 ID 在演示中的所有页面和页面元素中必须是唯一的。ID 必须以字母数字字符或下划线开头(符合正则表达式 如果您未指定 ID,系统会生成一个唯一 ID。 |
elementProperties
|
相应行的元素属性。 |
lineCategory
|
要创建的行的类别。
已弃用
:请改用
创建的确切
如果您同时指定了 |
category
|
要创建的行的类别。
创建的确切
如果您同时指定了
如果您未指定
如果您未指定任一参数,则系统会使用 |
类别
行类别。
| 枚举 | |
|---|---|
STRAIGHT
|
直线连接器,包括直线连接器 1。如果未指定类别,则此类别为默认类别。 |
BENT
|
弯曲连接器,包括弯曲连接器 2 至 5。 |
CURVED
|
弯曲连接器,包括弯曲连接器 2 至 5。 |
RefreshSheetsChartRequest
通过将嵌入的 Google 表格图表替换为 Google 表格中的最新版图表,刷新该图表。
注意:如需刷新图表,您至少需要拥有 spreadsheets.readonly、spreadsheets、drive.readonly 或 drive OAuth 范围。
| JSON 表示法 |
|---|
{ "objectId": string } |
| 字段 | |
|---|---|
objectId
|
要刷新的图表的对象 ID。 |
UpdateShapePropertiesRequest
更新 Shape 的属性。
| JSON 表示法 |
|---|
{
"objectId": string,
"shapeProperties": {
object ( |
| 字段 | |
|---|---|
objectId
|
应用更新的形状的对象 ID。 |
shapeProperties
|
要更新的形状属性。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新形状背景的纯色填充颜色,请将 如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
UpdateImagePropertiesRequest
更新 Image 的属性。
| JSON 表示法 |
|---|
{
"objectId": string,
"imageProperties": {
object ( |
| 字段 | |
|---|---|
objectId
|
应用更新的图片的相应对象 ID。 |
imageProperties
|
要更新的图片属性。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新图片轮廓颜色,请将 如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
UpdateVideoPropertiesRequest
更新 Video 的属性。
| JSON 表示法 |
|---|
{
"objectId": string,
"videoProperties": {
object ( |
| 字段 | |
|---|---|
objectId
|
应用更新的视频的对象 ID。 |
videoProperties
|
要更新的视频属性。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新视频轮廓颜色,请将 如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
UpdatePagePropertiesRequest
更新 Page 的属性。
| JSON 表示法 |
|---|
{
"objectId": string,
"pageProperties": {
object ( |
| 字段 | |
|---|---|
objectId
|
应用更新的网页的对象 ID。 |
pageProperties
|
要更新的网页属性。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新网页背景的纯色填充颜色,请将 如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
UpdateTableCellPropertiesRequest
更新 TableCell 的属性。
| JSON 表示法 |
|---|
{ "objectId": string, "tableRange": { object ( |
| 字段 | |
|---|---|
objectId
|
表的对象 ID。 |
tableRange
|
表示应用更新的表格子集的表格范围。如果未指定表格范围,则更新将应用于整个表格。 |
tableCellProperties
|
要更新的表格单元格属性。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新表格单元格背景纯色填充颜色,请将 如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
TableRange
表格范围表示对表格子集的引用。
请务必注意,表格范围指定的单元格不一定构成矩形。例如,假设我们有一个 3x3 的表格,其中最后一行的所有单元格都合并在一起。该表如下所示:
[ ][ ][ ]
[ ][ ][ ]
[ ]
位置为 (0, 0)、行 span 为 3、列 span 为 2 的表格范围指定了以下单元格:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
| JSON 表示法 |
|---|
{
"location": {
object ( |
| 字段 | |
|---|---|
location
|
表格范围的起始位置。 |
rowSpan
|
表格范围的行跨度。 |
columnSpan
|
表格范围的列跨度。 |
UpdateLinePropertiesRequest
更新 Line 的属性。
| JSON 表示法 |
|---|
{
"objectId": string,
"lineProperties": {
object ( |
| 字段 | |
|---|---|
objectId
|
应用更新的相应行的对象 ID。 |
lineProperties
|
要更新的线条属性。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新线条的纯色填充颜色,请将
如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
CreateParagraphBulletsRequest
为与指定文本索引范围重叠的所有段落创建项目符号。
每个段落的嵌套级别将通过统计每个段落前面的前导标签页来确定。为避免项目符号与相应段落之间出现过多的空格,此请求会移除这些前导标签页。这可能会更改部分文本的索引。
如果待更新段落紧前方的段落位于具有匹配预设的列表中,则待更新段落会添加到该前方的列表中。
| JSON 表示法 |
|---|
{ "objectId": string, "cellLocation": { object ( |
| 字段 | |
|---|---|
objectId
|
包含要添加项目符号的文本的形状或表格的对象 ID。 |
cellLocation
|
如果待修改的文本位于表格单元格中,则为可选的表格单元格位置。如果存在,objectId 必须引用一个表。 |
textRange
|
要应用项目符号预设的文本范围,基于 |
bulletPreset
|
要使用的项目符号字形种类。默认值为 |
BulletGlyphPreset
文本中列表的项目符号字形的预设模式。
这些模式使用以下类型的项目符号:
-
ARROW:一个箭头,对应于 Unicode U+2794 码位 -
ARROW3D:具有 3D 阴影的箭头,对应于 Unicode U+27a2 代码点 -
CHECKBOX:一个空心正方形,对应于 Unicode U+274f 码位 -
CIRCLE:空心圆,对应于 Unicode U+25cb 码位 -
DIAMOND:实心菱形,对应于 Unicode U+25c6 码位 -
DIAMONDX:一个带有“x”的菱形,对应于 Unicode U+2756 码位 -
HOLLOWDIAMOND:空心菱形,对应于 Unicode U+25c7 码位 -
DISC:实心圆,对应于 Unicode U+25cf 码位 -
SQUARE:实心正方形,对应于 Unicode U+25a0 码位 -
STAR:星号,对应于 Unicode U+2605 码位 -
ALPHA:小写字母,例如“a”“b”或“c”。 -
UPPERALPHA:一个大写字母,例如“A”“B”或“C”。 -
DIGIT:一个数字,例如“1”“2”或“3”。 -
ZERODIGIT:一个数字,其中个位数前面带有零,例如“01”“02”或“03”。位数超过一位的数字不会以零开头。 -
ROMAN:小写罗马数字,例如“i”“ii”或“iii”。 -
UPPERROMAN:大写罗马数字,例如“I”“II”或“III”。 -
LEFTTRIANGLE:指向左侧的三角形,对应于 Unicode U+25c4 代码点
| 枚举 | |
|---|---|
BULLET_DISC_CIRCLE_SQUARE
|
一个项目符号列表,其中包含前 3 个列表嵌套级别的 DISC、CIRCLE 和 SQUARE 项目符号字形。
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
一个项目符号列表,其中包含前 3 个列表嵌套级别的 DIAMONDX、ARROW3D 和 SQUARE 项目符号字形。
|
BULLET_CHECKBOX
|
一个项目符号列表,其中包含所有列表嵌套级别的CHECKBOX项目符号字形。
|
BULLET_ARROW_DIAMOND_DISC
|
一个项目符号列表,其中包含前 3 个列表嵌套级别的 ARROW、DIAMOND 和 DISC 项目符号字形。
|
BULLET_STAR_CIRCLE_SQUARE
|
一个项目符号列表,其中包含前 3 个列表嵌套级别的 STAR、CIRCLE 和 SQUARE 项目符号字形。
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
一个项目符号列表,其中包含前 3 个列表嵌套级别的 ARROW3D、CIRCLE 和 SQUARE 项目符号字形。
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
一个项目符号列表,其中包含前 3 个列表嵌套级别的 LEFTTRIANGLE、DIAMOND 和 DISC 项目符号字形。
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
一个项目符号列表,其中包含前 3 个列表嵌套级别的 DIAMONDX、HOLLOWDIAMOND 和 SQUARE 项目符号字形。
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
一个项目符号列表,其中包含前 3 个列表嵌套级别的 DIAMOND、CIRCLE 和 SQUARE 项目符号字形。
|
NUMBERED_DIGIT_ALPHA_ROMAN
|
一个编号列表,前 3 个列表嵌套级别分别使用 DIGIT、ALPHA 和 ROMAN 数字字形,后跟英文句点。
|
NUMBERED_DIGIT_ALPHA_ROMAN_PARENS
|
一个编号列表,前 3 个列表嵌套级别分别使用 DIGIT、ALPHA 和 ROMAN 数字字形,后面跟一个英文半角括号。
|
NUMBERED_DIGIT_NESTED
|
一个编号列表,其中包含以句点分隔的数字字形,每个嵌套级别都使用前一个嵌套级别的字形作为前缀。DIGIT
例如:“1.”、'1.1.','2.''2.2.'。
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
一个编号列表,前 3 个列表嵌套级别分别使用 UPPERALPHA、ALPHA 和 ROMAN 数字字形,后跟英文句点。
|
NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT
|
一个编号列表,前 3 个列表嵌套级别分别使用 UPPERROMAN、UPPERALPHA 和 DIGIT 数字字形,后跟英文句点。
|
NUMBERED_ZERODIGIT_ALPHA_ROMAN
|
一个编号列表,前 3 个列表嵌套级别分别使用 ZERODIGIT、ALPHA 和 ROMAN 数字字形,后跟英文句点。
|
ReplaceAllShapesWithImageRequest
将符合指定条件的所有形状替换为提供的图片。
替换形状的图片在插入演示文稿后会变成矩形,而不会采用形状的形式。
| JSON 表示法 |
|---|
{ "replaceMethod": enum ( |
| 字段 | |
|---|---|
replaceMethod
|
替换方法。
已弃用
:请改用
如果您同时指定了 |
imageReplaceMethod
|
图片替换方法。
如果您同时指定了
如果您未指定 如果您未指定任一值,则使用 CENTER_INSIDE。 |
pageObjectIds[]
|
如果不为空,则将匹配项限制为仅在指定网页上的网页元素中查找。
如果给定的是 |
联合字段 criteria。形状必须符合的条件,才能被替换。
criteria 只能是下列其中一项:
|
|
containsText
|
如果设置,此请求将替换包含指定文本的所有形状。 |
联合字段 image_source。图片来源的类型。
image_source 只能是下列其中一项:
|
|
imageUrl
|
图片网址。 图片会在插入时提取一次,并存储一份副本以在演示文稿中显示。图片大小必须小于 50MB,像素数不得超过 2500 万,且必须采用 PNG、JPEG 或 GIF 格式。
所提供的网址长度不得超过 2 kB。网址本身会与图片一起保存,并通过 |
ReplaceMethod
替换方法。
| 枚举 | |
|---|---|
CENTER_INSIDE
|
缩放图片并将其居中放置,使其适合原始形状的边界,同时保持图片的宽高比。图片的渲染大小可能小于形状的大小。如果未指定方法,则这是默认方法。 |
CENTER_CROP
|
缩放图片并将其居中,以填充原始形状的边界。图片可能会被裁剪以填满形状。图片的渲染大小将与原始形状的大小相同。 |
ImageReplaceMethod
图片替换方法。
| 枚举 | |
|---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
未指定图片替换方法。不得使用此值。 |
CENTER_INSIDE
|
缩放图片并将其居中放置,使其适合原始形状的边界,同时保持图片的宽高比。图片的渲染大小可能小于形状的大小。如果未指定方法,则这是默认方法。 |
CENTER_CROP
|
缩放图片并将其居中,以填充原始形状的边界。图片可能会被裁剪以填满形状。图片的渲染大小将与原始形状相同。 |
DuplicateObjectRequest
复制幻灯片或网页元素。
复制幻灯片时,复制的幻灯片将紧随指定幻灯片之后创建。复制网页元素时,复制的元素将放置在与原始元素相同的网页上,并位于相同的位置。
| JSON 表示法 |
|---|
{ "objectId": string, "objectIds": { string: string, ... } } |
| 字段 | |
|---|---|
objectId
|
要复制的对象的 ID。 |
objectIds
|
要复制的对象可能包含其他对象,例如复制幻灯片或群组页面元素时。此映射定义了如何生成重复对象的 ID:键是原始对象的 ID,值是分配给相应重复对象的 ID。也可以在此映射中指定源对象的重复项的 ID,方法是使用
所有键都必须对应演示中的现有 ID。所有值在演示中都必须是唯一的,并且必须以字母数字字符或下划线开头(与正则表达式 如果映射中省略了任何源对象的 ID,系统会分配一个新的随机 ID。如果映射为空或未设置,所有重复对象都将收到新的随机 ID。 |
UpdateTextStyleRequest
| JSON 表示法 |
|---|
{ "objectId": string, "cellLocation": { object ( |
| 字段 | |
|---|---|
objectId
|
要设置样式的文本所在的形状或表格的对象 ID。 |
cellLocation
|
包含要设置样式的文本的单元格在表格中的位置。如果 |
style
|
要设置在文本上的样式。 如果某个样式的价值与父级的价值相符,则该样式将被设置为继承。
某些文本样式更改可能会导致其他更改,这些更改旨在反映 Google 幻灯片编辑器的行为。如需了解详情,请参阅 |
textRange
|
要设置样式的文本范围。 该范围可能会扩展到包含相邻的换行符。 如果范围完全包含属于列表的段落,则段落的项目符号也会更新为匹配的文本样式。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需将文本样式更新为粗体,请将 如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
ReplaceAllShapesWithSheetsChartRequest
将符合指定条件的所有形状替换为提供的 Google 表格图表。系统将缩放图表并使其居中,以适应原始形状的边界。
注意:将形状替换为图表需要至少一个 spreadsheets.readonly、spreadsheets、drive.readonly 或 drive OAuth 范围。
| JSON 表示法 |
|---|
{ "containsText": { object ( |
| 字段 | |
|---|---|
containsText
|
形状必须符合的条件才能被替换。相应请求将替换包含指定文本的所有形状。 |
spreadsheetId
|
包含图表的 Google 表格电子表格的 ID。 |
chartId
|
Google 表格中特定图表的 ID。 |
linkingMode
|
图表与源电子表格的关联模式。如果未指定,图表将是不带链接的图片。 |
pageObjectIds[]
|
如果不为空,则将匹配项限制为仅在指定网页上的网页元素中查找。
如果给定的是 |
LinkingMode
图表与源电子表格的关联模式。
| 枚举 | |
|---|---|
NOT_LINKED_IMAGE
|
该图表未与源电子表格相关联,因此无法更新。未关联的图表将以图片形式插入。 |
LINKED
|
关联图表后,即可更新图表,其他协作者也会看到指向电子表格的链接。 |
DeleteParagraphBulletsRequest
从与给定文本索引 range 重叠的所有段落中删除项目符号。
通过在相应段落的开头添加缩进,可以直观地保留每个段落的嵌套级别。
| JSON 表示法 |
|---|
{ "objectId": string, "cellLocation": { object ( |
| 字段 | |
|---|---|
objectId
|
包含要删除项目符号的文本的形状或表格的对象 ID。 |
cellLocation
|
如果待修改的文本位于表格单元格中,则为可选的表格单元格位置。如果存在,objectId 必须引用一个表。 |
textRange
|
要从中删除项目符号的文本范围,基于 |
UpdateParagraphStyleRequest
| JSON 表示法 |
|---|
{ "objectId": string, "cellLocation": { object ( |
| 字段 | |
|---|---|
objectId
|
要设置样式的文本所在的形状或表格的对象 ID。 |
cellLocation
|
包含要设置样式的段落的表格单元格的位置。如果 |
style
|
段落的样式。 |
textRange
|
包含要设置样式的段落的文本范围。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新段落对齐方式,请将 如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
UpdateTableBorderPropertiesRequest
更新 Table 中表格边框的属性。
| JSON 表示法 |
|---|
{ "objectId": string, "tableRange": { object ( |
| 字段 | |
|---|---|
objectId
|
表的对象 ID。 |
tableRange
|
表示应用更新的表格子集的表格范围。如果未指定表格范围,则更新将应用于整个表格。 |
borderPosition
|
更新应应用于的表格范围内的边框位置。如果未指定边框位置,则更新将应用于表格范围内的所有边框。 |
tableBorderProperties
|
要更新的表格边框属性。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新表格边框的纯色填充颜色,请将 如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
BorderPosition
表格边框位置。
| 枚举 | |
|---|---|
ALL
|
范围内的所有边框。 |
BOTTOM
|
范围底部的边框。 |
INNER
|
范围内部的边框。 |
INNER_HORIZONTAL
|
范围内部的水平边框。 |
INNER_VERTICAL
|
范围内部的竖直边框。 |
LEFT
|
范围左侧的边界。 |
OUTER
|
沿范围外侧的边框。 |
RIGHT
|
范围右侧的边框。 |
TOP
|
范围顶部的边框。 |
UpdateTableColumnPropertiesRequest
更新 Table 列的属性。
| JSON 表示法 |
|---|
{
"objectId": string,
"columnIndices": [
integer
],
"tableColumnProperties": {
object ( |
| 字段 | |
|---|---|
objectId
|
表的对象 ID。 |
columnIndices[]
|
一个从零开始的索引列表,用于指定要更新的列。如果未提供任何索引,则系统会更新表中的所有列。 |
tableColumnProperties
|
要更新的表格列属性。
如果请求中的 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新列宽,请将 如果字段掩码中包含“columnWidth”,但该属性未设置,则列宽将默认为 406,400 EMU(32 点)。 |
UpdateTableRowPropertiesRequest
更新 Table 行的属性。
| JSON 表示法 |
|---|
{
"objectId": string,
"rowIndices": [
integer
],
"tableRowProperties": {
object ( |
| 字段 | |
|---|---|
objectId
|
表的对象 ID。 |
rowIndices[]
|
一个从零开始的索引列表,用于指定要更新的行。如果未提供任何索引,则系统将更新表中的所有行。 |
tableRowProperties
|
要更新的表格行属性。 |
fields
|
应更新的字段。
必须至少指定一个字段。根
例如,如需更新最小行高,请将 如果字段掩码中包含“minRowHeight”,但该属性未设置,则最小行高将默认为 0。 |
MergeTableCellsRequest
合并 Table 中的单元格。
| JSON 表示法 |
|---|
{
"objectId": string,
"tableRange": {
object ( |
| 字段 | |
|---|---|
objectId
|
表的对象 ID。 |
tableRange
|
指定要合并的表格单元格的表格范围。 要合并的单元格中的所有文本都将串联起来,并存储在范围的左上角(“头部”)单元格中。如果范围为非矩形(在某些情况下,范围可能会覆盖已合并的单元格),则会返回 400 错误请求错误。 |
UnmergeTableCellsRequest
取消合并 Table 中的单元格。
| JSON 表示法 |
|---|
{
"objectId": string,
"tableRange": {
object ( |
| 字段 | |
|---|---|
objectId
|
表的对象 ID。 |
tableRange
|
指定要取消合并的表格单元格的表格范围。 此范围内的所有合并单元格都将取消合并,而已取消合并的单元格不会受到影响。如果范围没有合并的单元格,则请求将不执行任何操作。如果任何合并的单元格中包含文本,则该文本将保留在生成的未合并单元格块的左上角(“头部”)单元格中。 |
GroupObjectsRequest
将对象分组以创建对象组。例如,将组 PageElements 用于在与所有子级相同的页面上创建 Group。
| JSON 表示法 |
|---|
{ "groupObjectId": string, "childrenObjectIds": [ string ] } |
| 字段 | |
|---|---|
groupObjectId
|
要创建的群组的用户提供的对象 ID。
如果您指定 ID,则该 ID 在演示中的所有页面和页面元素中必须是唯一的。ID 必须以字母数字字符或下划线开头(符合正则表达式 如果您未指定 ID,系统会生成一个唯一 ID。 |
childrenObjectIds[]
|
要分组的对象的对象 ID。
只有页面元素可以分组。同一页面上应至少有两个尚未归入其他组的页面元素。某些网页元素(例如 |
UngroupObjectsRequest
取消分组对象,例如 groups。
| JSON 表示法 |
|---|
{ "objectIds": [ string ] } |
| 字段 | |
|---|---|
objectIds[]
|
要取消分组的对象的对象 ID。
只有不在其他 |
UpdatePageElementAltTextRequest
更新 page element 的替代文本标题和/或说明。
| JSON 表示法 |
|---|
{ "objectId": string, "title": string, "description": string } |
| 字段 | |
|---|---|
objectId
|
应用更新的网页元素的相应对象 ID。 |
title
|
网页元素的更新后的替代文本标题。如果未设置,则会保留现有值。标题会向屏幕阅读器和其他无障碍界面公开。仅使用与网页元素内容相关的直观易懂的值。 |
description
|
网页元素的更新后的替代文本说明。如果未设置,则会保留现有值。该说明会向屏幕阅读器和其他无障碍功能界面公开。仅使用与网页元素内容相关的直观易懂的值。 |
ReplaceImageRequest
用新图片替换现有图片。
替换图片会从现有图片中移除一些 image effects。
| JSON 表示法 |
|---|
{ "imageObjectId": string, "imageReplaceMethod": enum ( |
| 字段 | |
|---|---|
imageObjectId
|
要替换的现有图片的 ID。该 ID 可从 GET 请求的响应中检索。 |
imageReplaceMethod
|
替换方法。 |
联合字段 image_source。图片来源的类型。
image_source 只能是下列其中一项:
|
|
url
|
图片网址。 图片会在插入时提取一次,并存储一份副本以在演示文稿中显示。图片必须小于 50MB,不得超过 2500 万像素,且必须为 PNG、JPEG 或 GIF 格式。
所提供的网址长度不得超过 2 KB。网址会与图片一起保存,并通过 |
UpdateSlidePropertiesRequest
更新幻灯片的属性。
| JSON 表示法 |
|---|
{
"objectId": string,
"slideProperties": {
object ( |
| 字段 | |
|---|---|
objectId
|
应用更新的幻灯片的相应对象 ID。 |
slideProperties
|
要更新的幻灯片属性。 |
fields
|
应更新的字段。
必须至少指定一个字段。根“slideProperties”是隐含的,不应指定。单个
例如,如需更新幻灯片是否跳过,请将 如需将属性重置为默认值,请在字段掩码中添加相应字段名称,但将该字段本身保持未设置状态。 |
UpdatePageElementsZOrderRequest
更新页面元素的 Z 顺序。Z 顺序是指页面上元素从后到前的顺序。前面的页面元素可能会遮盖后面的元素。
| JSON 表示法 |
|---|
{
"pageElementObjectIds": [
string
],
"operation": enum ( |
| 字段 | |
|---|---|
pageElementObjectIds[]
|
要更新的页面元素的 ID。 所有网页元素都必须位于同一网页上,且不得分组。 |
operation
|
要对页面元素应用的 Z 顺序操作。 对多个页面元素应用操作时,系统会保持这些页面元素在操作之前的相对 Z 顺序。 |
ZOrderOperation
用于更新页面元素的 Z 顺序的操作。
| 枚举 | |
|---|---|
Z_ORDER_OPERATION_UNSPECIFIED
|
未指定操作。 |
BRING_TO_FRONT
|
将页面元素置于页面最前面。 |
BRING_FORWARD
|
将指定页面元素中的页面元素向前移动一个元素,相对于最前面的元素而言。 |
SEND_BACKWARD
|
将页面元素在页面上向后移动一个元素,相对于指定页面元素中最靠后的一个元素。 |
SEND_TO_BACK
|
将页面元素移至页面后方。 |
UpdateLineCategoryRequest
更新 line 的类别。
| JSON 表示法 |
|---|
{
"objectId": string,
"lineCategory": enum ( |
| 字段 | |
|---|---|
objectId
|
应用更新的相应行的对象 ID。
只有带有 更新线路的类别后,系统可能会重新规划线路。 |
lineCategory
|
要更新为的行类别。
确切的 |
RerouteLineRequest
重新路由 line,使其连接到所连接页面元素上距离最近的两个连接点。
| JSON 表示法 |
|---|
{ "objectId": string } |
| 字段 | |
|---|---|
objectId
|
要重新规划路线的线路的对象 ID。
只有带有 |