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 = 幻灯片时,才设置。

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,

  // 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)
  },
  "speakerSpotlight": {
    object (SpeakerSpotlight)
  }
  // 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 表格嵌入的链接图表。解除关联的图表以图片形式表示。

speakerSpotlight

object (SpeakerSpotlight)

演讲者特写。

实体组

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

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 幻灯片的页面相关的 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)

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

colorScheme

object (ColorScheme)

网页的配色方案。如果此政策未设置,系统会沿用父页面的配色方案。如果页面没有父级,配色方案将使用默认的幻灯片配色方案,与幻灯片编辑器中的配色方案保持一致。

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

PageBackgroundFill

页面背景填充。

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)

拉伸照片填充。

StretchedPictureFill

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

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

string

读取 contentUrl:

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

编写 contentUrl:

在插入时提取一次图片,并存储副本以在演示文稿内显示。图片必须小于 50MB,不能超过 2500 万像素,并且必须采用 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)

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

方法

get

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

getThumbnail

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