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

Идентификатор объекта для этой страницы. Идентификаторы объектов, используемые Page и PageElement используют одно и то же пространство имен.

pageType

enum ( PageType )

Тип страницы.

pageElements[]

object ( PageElement )

Элементы страницы, отображаемые на странице.

revisionId

string

Только для вывода. Идентификатор ревизии презентации. Может использоваться в запросах на обновление для подтверждения того, что ревизия презентации не изменилась с момента последней операции чтения. Заполняется только в том случае, если у пользователя есть доступ к редактированию презентации.

Идентификатор ревизии — это не порядковый номер, а непрозрачная строка. Формат идентификатора ревизии может меняться со временем. Гарантируется, что возвращенный идентификатор ревизии будет действителен только в течение 24 часов после его возврата и не может быть передан другим пользователям. Если идентификатор ревизии не изменился между вызовами, значит, презентация не изменилась. И наоборот, изменение идентификатора (для той же презентации и того же пользователя) обычно означает, что презентация была обновлена. Однако изменение идентификатора также может быть вызвано внутренними факторами, такими как изменение формата идентификатора.

pageProperties

object ( PageProperties )

Свойства страницы.

commentAnchors[]

object ( CommentAnchor )

Только вывод. Ссылки для комментариев, присутствующие на странице.

comments[]

object ( CommentThread )

Только вывод. Ветки комментариев, связанные со страницей. Заполняется только в том случае, если страница была получена с помощью GetPageRequest с заполненным commentsViewMode . В противном случае комментарии возвращаются в Presentation с помощью GetPresentationRequest .

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 Главная страница для заметок.

Элемент страницы

Визуальный элемент, отображаемый на странице.

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

Идентификатор объекта для этого элемента страницы. Идентификаторы объектов, используемые google.apps.slides.v1.Page и google.apps.slides.v1.PageElement используют одно и то же пространство имен.

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

Текст представлен в виде графического изображения.

В центре внимания спикер

Элемент PageElement ), представляющий собой раздел "В центре внимания — докладчик".

JSON-представление 
{
  "speakerSpotlightProperties": {
    object (SpeakerSpotlightProperties)
  }
}
Поля
speakerSpotlightProperties

object ( SpeakerSpotlightProperties )

Характеристики функции Speaker Spotlight.

SpeakerSpotlightProperties

Характеристики SpeakerSpotlight .

JSON-представление 
{
  "outline": {
    object (Outline)
  },
  "shadow": {
    object (Shadow)
  }
}
Поля
outline

object ( Outline )

Контур подсветки динамика. Если не задан, контур отсутствует.

shadow

object ( Shadow )

Тень от прожектора динамика. Если параметр не задан, тени нет.

SlideProperties

Свойства Page , которые актуальны только для страниц с типом страницы SLIDE.

JSON-представление 
{
  "layoutObjectId": string,
  "masterObjectId": string,
  "notesPage": {
    object (Page)
  },
  "isSkipped": boolean
}
Поля
layoutObjectId

string

Идентификатор объекта макета, на основе которого создан этот слайд. Это свойство доступно только для чтения.

masterObjectId

string

Идентификатор объекта-образца, на основе которого создан этот слайд. Это свойство доступно только для чтения.

notesPage

object ( Page )

Страница заметок, с которой связан этот слайд. Она определяет внешний вид страницы заметок при печати или экспорте слайдов с заметками докладчика. Страница заметок наследует свойства от notes master . Фигура-заполнитель типа BODY на странице заметок содержит заметки докладчика для этого слайда. Идентификатор этой фигуры определяется полем speakerNotesObjectId . Страница заметок доступна только для чтения, за исключением текстового содержимого и стилей фигуры заметок докладчика. Это свойство также доступно только для чтения.

isSkipped

boolean

Определяет, будет ли слайд пропущен в режиме презентации. По умолчанию — false.

Свойства макета

Свойства Page актуальны только для страниц с типом страницы LAYOUT.

JSON-представление 
{
  "masterObjectId": string,
  "name": string,
  "displayName": string
}
Поля
masterObjectId

string

Идентификатор объекта основного шаблона, на основе которого создан данный макет.

name

string

Название макета.

displayName

string

Удобочитаемое название макета.

ПримечанияСвойства

Свойства Page , которые актуальны только для страниц с типом страницы NOTES.

JSON-представление 
{
  "speakerNotesObjectId": string
}
Поля
speakerNotesObjectId

string

Идентификатор объекта фигуры на этой странице заметок, содержащей заметки докладчика для соответствующего слайда. Фактическая фигура может отсутствовать на странице заметок. Вставка текста с использованием этого идентификатора объекта автоматически создаст фигуру. В этом случае фактическая фигура может иметь другой идентификатор объекта. Действия presentations.get или pages.get всегда будут возвращать актуальный идентификатор объекта.

MasterProperties

Свойства Page , которые актуальны только для страниц с типом страницы MASTER.

JSON-представление 
{
  "displayName": string
}
Поля
displayName

string

Имя учителя, читаемое человеком.

Свойства страницы

Свойства Page .

Страница будет наследовать свойства от родительской страницы. В зависимости от типа страницы иерархия определяется либо в SlideProperties , либо LayoutProperties .

JSON-представление 
{
  "pageBackgroundFill": {
    object (PageBackgroundFill)
  },
  "colorScheme": {
    object (ColorScheme)
  }
}
Поля
pageBackgroundFill

object ( PageBackgroundFill )

Фоновая заливка страницы. Если параметр не задан, фоновая заливка наследуется от родительской страницы, если таковая существует. Если у страницы нет родительской страницы, то по умолчанию используется соответствующая заливка из редактора слайдов.

colorScheme

object ( ColorScheme )

Цветовая схема страницы. Если не задана, цветовая схема наследуется от родительской страницы. Если у страницы нет родительской страницы, используется цветовая схема Slides по умолчанию, соответствующая настройкам по умолчанию в редакторе Slides.

Редактировать можно только конкретные цвета первых 12 значений ThemeColorType . Кроме того, можно обновить только цветовую схему на Master -страницах. Для обновления поля необходимо указать цветовую схему, содержащую сопоставление всех первых 12 значений ThemeColorType с их конкретными цветами. Цвета для остальных значений ThemeColorType будут проигнорированы.

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 )

Растянутое изображение для заполнения.

Конец взаимоисключающих областей.

РастянутоеЗаполнениеИзображения

Заполнение растянутым изображением. Страница или элемент страницы полностью заполняется указанным изображением. Изображение растягивается, чтобы соответствовать размеру контейнера.

JSON-представление 
{
  "contentUrl": string,
  "size": {
    object (Size)
  }
}
Поля
contentUrl

string

Чтение contentUrl:

URL-адрес изображения со стандартным сроком действия 30 минут. Этот URL-адрес помечен учетной записью запрашивающего пользователя. Любой, у кого есть этот URL-адрес, фактически получает доступ к изображению от имени первоначального запрашивающего пользователя. Доступ к изображению может быть потерян, если изменятся настройки общего доступа к презентации.

Написание contentUrl:

Изображение загружается один раз во время вставки, и его копия сохраняется для отображения внутри презентации. Размер изображений не должен превышать 50 МБ, разрешение не должно превышать 25 мегапикселей, и они должны быть в одном из форматов PNG, JPEG или GIF.

Длина предоставленного URL-адреса не должна превышать 2 КБ.

size

object ( Size )

Исходный размер заливки изображения. Это поле доступно только для чтения.

Цветовая схема

Палитра предопределенных цветов для страницы.

JSON-представление 
{
  "colors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Поля
colors[]

object ( ThemeColorPair )

Пара «ThemeColorType» и соответствующие ей конкретные цветовые пары.

ThemeColorPair

Пара, сопоставляющая цветовой тип темы с конкретным цветом, который он представляет.

JSON-представление 
{
  "type": enum (ThemeColorType),
  "color": {
    object (RgbColor)
  }
}
Поля
type

enum ( ThemeColorType )

Тип выбранного цветового оформления.

color

object ( RgbColor )

Конкретный цвет, соответствующий цветовой гамме, указанной выше.

CommentAnchor

Содержит список всех мест на Page , которые связаны с веткой CommentThread с помощью одного и того же anchorId . Несколько отдельных ссылок могут указывать на одно и то же место, как внутри Page , так и на разных страницах.

JSON-представление 
{
  "anchorId": string,
  "objectAnchors": [
    {
      object (ObjectAnchor)
    }
  ]
}
Поля
anchorId

string

Только для вывода. Уникальный идентификатор ссылки на комментарий.

objectAnchors[]

object ( ObjectAnchor )

Только для вывода. Все местоположения на странице, основанные на идентификаторах объектов, которые ссылаются на идентификатор привязки.

ObjectAnchor

Представляет собой данные привязки комментариев, связанные с объектом Slides, например, Page или PageElement .

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 , комментарии к которым привязаны к диапазонам текста в [тексте] фигуры [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

 Генерирует миниатюру последней версии указанной страницы в презентации и возвращает URL-адрес миниатюрного изображения.