REST Resource: presentations.pages

资源:页面

演示文稿中的页面。

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

  // Union field properties can be only one of the following:
  "slideProperties": {
    object (SlideProperties)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "notesProperties": {
    object (NotesProperties)
  },
  "masterProperties": {
    object (MasterProperties)
  }
  // End of list of possible types for union field properties.
}
字段
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)

网页的属性。

联合字段 properties。每种页面类型专用的属性。主实例不需要任何其他属性。properties 只能是下列其中一项:
slideProperties

object (SlideProperties)

幻灯片专用属性。仅当 pageType = SLIDE 时设置。

layoutProperties

object (LayoutProperties)

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

notesProperties

object (NotesProperties)

备注特定属性。仅当 pageType = NOTES 时设置。

masterProperties

object (MasterProperties)

主资源属性。仅当 pageType = MASTER 时设置。

网页类型

网页类型。

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

页面元素

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

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

  // Union field element_kind can be only one of the following:
  "elementGroup": {
    object (Group)
  },
  "shape": {
    object (Shape)
  },
  "image": {
    object (Image)
  },
  "video": {
    object (Video)
  },
  "line": {
    object (Line)
  },
  "table": {
    object (Table)
  },
  "wordArt": {
    object (WordArt)
  },
  "sheetsChart": {
    object (SheetsChart)
  }
  // End of list of possible types for union field element_kind.
}
字段
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 元素不支持该字段。

联合字段 element_kind。此 PageElement 表示的元素类型。每个消息都包含此类页面元素所特有的任何属性。element_kind 只能是下列其中一项:
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 表格嵌入的关联图表。未关联的图表以图片表示。

表示已联接的 PageElement 集合的 PageElement 种类。

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

object (PageElement)

组中的元素集合。一个群组的最小规模为 2。

艺术字

PageElement 种类,表示艺术字。

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

string

呈现为艺术字的文本。

幻灯片属性

Page 的属性,仅与 pageType SLIDE 的页面相关。

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

string

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

masterObjectId

string

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

notesPage

object (Page)

此幻灯片关联的备注页面。它定义了打印或导出带演讲者备注的幻灯片的备注页面的外观。备注页面会继承 notes master 中的属性。“备注”页面上带有“正文”类型的占位符形状包含此幻灯片的演讲者备注。此形状的 ID 由 speakerNotesObjectId 字段标识。备注页面为只读模式,但演讲者备注形状的文本内容和样式除外。此属性为只读属性。

isSkipped

boolean

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

布局属性

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

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

string

此布局所基于的主实例的对象 ID。

name

string

布局的名称。

displayName

string

人类可读懂的布局名称。

备注属性

Page 的属性,仅与具有 pageType NOTES 的页面相关。

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

string

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

主属性

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

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

string

简单易懂的母版名称。

页面属性

Page 的属性。

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

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

object (PageBackgroundFill)

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

colorScheme

object (ColorScheme)

网页的配色方案。如果未设置,则配色方案继承自父页面。如果页面没有父级,则配色方案将使用默认的幻灯片配色方案,以匹配幻灯片编辑器中的默认设置。

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

页面背景填充

页面背景填充。

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

  // Union field kind can be only one of the following:
  "solidFill": {
    object (SolidFill)
  },
  "stretchedPictureFill": {
    object (StretchedPictureFill)
  }
  // End of list of possible types for union field kind.
}
字段
propertyState

enum (PropertyState)

背景填充属性的状态。

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

联合字段 kind。背景填充的类型。kind 只能是下列其中一项:
solidFill

object (SolidFill)

单色填充。

stretchedPictureFill

object (StretchedPictureFill)

拉伸图片填充效果。

拉伸图片填充效果

拉伸的图片填充效果。页面或页面元素完全填充指定图片。图片已被拉伸以适应其容器。

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

string

读取 contentUrl:

默认生命周期为 30 分钟的图片的网址。此网址使用请求者的帐号进行了标记。知道该网址的任何人都可以以原始请求者的身份访问图片。如果演示文稿的共享设置发生变化,可能会失去对该图片的访问权限。

编写 contentUrl:

系统会在插入时抓取一次图片,并存储其副本以供在演示文稿内显示。图片必须小于 50MB,不能超过 2500 万像素,并且必须采用 PNG、JPEG 或 GIF 格式。

提供的网址最大为 2 kB。

size

object (Size)

图片填充的原始尺寸。此字段为只读字段。

配色方案

页面的预定义调色板。

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

object (ThemeColorPair)

ThemeColorType 和相应的具体颜色对。

主题颜色对

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

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

enum (ThemeColorType)

主题颜色的类型。

color

object (RgbColor)

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

方法

get

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

getThumbnail

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