REST Resource: presentations.pages

资源:页面

演示文稿中的页面。

JSON 表示法
{
  "objectId": string,
  "pageType": enum (PageType),
  "pageElements": [
    {
      object (PageElement)
    }
  ],
  "revisionId": string,
  "pageProperties": {
    object (PageProperties)
  },
  "commentAnchors": [
    {
      object (CommentAnchor)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "slideProperties": {
    object (SlideProperties)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "notesProperties": {
    object (NotesProperties)
  },
  "masterProperties": {
    object (MasterProperties)
  }
  // End of mutually exclusive fields.
}
字段
objectId

string

相应网页的对象 ID。PagePageElement 使用的对象 ID 共用同一命名空间。

pageType

enum (PageType)

网页的类型。

pageElements[]

object (PageElement)

网页上呈现的页面元素。

revisionId

string

仅限输出。演示的修订版本 ID。可在更新请求中使用,以断言演示修订版本自上次读取操作以来未发生更改。仅当用户拥有演示文稿的编辑权限时才会填充。

修订版本 ID 不是一个连续的数字,而是一个不透明的字符串。修订版本 ID 的格式可能会随时间而变化。返回的修订版本 ID 仅保证在返回后的 24 小时内有效,且无法在用户之间共享。如果两次调用之间的修订 ID 未发生变化,则表示演示文稿未发生变化。相反,如果 ID 发生变化(对于同一演示和用户),通常意味着演示已更新。不过,ID 发生变化也可能是由于内部因素(例如 ID 格式发生变化)所致。

pageProperties

object (PageProperties)

相应网页的属性。

commentAnchors[]

object (CommentAnchor)

仅限输出。页面上显示的评论锚点。

comments[]

object (CommentThread)

仅限输出。与网页关联的评论会话。仅当通过 GetPageRequest(其中填充了 commentsViewMode)提取网页时填充。否则,系统会通过 GetPresentationRequestPresentation 中返回评论。

commentsViewMode

enum (CommentsViewMode)

仅限输出。应用于网页的评论视图模式。仅当通过 GetPageRequest(其中填充了 commentsViewMode)提取网页时填充。

特定于每种网页类型的属性。主广告素材不需要任何其他属性。以下是互斥字段的列表。在响应中,最多只能设置一个字段:
slideProperties

object (SlideProperties)

幻灯片特有的属性。仅当 pageType = SLIDE 时才设置。

layoutProperties

object (LayoutProperties)

布局特定属性。仅当 pageType = LAYOUT 时才设置。

notesProperties

object (NotesProperties)

记录特定属性。仅当 pageType = NOTES 时才设置。

masterProperties

object (MasterProperties)

掌握特定媒体资源。仅当 pageType = MASTER 时才设置。

互斥字段的结束位置。

PageType

网页的类型。

枚举
SLIDE 幻灯片页面。
MASTER 母版幻灯片页面。
LAYOUT 布局页面。
NOTES 记事页面。
NOTES_MASTER 备注母版。

PageElement

在网页上呈现的视觉元素。

JSON 表示法
{
  "objectId": string,
  "size": {
    object (Size)
  },
  "transform": {
    object (AffineTransform)
  },
  "title": string,
  "description": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "elementGroup": {
    object (Group)
  },
  "shape": {
    object (Shape)
  },
  "image": {
    object (Image)
  },
  "video": {
    object (Video)
  },
  "line": {
    object (Line)
  },
  "table": {
    object (Table)
  },
  "wordArt": {
    object (WordArt)
  },
  "sheetsChart": {
    object (SheetsChart)
  },
  "speakerSpotlight": {
    object (SpeakerSpotlight)
  }
  // End of mutually exclusive fields.
}
字段
objectId

string

相应页面元素的 ID。google.apps.slides.v1.Pagegoogle.apps.slides.v1.PageElement 使用的对象 ID 共用同一命名空间。

size

object (Size)

页面元素的大小。

transform

object (AffineTransform)

页面元素的转换。

页面元素的视觉外观由其绝对转换决定。若要计算绝对转换,请将网页元素的转换与所有父组的转换预先串联起来。如果页面元素不在群组中,则其绝对转换与此字段中的值相同。

新创建的 Group 的初始转换始终是恒等转换。

title

string

页面元素的标题。与说明结合使用以显示替代文本。

此字段不支持 Group 元素。

description

string

页面元素的说明。与标题结合使用以显示替代文本。

此字段不支持 Group 元素。

相应 PageElement 所表示的元素类型。每条消息都包含特定于相应网页元素的所有属性。以下是互斥字段的列表。在响应中,最多只能设置一个字段:
elementGroup

object (Group)

一组组合成单个单元的页面元素。

shape

object (Shape)

一般形状。

image

object (Image)

图片页面元素。

video

object (Video)

视频页面元素。

line

object (Line)

线条页面元素。

table

object (Table)

表格页面元素。

wordArt

object (WordArt)

艺术字页面元素。

sheetsChart

object (SheetsChart)

从 Google 表格中嵌入的关联图表。未关联的图表以图片形式显示。

speakerSpotlight

object (SpeakerSpotlight)

演讲者聚焦。

互斥字段的结束位置。

群组

一种 PageElement 种类,表示 PageElement 的联接集合。

JSON 表示法
{
  "children": [
    {
      object (PageElement)
    }
  ]
}
字段
children[]

object (PageElement)

相应组中的元素集合。群组的最小规模为 2。

WordArt

表示艺术字的 PageElement 类型。

JSON 表示法
{
  "renderedText": string
}
字段
renderedText

string

呈现为艺术字效果的文本。

SpeakerSpotlight

表示演讲者特写的 PageElement 类型。

JSON 表示法
{
  "speakerSpotlightProperties": {
    object (SpeakerSpotlightProperties)
  }
}
字段
speakerSpotlightProperties

object (SpeakerSpotlightProperties)

“演讲者特写”的属性。

SpeakerSpotlightProperties

SpeakerSpotlight 的属性。

JSON 表示法
{
  "outline": {
    object (Outline)
  },
  "shadow": {
    object (Shadow)
  }
}
字段
outline

object (Outline)

演讲者特写的轮廓。如果未设置,则没有轮廓。

shadow

object (Shadow)

演讲者聚焦的阴影。如果未设置,则没有阴影。

SlideProperties

仅与 pageType 为 SLIDE 的网页相关的 Page 属性。

JSON 表示法
{
  "layoutObjectId": string,
  "masterObjectId": string,
  "notesPage": {
    object (Page)
  },
  "isSkipped": boolean
}
字段
layoutObjectId

string

相应幻灯片所基于的布局的对象 ID。此属性为只读属性。

masterObjectId

string

相应幻灯片所基于的母版的对象 ID。此属性为只读属性。

notesPage

object (Page)

与此幻灯片关联的备注页。它定义了在打印或导出包含演讲者备注的幻灯片时备注页面的外观。备注页会从 notes master 继承属性。备注页上类型为 BODY 的占位形状包含相应幻灯片的演讲者备注。相应形状的 ID 由 speakerNotesObjectId 字段标识。备注页处于只读状态,但演讲者备注形状的文本内容和样式除外。此属性为只读属性。

isSkipped

boolean

相应幻灯片在演示模式下是否会被跳过。默认值为 false。

LayoutProperties

Page 的属性仅与 pageType 为 LAYOUT 的网页相关。

JSON 表示法
{
  "masterObjectId": string,
  "name": string,
  "displayName": string
}
字段
masterObjectId

string

相应布局所基于的主控的对象 ID。

name

string

布局的名称。

displayName

string

布局的简明易懂的名称。

NotesProperties

仅与 pageType 为 NOTES 的网页相关的 Page 属性。

JSON 表示法
{
  "speakerNotesObjectId": string
}
字段
speakerNotesObjectId

string

相应幻灯片包含演讲者备注的备注页上形状的对象 ID。备注页上可能并不总是存在实际形状。使用此对象 ID 插入文字时,系统会自动创建相应形状。在这种情况下,实际形状可能具有不同的对象 ID。presentations.getpages.get 操作将始终返回最新的对象 ID。

MasterProperties

仅与 pageType 为 MASTER 的网页相关的 Page 属性。

JSON 表示法
{
  "displayName": string
}
字段
displayName

string

主账号的简明易懂的名称。

PageProperties

Page 的属性。

该网页将继承父网页的属性。层次结构是在 SlidePropertiesLayoutProperties 中定义的,具体取决于网页类型。

JSON 表示法
{
  "pageBackgroundFill": {
    object (PageBackgroundFill)
  },
  "colorScheme": {
    object (ColorScheme)
  }
}
字段
pageBackgroundFill

object (PageBackgroundFill)

页面的背景填充。如果未设置,则背景填充会从父页面(如果存在)继承。如果页面没有父级,则背景填充会默认采用 Google 幻灯片编辑器中的相应填充。

colorScheme

object (ColorScheme)

网页的配色方案。如果未设置,则从父网页继承配色方案。如果页面没有父级,则配色方案会使用默认的 Google 幻灯片配色方案,与 Google 幻灯片编辑器中的默认设置一致。

只有前 12 个 ThemeColorType 的具体颜色可供修改。此外,只能更新 Master 页面上的配色方案。如需更新该字段,必须提供一个配色方案,其中包含前 12 个 ThemeColorType 到其具体颜色的映射。其余 ThemeColorTypes 的颜色将被忽略。

PageBackgroundFill

页面背景填充。

JSON 表示法
{
  "propertyState": enum (PropertyState),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "solidFill": {
    object (SolidFill)
  },
  "stretchedPictureFill": {
    object (StretchedPictureFill)
  }
  // End of mutually exclusive fields.
}
字段
propertyState

enum (PropertyState)

背景填充属性状态。

更新网页上的填充时,系统会隐式将此字段更新为 RENDERED,除非在同一请求中指定了其他值。如需在网页上不显示任何填充内容,请将此字段设置为 NOT_RENDERED。在这种情况下,同一请求中设置的任何其他填充字段都会被忽略。

背景填充的类型。以下是互斥字段的列表。在响应中,最多只能设置一个字段:
solidFill

object (SolidFill)

纯色填充。

stretchedPictureFill

object (StretchedPictureFill)

拉伸图片填充。

互斥字段的结束位置。

StretchedPictureFill

拉伸的图片填充。页面或页面元素完全填充了指定的图片。图片会拉伸以适应其容器。

JSON 表示法
{
  "contentUrl": string,
  "size": {
    object (Size)
  }
}
字段
contentUrl

string

读取 contentUrl:

指向图片的网址,默认有效时长为 30 分钟。相应网址已与请求者的账号相关联。拥有该网址的任何人都可以像原始要求提出者一样访问相应图片。如果演示文稿的共享设置发生变化,您可能无法再访问相应图片。

编写 contentUrl:

图片会在插入时提取一次,并存储一份副本以在演示文稿中显示。图片大小必须小于 50MB,像素数不得超过 2,500 万,且必须采用 PNG、JPEG 或 GIF 格式。

所提供的网址长度不得超过 2 kB。

size

object (Size)

图片填充的原始大小。此字段为只读字段。

ColorScheme

页面的预定义颜色调色板。

JSON 表示法
{
  "colors": [
    {
      object (ThemeColorPair)
    }
  ]
}
字段
colors[]

object (ThemeColorPair)

ThemeColorType 和对应的具体颜色对。

ThemeColorPair

一个将主题颜色类型映射到其所代表的具体颜色的对。

JSON 表示法
{
  "type": enum (ThemeColorType),
  "color": {
    object (RgbColor)
  }
}
字段
type

enum (ThemeColorType)

主题颜色类型。

color

object (RgbColor)

与上述主题颜色类型对应的具体颜色。

CommentAnchor

包含 Page 中通过同一 anchorId 锚定到 CommentThread 的所有位置的列表。多个单独的锚点可能指向同一位置,无论是在 Page 内还是在不同网页之间,

JSON 表示法
{
  "anchorId": string,
  "objectAnchors": [
    {
      object (ObjectAnchor)
    }
  ]
}
字段
anchorId

string

仅限输出。评论锚点的唯一 ID。

objectAnchors[]

object (ObjectAnchor)

仅限输出。网页中所有基于对象 ID 且引用锚 ID 的位置。

ObjectAnchor

表示与幻灯片对象(例如 PagePageElement)相关联的注释锚点数据。

JSON 表示法
{
  "objectId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "shapeTextAnchors": {
    object (ShapeTextAnchors)
  },
  "tableCellAnchors": {
    object (TableCellAnchors)
  }
  // End of mutually exclusive fields.
}
字段
objectId

string

仅限输出。评论串所锚定的网页或页面元素。

仅限输出。评论会话所锚定的页面元素中的文本范围。如果评论锚点是针对整个网页或页面元素,而不是元素内的文本范围,则为空。以下是互斥字段的列表。在响应中,最多只能设置一个字段:
shapeTextAnchors

object (ShapeTextAnchors)

针对 Shapes 填充,这些 的评论锚定到形状的 [text][google.apps.slides.v1.Shape.TextContent] 中的文本范围。

tableCellAnchors

object (TableCellAnchors)

针对以下情况填充:Tables 的注释锚定到表格中一个或多个单元格的文本范围。

互斥字段的结束位置。

ShapeTextAnchors

表示评论锚点所覆盖的形状内的文本范围。

JSON 表示法
{
  "ranges": [
    {
      object (TextRange)
    }
  ]
}
字段
ranges[]

object (TextRange)

评论锚点所涵盖的文本范围列表。

TextRange

指定形状或表格单元格 text 内的连续文本范围。

JSON 表示法
{
  "startIndex": integer,
  "endIndex": integer
}
字段
startIndex

integer

起始范围的索引(从零开始)。此字段为 Int32Value,以便适应未来具有开放式范围的使用情形。

endIndex

integer

范围结束位置的索引(从零开始)。此字段为 Int32Value,以便适应未来具有开放式范围的使用情形。

TableCellAnchors

表示评论锚点所涵盖的表格中的单元格范围。

JSON 表示法
{
  "cellRanges": [
    {
      object (TableCellTextRanges)
    }
  ]
}
字段
cellRanges[]

object (TableCellTextRanges)

表格中包含锚点所涵盖文本的所有表格单元格的列表。

TableCellTextRanges

表示评论锚点所涵盖的表格单元格内的文本范围。

JSON 表示法
{
  "cellLocation": {
    object (TableCellLocation)
  },
  "ranges": [
    {
      object (TextRange)
    }
  ]
}
字段
cellLocation

object (TableCellLocation)

表格单元格的位置。

ranges[]

object (TextRange)

相应单元格中锚点所涵盖的所有文本范围的列表。

方法

get

获取演示中指定页面的最新版本。

getThumbnail

生成演示中指定页面的最新版本的缩略图,并返回指向该缩略图的网址。