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 时才设置。

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)

演讲者特写。

群组

表示 PageElements 的联接集合的 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)

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

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

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