REST Resource: presentations.pages

Resource: Page

A page in a presentation.

JSON representation 
{
  "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.
}
Fields
objectId

string

The object ID for this page. Object IDs used by Page and PageElement share the same namespace.
pageType

enum (PageType)

The type of the page.
pageElements[]

object (PageElement)

The page elements rendered on the page.
revisionId

string

Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation.

The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes.
pageProperties

object (PageProperties)

The properties of the page.
commentAnchors[]

object (CommentAnchor)

Output only. The comment anchors present on the page.

comments[]

object (CommentThread)

Output only. The comment threads associated with the page. Only populated if the page was fetched via a GetPageRequest with a populated commentsViewMode. Otherwise, comments are returned in the Presentation via the GetPresentationRequest.

commentsViewMode

enum (CommentsViewMode)

Output only. The comments view mode applied to the page. Only populated if the page was fetched via a GetPageRequest with a populated commentsViewMode.

Properties that are specific for each page type. Masters do not require any additional properties. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
slideProperties

object (SlideProperties)

Slide specific properties. Only set if pageType = SLIDE.
layoutProperties

object (LayoutProperties)

Layout specific properties. Only set if pageType = LAYOUT.
notesProperties

object (NotesProperties)

Notes specific properties. Only set if pageType = NOTES.
masterProperties

object (MasterProperties)

Master specific properties. Only set if pageType = MASTER.
End of mutually exclusive fields.

PageType

The type of a page.

Enums
SLIDE A slide page.
MASTER A master slide page.
LAYOUT A layout page.
NOTES A notes page.
NOTES_MASTER A notes master page.

PageElement

A visual element rendered on a page.

JSON representation 
{
  "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.
}
Fields
objectId

string

The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace.
size

object (Size)

The size of the page element.
transform

object (AffineTransform)

The transform of the page element.

The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field.

The initial transform for the newly created Group is always the identity transform.
title

string

The title of the page element. Combined with description to display alt text.

The field is not supported for Group elements.
description

string

The description of the page element. Combined with title to display alt text.

The field is not supported for Group elements.
The kind of element that this PageElement represents. Each message contains any properties that are specific to that kind of page element. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
elementGroup

object (Group)

A collection of page elements joined as a single unit.
shape

object (Shape)

A generic shape.
image

object (Image)

An image page element.
video

object (Video)

A video page element.
line

object (Line)

A line page element.
table

object (Table)

A table page element.
wordArt

object (WordArt)

A word art page element.
sheetsChart

object (SheetsChart)

A linked chart embedded from Google Sheets. Unlinked charts are represented as images.
speakerSpotlight

object (SpeakerSpotlight)

A Speaker Spotlight.
End of mutually exclusive fields.

Group

A PageElement kind representing a joined collection of PageElements.

JSON representation 
{
  "children": [
    {
      object (PageElement)
    }
  ]
}
Fields
children[]

object (PageElement)

The collection of elements in the group. The minimum size of a group is 2.

WordArt

A PageElement kind representing word art.

JSON representation 
{
  "renderedText": string
}
Fields
renderedText

string

The text rendered as word art.

SpeakerSpotlight

A PageElement kind representing a Speaker Spotlight.

JSON representation 
{
  "speakerSpotlightProperties": {
    object (SpeakerSpotlightProperties)
  }
}
Fields
speakerSpotlightProperties

object (SpeakerSpotlightProperties)

The properties of the Speaker Spotlight.

SpeakerSpotlightProperties

The properties of the SpeakerSpotlight.

JSON representation 
{
  "outline": {
    object (Outline)
  },
  "shadow": {
    object (Shadow)
  }
}
Fields
outline

object (Outline)

The outline of the Speaker Spotlight. If not set, it has no outline.
shadow

object (Shadow)

The shadow of the Speaker Spotlight. If not set, it has no shadow.

SlideProperties

The properties of Page that are only relevant for pages with pageType SLIDE.

JSON representation 
{
  "layoutObjectId": string,
  "masterObjectId": string,
  "notesPage": {
    object (Page)
  },
  "isSkipped": boolean
}
Fields
layoutObjectId

string

The object ID of the layout that this slide is based on. This property is read-only.
masterObjectId

string

The object ID of the master that this slide is based on. This property is read-only.
notesPage

object (Page)

The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only.
isSkipped

boolean

Whether the slide is skipped in the presentation mode. Defaults to false.

LayoutProperties

The properties of Page are only relevant for pages with pageType LAYOUT.

JSON representation 
{
  "masterObjectId": string,
  "name": string,
  "displayName": string
}
Fields
masterObjectId

string

The object ID of the master that this layout is based on.
name

string

The name of the layout.
displayName

string

The human-readable name of the layout.

NotesProperties

The properties of Page that are only relevant for pages with pageType NOTES.

JSON representation 
{
  "speakerNotesObjectId": string
}
Fields
speakerNotesObjectId

string

The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The presentations.get or pages.get action will always return the latest object ID.

MasterProperties

The properties of Page that are only relevant for pages with pageType MASTER.

JSON representation 
{
  "displayName": string
}
Fields
displayName

string

The human-readable name of the master.

PageProperties

The properties of the Page.

The page will inherit properties from the parent page. Depending on the page type the hierarchy is defined in either SlideProperties or LayoutProperties.

JSON representation 
{
  "pageBackgroundFill": {
    object (PageBackgroundFill)
  },
  "colorScheme": {
    object (ColorScheme)
  }
}
Fields
pageBackgroundFill

object (PageBackgroundFill)

The background fill of the page. If unset, the background fill is inherited from a parent page if it exists. If the page has no parent, then the background fill defaults to the corresponding fill in the Slides editor.
colorScheme

object (ColorScheme)

The color scheme of the page. If unset, the color scheme is inherited from a parent page. If the page has no parent, the color scheme uses a default Slides color scheme, matching the defaults in the Slides editor.

Only the concrete colors of the first 12 ThemeColorTypes are editable. In addition, only the color scheme on Master pages can be updated. To update the field, a color scheme containing mappings from all the first 12 ThemeColorTypes to their concrete colors must be provided. Colors for the remaining ThemeColorTypes will be ignored.

PageBackgroundFill

The page background fill.

JSON representation 
{
  "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.
}
Fields
propertyState

enum (PropertyState)

The background fill property state.

Updating the fill on a page will implicitly update this field to RENDERED, unless another value is specified in the same request. To have no fill on a page, set this field to NOT_RENDERED. In this case, any other fill fields set in the same request will be ignored.
The kind of background fill. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
solidFill

object (SolidFill)

Solid color fill.
stretchedPictureFill

object (StretchedPictureFill)

Stretched picture fill.
End of mutually exclusive fields.

StretchedPictureFill

The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container.

JSON representation 
{
  "contentUrl": string,
  "size": {
    object (Size)
  }
}
Fields
contentUrl

string

Reading the contentUrl:

An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change.

Writing the contentUrl:

The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format.

The provided URL can be at most 2 kB in length.
size

object (Size)

The original size of the picture fill. This field is read-only.

ColorScheme

The palette of predefined colors for a page.

JSON representation 
{
  "colors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Fields
colors[]

object (ThemeColorPair)

The ThemeColorType and corresponding concrete color pairs.

ThemeColorPair

A pair mapping a theme color type to the concrete color it represents.

JSON representation 
{
  "type": enum (ThemeColorType),
  "color": {
    object (RgbColor)
  }
}
Fields
type

enum (ThemeColorType)

The type of the theme color.
color

object (RgbColor)

The concrete color corresponding to the theme color type above.

CommentAnchor

Contains a list of all locations in a Page that are anchored to a CommentThread via the same anchorId. Multiple separate anchors may refer to the same location, either within a Page or across different pages,

JSON representation 
{
  "anchorId": string,
  "objectAnchors": [
    {
      object (ObjectAnchor)
    }
  ]
}
Fields
anchorId

string

Output only. The unique ID of the comment anchor.
objectAnchors[]

object (ObjectAnchor)

Output only. All object ID-based locations within a page that refer to the anchor ID.

ObjectAnchor

Represents comment anchor data tied to a Slides object, for example a Page or PageElement.

JSON representation 
{
  "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.
}
Fields
objectId

string

Output only. The page or page element that the comment thread is anchored to.
Output only. The text ranges within the page element that the comment thread is anchored to. Will be empty if the comment anchor is for the entire page or page element rather than a text range within the element. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
shapeTextAnchors

object (ShapeTextAnchors)

Populated for Shapes that have comments anchored to ranges of text in the shape's [text][google.apps.slides.v1.Shape.TextContent].
tableCellAnchors

object (TableCellAnchors)

Populated for Tables that have comments anchored to ranges of text in one or more of the table's cells.
End of mutually exclusive fields.

ShapeTextAnchors

Represents text ranges within a shape covered by a comment anchor.

JSON representation 
{
  "ranges": [
    {
      object (TextRange)
    }
  ]
}
Fields
ranges[]

object (TextRange)

A list of text ranges covered by the comment anchor.

TextRange

Specifies a contiguous range of text within a shape or table cell's text.

JSON representation 
{
  "startIndex": integer,
  "endIndex": integer
}
Fields
startIndex

integer

The zero-based index of the beginning range. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
endIndex

integer

The zero-based index of the end of the range. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

TableCellAnchors

Represents table cell ranges within a table covered by a comment anchor.

JSON representation 
{
  "cellRanges": [
    {
      object (TableCellTextRanges)
    }
  ]
}
Fields
cellRanges[]

object (TableCellTextRanges)

A list of all table cells in a table that have text covered by the anchor in the table.

TableCellTextRanges

Represents text ranges within a table cell covered by a comment anchor.

JSON representation 
{
  "cellLocation": {
    object (TableCellLocation)
  },
  "ranges": [
    {
      object (TextRange)
    }
  ]
}
Fields
cellLocation

object (TableCellLocation)

The location of the table cell.
ranges[]

object (TextRange)

A list of all text ranges covered by the anchor in this cell.

Methods

get

 Gets the latest version of the specified page in the presentation.

getThumbnail

 Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image.