Requests

Запрос

Единственный тип обновления, применяемый к презентации.

Представление JSON
{

  // Union field kind can be only one of the following:
  "createSlide": {
    object (CreateSlideRequest)
  },
  "createShape": {
    object (CreateShapeRequest)
  },
  "createTable": {
    object (CreateTableRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "insertTableRows": {
    object (InsertTableRowsRequest)
  },
  "insertTableColumns": {
    object (InsertTableColumnsRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "deleteObject": {
    object (DeleteObjectRequest)
  },
  "updatePageElementTransform": {
    object (UpdatePageElementTransformRequest)
  },
  "updateSlidesPosition": {
    object (UpdateSlidesPositionRequest)
  },
  "deleteText": {
    object (DeleteTextRequest)
  },
  "createImage": {
    object (CreateImageRequest)
  },
  "createVideo": {
    object (CreateVideoRequest)
  },
  "createSheetsChart": {
    object (CreateSheetsChartRequest)
  },
  "createLine": {
    object (CreateLineRequest)
  },
  "refreshSheetsChart": {
    object (RefreshSheetsChartRequest)
  },
  "updateShapeProperties": {
    object (UpdateShapePropertiesRequest)
  },
  "updateImageProperties": {
    object (UpdateImagePropertiesRequest)
  },
  "updateVideoProperties": {
    object (UpdateVideoPropertiesRequest)
  },
  "updatePageProperties": {
    object (UpdatePagePropertiesRequest)
  },
  "updateTableCellProperties": {
    object (UpdateTableCellPropertiesRequest)
  },
  "updateLineProperties": {
    object (UpdateLinePropertiesRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "replaceAllShapesWithImage": {
    object (ReplaceAllShapesWithImageRequest)
  },
  "duplicateObject": {
    object (DuplicateObjectRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "replaceAllShapesWithSheetsChart": {
    object (ReplaceAllShapesWithSheetsChartRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "updateTableBorderProperties": {
    object (UpdateTableBorderPropertiesRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableRowProperties": {
    object (UpdateTableRowPropertiesRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "groupObjects": {
    object (GroupObjectsRequest)
  },
  "ungroupObjects": {
    object (UngroupObjectsRequest)
  },
  "updatePageElementAltText": {
    object (UpdatePageElementAltTextRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateSlideProperties": {
    object (UpdateSlidePropertiesRequest)
  },
  "updatePageElementsZOrder": {
    object (UpdatePageElementsZOrderRequest)
  },
  "updateLineCategory": {
    object (UpdateLineCategoryRequest)
  },
  "rerouteLine": {
    object (RerouteLineRequest)
  }
  // End of list of possible types for union field kind.
}
Поля
Союз поле kind . Тип обновления. Требуется ровно одно поле. kind может быть только одним из следующих:
createSlide

object ( CreateSlideRequest )

Создает новый слайд.

createShape

object ( CreateShapeRequest )

Создает новую форму.

createTable

object ( CreateTableRequest )

Создает новую таблицу.

insertText

object ( InsertTextRequest )

Вставляет текст в фигуру или ячейку таблицы.

insertTableRows

object ( InsertTableRowsRequest )

Вставляет строки в таблицу.

insertTableColumns

object ( InsertTableColumnsRequest )

Вставляет столбцы в таблицу.

deleteTableRow

object ( DeleteTableRowRequest )

Удаляет строку из таблицы.

deleteTableColumn

object ( DeleteTableColumnRequest )

Удаляет столбец из таблицы.

replaceAllText

object ( ReplaceAllTextRequest )

Заменяет все экземпляры указанного текста.

deleteObject

object ( DeleteObjectRequest )

Удаляет страницу или элемент страницы из презентации.

updatePageElementTransform

object ( UpdatePageElementTransformRequest )

Обновляет преобразование элемента страницы.

updateSlidesPosition

object ( UpdateSlidesPositionRequest )

Обновляет положение набора слайдов в презентации.

deleteText

object ( DeleteTextRequest )

Удаляет текст из фигуры или ячейки таблицы.

createImage

object ( CreateImageRequest )

Создает образ.

createVideo

object ( CreateVideoRequest )

Создает видео.

createSheetsChart

object ( CreateSheetsChartRequest )

Создает встроенную диаграмму Google Sheets.

createLine

object ( CreateLineRequest )

Создает линию.

refreshSheetsChart

object ( RefreshSheetsChartRequest )

Обновляет диаграмму Google Sheets.

updateShapeProperties

object ( UpdateShapePropertiesRequest )

Обновляет свойства Shape .

updateImageProperties

object ( UpdateImagePropertiesRequest )

Обновляет свойства Image .

updateVideoProperties

object ( UpdateVideoPropertiesRequest )

Обновляет свойства Video .

updatePageProperties

object ( UpdatePagePropertiesRequest )

Обновляет свойства Page .

updateTableCellProperties

object ( UpdateTableCellPropertiesRequest )

Обновляет свойства TableCell .

updateLineProperties

object ( UpdateLinePropertiesRequest )

Обновляет свойства Line .

createParagraphBullets

object ( CreateParagraphBulletsRequest )

Создает маркеры для абзацев.

replaceAllShapesWithImage

object ( ReplaceAllShapesWithImageRequest )

Заменяет все фигуры, соответствующие некоторым критериям, изображением.

duplicateObject

object ( DuplicateObjectRequest )

Дублирует элемент слайда или страницы.

updateTextStyle

object ( UpdateTextStyleRequest )

Обновляет стиль текста в Shape или Table .

replaceAllShapesWithSheetsChart

object ( ReplaceAllShapesWithSheetsChartRequest )

Заменяет все фигуры, соответствующие некоторым критериям, диаграммой Google Sheets.

deleteParagraphBullets

object ( DeleteParagraphBulletsRequest )

Удаляет маркеры из абзацев.

updateParagraphStyle

object ( UpdateParagraphStyleRequest )

Обновляет стиль абзацев в Shape или Table .

updateTableBorderProperties

object ( UpdateTableBorderPropertiesRequest )

Обновляет свойства границ таблицы в Table .

updateTableColumnProperties

object ( UpdateTableColumnPropertiesRequest )

Обновляет свойства столбца Table .

updateTableRowProperties

object ( UpdateTableRowPropertiesRequest )

Обновляет свойства строки Table .

mergeTableCells

object ( MergeTableCellsRequest )

Объединяет ячейки в Table .

unmergeTableCells

object ( UnmergeTableCellsRequest )

Разъединяет ячейки в Table .

groupObjects

object ( GroupObjectsRequest )

Группирует объекты, например элементы страницы.

ungroupObjects

object ( UngroupObjectsRequest )

Разгруппирует объекты, такие как groups .

updatePageElementAltText

object ( UpdatePageElementAltTextRequest )

Обновляет заголовок замещающего текста и/или описание page element .

replaceImage

object ( ReplaceImageRequest )

Заменяет существующее изображение новым изображением.

updateSlideProperties

object ( UpdateSlidePropertiesRequest )

Обновляет свойства слайда

updatePageElementsZOrder

object ( UpdatePageElementsZOrderRequest )

Обновляет Z-порядок page elements .

updateLineCategory

object ( UpdateLineCategoryRequest )

Обновляет категорию line .

rerouteLine

object ( RerouteLineRequest )

Перенаправляет line таким образом, чтобы она соединялась в двух ближайших точках соединения на связанных элементах страницы.

CreateSlideRequest

Создает слайд.

Представление JSON
{
  "objectId": string,
  "insertionIndex": integer,
  "slideLayoutReference": {
    object (LayoutReference)
  },
  "placeholderIdMappings": [
    {
      object (LayoutPlaceholderIdMapping)
    }
  ]
}
Поля
objectId

string

Предоставляемый пользователем идентификатор объекта.

Если вы указываете идентификатор, он должен быть уникальным среди всех страниц и элементов страницы в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [a-zA-Z0-9_] ); остальные символы могут включать их, а также дефис или двоеточие (соответствует регулярному выражению [a-zA-Z0-9_-:] ). Длина идентификатора должна быть от 5 до 50 символов включительно.

Если вы не укажете идентификатор, будет создан уникальный идентификатор.

insertionIndex

integer

Необязательный отсчитываемый от нуля индекс, указывающий, куда вставить слайды.

Если вы не укажете индекс, слайд будет создан в конце.

slideLayoutReference

object ( LayoutReference )

Ссылка на макет вставляемого слайда на основе текущего образца , который является одним из следующих:

  • Мастер предыдущего указателя слайдов.
  • Мастер первого слайда, если insertionIndex равен нулю.
  • Первый мастер в презентации, если нет слайдов.

Если LayoutReference не найден в текущем мастере, возвращается ошибка неверного запроса 400.

Если вы не укажете ссылку на макет, слайд использует предопределенный макет BLANK .

placeholderIdMappings[]

object ( LayoutPlaceholderIdMapping )

Необязательный список сопоставлений идентификаторов объектов из placeholder (заполнителей) в макете в заполнители, созданные на слайде из указанного макета. Может использоваться только в том случае, если указан параметр slideLayoutReference .

Справочник по макету

Ссылка на макет слайда. Это может относиться либо к:

  • Предопределенный макет
  • Один из макетов в презентации.
Представление JSON
{

  // Union field kind can be only one of the following:
  "predefinedLayout": enum (PredefinedLayout),
  "layoutId": string
  // End of list of possible types for union field kind.
}
Поля
Союз поле kind . Тип LayoutReference. kind может быть только одним из следующих:
predefinedLayout

enum ( PredefinedLayout )

Предопределенный макет.

layoutId

string

Идентификатор макета: идентификатор объекта одного из макетов в презентации.

Предопределенный макет

Предопределенные типы макетов. Это часто встречающиеся макеты в презентациях. Однако нет гарантии, что эти макеты присутствуют в текущем мастере, поскольку они могли быть удалены или не являться частью используемой темы. Кроме того, заполнители в каждом макете могли быть изменены.

перечисления
PREDEFINED_LAYOUT_UNSPECIFIED Неопределенный макет.
BLANK Пустой макет, без заполнителей.
CAPTION_ONLY Макет с подписью внизу.
TITLE Макет с заголовком и подзаголовком.
TITLE_AND_BODY Макет с заголовком и телом.
TITLE_AND_TWO_COLUMNS Макет с заголовком и двумя столбцами.
TITLE_ONLY Макет только с заголовком.
SECTION_HEADER Макет с названием раздела.
SECTION_TITLE_AND_DESCRIPTION Макет с заголовком и подзаголовком с одной стороны и описанием с другой.
ONE_COLUMN_TEXT Макет с одним заголовком и одним телом, расположенным в одной колонке.
MAIN_POINT Макет с основным моментом.
BIG_NUMBER Макет с крупным заголовком.

LayoutPlaceholderIdMapping

Указанное пользователем сопоставление идентификатора заполнителя, который будет создан на слайде из указанного макета.

Представление JSON
{
  "objectId": string,

  // Union field kind can be only one of the following:
  "layoutPlaceholder": {
    object (Placeholder)
  },
  "layoutPlaceholderObjectId": string
  // End of list of possible types for union field kind.
}
Поля
objectId

string

Указанный пользователем идентификатор объекта для указанного выше заполнителя, который будет создан на слайде.

Если вы указываете идентификатор, он должен быть уникальным среди всех страниц и элементов страницы в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [a-zA-Z0-9_] ); остальные символы могут включать их, а также дефис или двоеточие (соответствует регулярному выражению [a-zA-Z0-9_-:] ). Длина идентификатора не должна быть меньше 5 или больше 50.

Если вы не укажете идентификатор, будет создан уникальный идентификатор.

Союз поле kind . Тип для определения заполнителя в макете. kind может быть только одним из следующих:
layoutPlaceholder

object ( Placeholder )

Заполнитель в макете, который будет применен к слайду. Нужны только type и index . Например, предопределенный макет TITLE_AND_BODY обычно может иметь заполнитель TITLE с индексом 0 и заполнитель BODY с индексом 0.

layoutPlaceholderObjectId

string

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

CreateShapeRequest

Создает новую форму.

Представление JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "shapeType": enum (Type)
}
Поля
objectId

string

Предоставляемый пользователем идентификатор объекта.

Если вы указываете идентификатор, он должен быть уникальным среди всех страниц и элементов страницы в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [a-zA-Z0-9_] ); остальные символы могут включать их, а также дефис или двоеточие (соответствует регулярному выражению [a-zA-Z0-9_-:] ). Длина идентификатора не должна быть меньше 5 или больше 50. Если поле пусто, будет сгенерирован уникальный идентификатор.

elementProperties

object ( PageElementProperties )

Свойства элемента для формы.

shapeType

enum ( Type )

Тип формы.

СтраницаЭлементСвойства

Общие свойства элемента страницы.

Примечание. При первоначальном создании PageElement API может изменить значения как size так и transform , но визуальный размер останется неизменным.

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

string

Идентификатор объекта страницы, на которой находится элемент.

size

object ( Size )

Размер элемента.

transform

object ( AffineTransform )

Преобразование элемента.

CreateTableRequest

Создает новую таблицу.

Представление JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "rows": integer,
  "columns": integer
}
Поля
objectId

string

Предоставляемый пользователем идентификатор объекта.

Если вы указываете идентификатор, он должен быть уникальным среди всех страниц и элементов страницы в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [a-zA-Z0-9_] ); остальные символы могут включать их, а также дефис или двоеточие (соответствует регулярному выражению [a-zA-Z0-9_-:] ). Длина идентификатора не должна быть меньше 5 или больше 50.

Если вы не укажете идентификатор, будет создан уникальный идентификатор.

elementProperties

object ( PageElementProperties )

Свойства элемента для таблицы.

Таблица будет создана в указанном размере с учетом минимального размера. Если размер не указан, размер таблицы будет изменен автоматически.

Табличные преобразования должны иметь масштаб 1 и не иметь компонентов сдвига. Если преобразование не предусмотрено, таблица будет центрирована на странице.

rows

integer

Количество строк в таблице.

columns

integer

Количество столбцов в таблице.

Вставитьтекстрекуест

Вставляет текст в фигуру или ячейку таблицы.

Представление JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "text": string,
  "insertionIndex": integer
}
Поля
objectId

string

Идентификатор объекта фигуры или таблицы, куда будет вставлен текст.

cellLocation

object ( TableCellLocation )

Необязательное местоположение ячейки таблицы, если текст должен быть вставлен в ячейку таблицы. Если присутствует, objectId должен ссылаться на таблицу.

text

string

Текст, который нужно вставить.

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

Стили текста для вставленного текста будут определяться автоматически, как правило, с сохранением стиля соседнего текста. В большинстве случаев текст будет добавлен в TextRun , существующий по индексу вставки.

Некоторые управляющие символы (U+0000-U+0008, U+000C-U+001F) и символы из области частного использования Unicode Basic Multilingual Plane (U+E000-U+F8FF) будут удалены из вставленного текста.

insertionIndex

integer

Индекс, в который будет вставлен текст, в единицах кода Unicode на основе индексов TextElement .

Индекс отсчитывается от нуля и вычисляется с начала строки. Индекс может быть скорректирован для предотвращения вставок внутри кластеров графем Unicode. В этих случаях текст будет вставлен сразу после графемного кластера.

Инсертетаблеровсрекуест

Вставляет строки в таблицу.

Представление JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean,
  "number": integer
}
Поля
tableObjectId

string

Таблица, в которую нужно вставить строки.

cellLocation

object ( TableCellLocation )

Местоположение ячейки таблицы ссылок, из которой будут вставлены строки.

Новая строка будет вставлена ​​выше (или ниже) строки, в которой находится эталонная ячейка. Если эталонная ячейка является объединенной ячейкой, новая строка будет вставлена ​​выше (или ниже) объединенной ячейки.

insertBelow

boolean

Следует ли вставлять новые строки ниже местоположения эталонной ячейки.

  • True : вставить под ячейку.
  • False : вставить над ячейкой.
number

integer

Количество вставляемых строк. Максимум 20 на запрос.

Инсертетаблеколумнсрекуест

Вставляет столбцы в таблицу.

Размеры других столбцов в таблице будут изменены, чтобы соответствовать новому столбцу.

Представление JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean,
  "number": integer
}
Поля
tableObjectId

string

Таблица, в которую вставляются столбцы.

cellLocation

object ( TableCellLocation )

Местоположение ячейки таблицы ссылок, из которой будут вставлены столбцы.

Новый столбец будет вставлен слева (или справа) от столбца, в котором находится эталонная ячейка. Если эталонная ячейка является объединенной ячейкой, новый столбец будет вставлен слева (или справа) от объединенной ячейки.

insertRight

boolean

Нужно ли вставлять новые столбцы справа от расположения ячейки ссылки.

  • True : вставить вправо.
  • False : вставить слева.
number

integer

Количество вставляемых столбцов. Максимум 20 на запрос.

УдалитьТаблеРоврекуест

Удаляет строку из таблицы.

Представление JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
Поля
tableObjectId

string

Таблица, из которой удаляются строки.

cellLocation

object ( TableCellLocation )

Местоположение ячейки таблицы ссылок, из которой будет удалена строка.

Строка, которую охватывает эта ячейка, будет удалена. Если это объединенная ячейка, несколько строк будут удалены. Если после этого удаления в таблице не останется ни одной строки, будет удалена вся таблица.

Удалитьтаблеколумнрекуест

Удаляет столбец из таблицы.

Представление JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
Поля
tableObjectId

string

Таблица, из которой удаляются столбцы.

cellLocation

object ( TableCellLocation )

Местоположение ячейки таблицы ссылок, из которой будет удален столбец.

Столбец, который занимает эта ячейка, будет удален. Если это объединенная ячейка, несколько столбцов будут удалены. Если после этого удаления в таблице не останется ни одного столбца, будет удалена вся таблица.

Заменить все текстовые запросы

Заменяет все вхождения текста, соответствующего критерию, на replace text .

Представление JSON
{
  "replaceText": string,
  "pageObjectIds": [
    string
  ],

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
Поля
replaceText

string

Текст, который заменит совпадающий текст.

pageObjectIds[]

string

Если не пусто, ограничивает совпадения элементами страницы только на заданных страницах.

Возвращает ошибку неверного запроса 400, если задан идентификатор объекта страницы notes master или если страница с таким идентификатором объекта не существует в презентации.

criteria поля объединения. Критерии, используемые для сопоставления заменяемого текста. criteria может быть только одним из следующих:
containsText

object ( SubstringMatchCriteria )

Находит текст в форме, соответствующей этой подстроке.

SubstringMatchCriteria

Критерий, соответствующий определенной строке текста в фигуре или таблице.

Представление JSON
{
  "text": string,
  "matchCase": boolean
}
Поля
text

string

Текст для поиска в фигуре или таблице.

matchCase

boolean

Указывает, должен ли поиск учитывать регистр:

  • True : поиск чувствителен к регистру.
  • False : поиск нечувствителен к регистру.

УдалитьОбъектЗапрос

Удаляет объект, pages или page elements , из презентации.

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

string

Идентификатор объекта страницы или элемента страницы для удаления.

Если после операции удаления group содержит только 1 элемент страницы или не содержит ни одного элемента страницы, группа также удаляется.

Если заполнитель удаляется из макета, все пустые наследуемые заполнители также удаляются.

Упдейпажеэлементтрансформрекуест

Обновляет преобразование элемента страницы.

Обновление преобразования группы изменит абсолютное преобразование элементов страницы в этой группе, что может изменить их внешний вид. Дополнительные сведения см. в документации для PageElement.transform .

Представление JSON
{
  "objectId": string,
  "transform": {
    object (AffineTransform)
  },
  "applyMode": enum (ApplyMode)
}
Поля
objectId

string

Идентификатор объекта элемента страницы для обновления.

transform

object ( AffineTransform )

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

applyMode

enum ( ApplyMode )

Режим применения обновления преобразования.

ПрименитьМоде

Применяемые режимы обновления преобразования.

перечисления
APPLY_MODE_UNSPECIFIED Неопределенный режим.
RELATIVE Применяет новую матрицу AffineTransform к существующей и заменяет существующую результирующей конкатенацией.
ABSOLUTE Заменяет существующую матрицу AffineTransform новой.

Упдейтслидеспозитионрекуест

Обновляет положение слайдов в презентации.

Представление JSON
{
  "slideObjectIds": [
    string
  ],
  "insertionIndex": integer
}
Поля
slideObjectIds[]

string

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

insertionIndex

integer

Индекс, в который должны быть вставлены слайды, в зависимости от расположения слайдов перед перемещением. Должно быть от нуля до количества слайдов в презентации включительно.

Удалитьтекстрекуест

Удаляет текст из фигуры или ячейки таблицы.

Представление JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
Поля
objectId

string

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

cellLocation

object ( TableCellLocation )

Необязательное расположение ячейки таблицы, если текст должен быть удален из ячейки таблицы. Если присутствует, objectId должен ссылаться на таблицу.

textRange

object ( Range )

Диапазон удаляемого текста на основе индексов TextElement .

В конце текста фигуры или ячейки таблицы всегда есть неявный символ новой строки, который нельзя удалить. Range.Type.ALL будет использовать правильные границы, но следует соблюдать осторожность при указании явных границ для типов диапазонов FROM_START_INDEX и FIXED_RANGE . Например, если текст «ABC», за которым следует неявный перевод строки, то максимальное значение равно 2 для textRange.start_index и 3 для textRange.end_index .

Удаление текста, пересекающего границу абзаца, может привести к изменению стилей и списков абзацев, поскольку два абзаца объединяются.

Диапазоны, включающие только одну кодовую единицу суррогатной пары, расширяются, чтобы включить обе кодовые единицы.

Диапазон

Задает непрерывный диапазон индексированной коллекции, например символы в тексте.

Представление JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "type": enum (Type)
}
Поля
startIndex

integer

Необязательный отсчитываемый от нуля индекс начала коллекции. Требуется для диапазонов FIXED_RANGE и FROM_START_INDEX .

endIndex

integer

Необязательный отсчитываемый от нуля индекс конца коллекции. Требуется для диапазонов FIXED_RANGE .

type

enum ( Type )

Тип диапазона.

Тип

Типы диапазонов.

перечисления
RANGE_TYPE_UNSPECIFIED Неопределенный тип диапазона. Это значение не должно использоваться.
FIXED_RANGE Фиксированный диапазон. Должны быть указаны как startIndex , так и endIndex .
FROM_START_INDEX Начинает диапазон с startIndex и продолжается до конца коллекции. endIndex не должен быть указан.
ALL Устанавливает диапазон на всю длину коллекции. Нельзя указывать как startIndex , так и endIndex .

CreateImageRequest

Создает образ.

Представление JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },

  // Union field image_source can be only one of the following:
  "url": string
  // End of list of possible types for union field image_source.
}
Поля
objectId

string

Предоставляемый пользователем идентификатор объекта.

Если вы указываете идентификатор, он должен быть уникальным среди всех страниц и элементов страницы в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [a-zA-Z0-9_] ); остальные символы могут включать их, а также дефис или двоеточие (соответствует регулярному выражению [a-zA-Z0-9_-:] ). Длина идентификатора не должна быть меньше 5 или больше 50.

Если вы не укажете идентификатор, будет создан уникальный идентификатор.

elementProperties

object ( PageElementProperties )

Свойства элемента изображения.

Когда соотношение сторон предоставленного размера не соответствует соотношению сторон изображения, изображение масштабируется и центрируется относительно размера, чтобы сохранить соотношение сторон. Предоставленное преобразование применяется после этой операции.

Свойство PageElementProperties.size является необязательным. Если вы не укажете размер, будет использоваться размер изображения по умолчанию.

Свойство PageElementProperties.transform является необязательным. Если вы не укажете преобразование, изображение будет помещено в верхний левый угол страницы.

Поле объединения image_source . Тип источника изображения. image_source может быть только одним из следующих:
url

string

URL-адрес изображения.

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

Предоставленный URL-адрес должен быть общедоступным и иметь длину до 2 КБ. URL-адрес сохраняется вместе с изображением и отображается через поле Image.source_url .

СоздатьВидеоЗапрос

Создает видео.

ПРИМЕЧАНИЕ. Для создания видео с Google Диска необходимо, чтобы у запрашивающего приложения была хотя бы одна из областей OAuth drive, drive.readonly или drive.file.

Представление JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "source": enum (Source),
  "id": string
}
Поля
objectId

string

Предоставляемый пользователем идентификатор объекта.

Если вы указываете идентификатор, он должен быть уникальным среди всех страниц и элементов страницы в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [a-zA-Z0-9_] ); остальные символы могут включать их, а также дефис или двоеточие (соответствует регулярному выражению [a-zA-Z0-9_-:] ). Длина идентификатора не должна быть меньше 5 или больше 50.

Если вы не укажете идентификатор, будет создан уникальный идентификатор.

elementProperties

object ( PageElementProperties )

Свойства элемента для видео.

Свойство PageElementProperties.size является необязательным. Если вы не укажете размер, сервер выберет размер по умолчанию.

Свойство PageElementProperties.transform является необязательным. Преобразование не должно иметь компонентов сдвига. Если вы не укажете преобразование, видео будет помещено в верхний левый угол страницы.

source

enum ( Source )

Источник видео.

id

string

Уникальный идентификатор источника видео для этого видео.

Например, для видео на YouTube https://www.youtube.com/watch?v=7U3axjORYZ0 идентификатор равен 7U3axjORYZ0. Для видео с Google Диска https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q идентификатор равен 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q.

Чтобы получить доступ к видеофайлу Google Диска, вам может потребоваться добавить ключ ресурса в заголовок HTTP для подмножества старых файлов. Дополнительные сведения см. в разделе Доступ к файлам с общим доступом по ссылке с помощью ключей ресурсов .

CreateSheetsChartRequest

Создает встроенную диаграмму Google Sheets.

ПРИМЕЧАНИЕ. Для создания диаграммы требуется по крайней мере одна из областей OAuth: электронные таблицы. только для чтения, электронные таблицы, диск. только для чтения, диск. файл или диск.

Представление JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode)
}
Поля
objectId

string

Предоставляемый пользователем идентификатор объекта.

Если указан, идентификатор должен быть уникальным среди всех страниц и элементов страницы в презентации. Идентификатор должен начинаться с символа слова [a-zA-Z0-9_], за которым следует любое количество следующих символов [a-zA-Z0-9_-:]. Длина идентификатора не должна быть меньше 5 или больше 50. Если поле пусто, будет сгенерирован уникальный идентификатор.

elementProperties

object ( PageElementProperties )

Свойства элемента для диаграммы.

Когда соотношение сторон предоставленного размера не соответствует соотношению сторон диаграммы, диаграмма масштабируется и центрируется относительно размера, чтобы сохранить соотношение сторон. Предоставленное преобразование применяется после этой операции.

spreadsheetId

string

Идентификатор электронной таблицы Google Sheets, содержащей диаграмму.

Возможно, вам потребуется добавить ключ ресурса в заголовок HTTP для подмножества старых файлов. Дополнительные сведения см. в разделе Доступ к файлам с общим доступом по ссылке с помощью ключей ресурсов .

chartId

integer

Идентификатор конкретной диаграммы в электронной таблице Google Sheets.

linkingMode

enum ( LinkingMode )

Режим, в котором диаграмма связана с исходной электронной таблицей. Если не указано, диаграмма будет изображением, которое не связано.

LinkingMode

Режим, в котором диаграмма связана с исходной электронной таблицей.

перечисления
NOT_LINKED_IMAGE Диаграмма не связана с исходной электронной таблицей и не может быть обновлена. Диаграмма, которая не связана, будет вставлена ​​как изображение.
LINKED Связывание диаграммы позволяет обновлять ее, и другие соавторы увидят ссылку на электронную таблицу.

CreateLineRequest

Создает линию.

Представление JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "lineCategory": enum (Category),
  "category": enum (LineCategory)
}
Поля
objectId

string

Предоставляемый пользователем идентификатор объекта.

Если вы указываете идентификатор, он должен быть уникальным среди всех страниц и элементов страницы в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [a-zA-Z0-9_] ); остальные символы могут включать их, а также дефис или двоеточие (соответствует регулярному выражению [a-zA-Z0-9_-:] ). Длина идентификатора не должна быть меньше 5 или больше 50.

Если вы не укажете идентификатор, будет создан уникальный идентификатор.

elementProperties

object ( PageElementProperties )

Свойства элемента для линии.

lineCategory
(deprecated)

enum ( Category )

Категория создаваемой линии.

Устарело : вместо этого используйте category .

Точный line type определяется на основе категории и того, как она маршрутизируется для подключения к другим элементам страницы.

Если вы укажете и category , и lineCategory , category будет иметь приоритет.

category

enum ( LineCategory )

Категория создаваемой линии.

Точный line type определяется на основе категории и того, как она маршрутизируется для подключения к другим элементам страницы.

Если вы укажете и category , и lineCategory , category будет иметь приоритет.

Если вы не укажете значение для category , но зададите значение для lineCategory , то будет использовано указанное значение lineCategory .

Если вы не укажете ни того, ни другого, то будет использоваться STRAIGHT .

Категория

Категории линий.

перечисления
STRAIGHT Прямые соединители, включая прямой соединитель 1. Категория по умолчанию, если она не указана.
BENT Согнутые разъемы, в том числе изогнутые разъемы со 2 по 5.
CURVED Изогнутые соединители, в том числе изогнутые соединители со 2 по 5.

RefreshSheetsChartRequest

Обновляет встроенную диаграмму Google Sheets, заменяя ее последней версией диаграммы из Google Sheets.

ПРИМЕЧАНИЕ. Для обновления диаграмм требуется как минимум одна из областей Spreadsheets.readonly, Spreadsheets, Drive.Readonly или Drive OAuth.

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

string

Идентификатор объекта диаграммы для обновления.

Обновитьшейпепропертиесрекуест

Обновите свойства Shape .

Представление JSON
{
  "objectId": string,
  "shapeProperties": {
    object (ShapeProperties)
  },
  "fields": string
}
Поля
objectId

string

Идентификатор объекта формы, к которой применяются обновления.

shapeProperties

object ( ShapeProperties )

Свойства формы для обновления.

fields

string ( FieldMask format)

Поля, которые необходимо обновить.

Должно быть указано хотя бы одно поле. Корень shapeProperties подразумевается и не должен указываться. Одиночная "*" может использоваться как сокращение для перечисления каждого поля.

Например, чтобы обновить сплошной цвет фона фигуры, задайте для fields значение "shapeBackgroundFill.solidFill.color" .

Чтобы восстановить значение свойства по умолчанию, включите имя его поля в маску поля, но оставьте само поле неустановленным.

Упдеймажепропертиесрекуест

Обновите свойства Image .

Представление JSON
{
  "objectId": string,
  "imageProperties": {
    object (ImageProperties)
  },
  "fields": string
}
Поля
objectId

string

Идентификатор объекта изображения, к которому применяются обновления.

imageProperties

object ( ImageProperties )

Свойства изображения для обновления.

fields

string ( FieldMask format)

Поля, которые необходимо обновить.

Должно быть указано хотя бы одно поле. Корневые imageProperties подразумеваются и не должны указываться. Одиночная "*" может использоваться как сокращение для перечисления каждого поля.

Например, чтобы обновить цвет контура изображения, задайте для fields значение "outline.outlineFill.solidFill.color" .

Чтобы восстановить значение свойства по умолчанию, включите имя его поля в маску поля, но оставьте само поле неустановленным.

Обновитьвидеопропертиесрекуест

Обновите свойства Video .

Представление JSON
{
  "objectId": string,
  "videoProperties": {
    object (VideoProperties)
  },
  "fields": string
}
Поля
objectId

string

Идентификатор объекта видео, к которому применяются обновления.

videoProperties

object ( VideoProperties )

Свойства видео для обновления.

fields

string ( FieldMask format)

Поля, которые необходимо обновить.

Должно быть указано хотя бы одно поле. Корневые videoProperties подразумеваются и не должны указываться. Одиночная "*" может использоваться как сокращение для перечисления каждого поля.

Например, чтобы обновить цвет контура видео, задайте для fields значение "outline.outlineFill.solidFill.color" .

Чтобы восстановить значение свойства по умолчанию, включите имя его поля в маску поля, но оставьте само поле неустановленным.

Упдейпажепропертиесрекуест

Обновляет свойства Page .

Представление JSON
{
  "objectId": string,
  "pageProperties": {
    object (PageProperties)
  },
  "fields": string
}
Поля
objectId

string

Идентификатор объекта страницы, к которой применяется обновление.

pageProperties

object ( PageProperties )

Свойства страницы для обновления.

fields

string ( FieldMask format)

Поля, которые необходимо обновить.

Должно быть указано хотя бы одно поле. Корневые pageProperties подразумеваются и не должны указываться. Одиночная "*" может использоваться как сокращение для перечисления каждого поля.

Например, чтобы обновить сплошной цвет фона страницы, задайте для fields значение "pageBackgroundFill.solidFill.color" .

Чтобы восстановить значение свойства по умолчанию, включите имя его поля в маску поля, но оставьте само поле неустановленным.

Упдаттаблеллеллпропертиесрекуест

Обновите свойства TableCell .

Представление JSON
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "tableCellProperties": {
    object (TableCellProperties)
  },
  "fields": string
}
Поля
objectId

string

Идентификатор объекта таблицы.

tableRange

object ( TableRange )

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

tableCellProperties

object ( TableCellProperties )

Свойства ячейки таблицы для обновления.

fields

string ( FieldMask format)

Поля, которые необходимо обновить.

Должно быть указано хотя бы одно поле. Корневой tableCellProperties подразумевается и не должен быть указан. Одиночная "*" может использоваться как сокращение для перечисления каждого поля.

Например, чтобы обновить сплошной цвет фона ячейки таблицы, установите для fields значение "tableCellBackgroundFill.solidFill.color" .

Чтобы восстановить значение свойства по умолчанию, включите имя его поля в маску поля, но оставьте само поле неустановленным.

Таблица Диапазон

Диапазон таблиц представляет собой ссылку на подмножество таблицы.

Важно отметить, что ячейки, заданные диапазоном таблицы, не обязательно образуют прямоугольник. Например, предположим, что у нас есть таблица 3 x 3, в которой все ячейки последней строки объединены. Таблица выглядит так:

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

Диапазон таблицы с расположением = (0, 0), диапазоном строк = 3 и диапазоном столбцов = 2 определяет следующие ячейки:

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
Представление JSON
{
  "location": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Поля
location

object ( TableCellLocation )

Начальное местоположение диапазона таблицы.

rowSpan

integer

Диапазон строк диапазона таблицы.

columnSpan

integer

Диапазон столбцов диапазона таблицы.

Упдейлайнепропертиесрекуест

Обновляет свойства Line .

Представление JSON
{
  "objectId": string,
  "lineProperties": {
    object (LineProperties)
  },
  "fields": string
}
Поля
objectId

string

Идентификатор объекта строки, к которой применяется обновление.

lineProperties

object ( LineProperties )

Свойства линии для обновления.

fields

string ( FieldMask format)

Поля, которые необходимо обновить.

Должно быть указано хотя бы одно поле. Корневая lineProperties подразумевается и не должна указываться. Одиночная "*" может использоваться как сокращение для перечисления каждого поля.

Например, чтобы обновить сплошной цвет линии, задайте для fields значение "lineFill.solidFill.color" .

Чтобы восстановить значение свойства по умолчанию, включите имя его поля в маску поля, но оставьте само поле неустановленным.

CreateParagraphBulletsRequest

Создает маркеры для всех абзацев, которые перекрываются с заданным диапазоном индекса текста.

Уровень вложенности каждого абзаца будет определяться путем подсчета ведущих вкладок перед каждым абзацем. Чтобы избежать лишнего пространства между маркером и соответствующим абзацем, эти ведущие вкладки удаляются по этому запросу. Это может изменить индексы частей текста.

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

Представление JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Поля
objectId

string

Идентификатор объекта фигуры или таблицы, содержащей текст, к которому нужно добавить маркеры.

cellLocation

object ( TableCellLocation )

Необязательное расположение ячейки таблицы, если изменяемый текст находится в ячейке таблицы. Если присутствует, objectId должен ссылаться на таблицу.

textRange

object ( Range )

Диапазон текста, к которому применяются наборы параметров маркера, на основе индексов TextElement .

bulletPreset

enum ( BulletGlyphPreset )

Типы глифов маркеров, которые будут использоваться. По умолчанию используется предустановка BULLET_DISC_CIRCLE_SQUARE .

BulletGlyphPreset

Предустановленные шаблоны глифов маркеров для списков в тексте.

В этих шаблонах используются следующие виды маркеров:

  • ARROW : стрелка, соответствующая кодовой точке Unicode U+2794.
  • ARROW3D : стрелка с трехмерным затенением, соответствующая кодовой точке Unicode U+27a2.
  • CHECKBOX : пустой квадрат, соответствующий кодовой точке Unicode U+274f.
  • CIRCLE : пустой кружок, соответствующий кодовой точке Unicode U+25cb.
  • DIAMOND : сплошной ромб, соответствующий кодовой точке Unicode U+25c6.
  • DIAMONDX : ромб со знаком «x», соответствующий кодовой точке Unicode U+2756.
  • HOLLOWDIAMOND : полый ромб, соответствующий кодовой точке Unicode U+25c7.
  • DISC : сплошной кружок, соответствующий кодовой точке Unicode U+25cf.
  • SQUARE : сплошной квадрат, соответствующий кодовой точке Unicode U+25a0.
  • STAR : звезда, соответствующая кодовой точке Unicode U+2605.
  • ALPHA : строчная буква, например «а», «б» или «с».
  • UPPERALPHA : заглавная буква, например «A», «B» или «C».
  • DIGIT : Число, например «1», «2» или «3».
  • ZERODIGIT : число, в котором однозначные числа начинаются с нуля, например «01», «02» или «03». Перед числами, состоящими из более чем одной цифры, не ставится ноль.
  • ROMAN : римская цифра в нижнем регистре, например «i», «ii» или «iii».
  • UPPERROMAN : римская цифра в верхнем регистре, например «I», «II» или «III».
  • LEFTTRIANGLE : треугольник, указывающий влево, соответствующий кодовой точке Unicode U+25c4.
перечисления
BULLET_DISC_CIRCLE_SQUARE Маркированный список с маркерами DISC , CIRCLE и SQUARE для первых 3 уровней вложенности списка.
BULLET_DIAMONDX_ARROW3D_SQUARE Маркированный список с маркерами DIAMONDX , ARROW3D и SQUARE для первых 3 уровней вложенности списка.
BULLET_CHECKBOX Маркированный список с глифами маркеров CHECKBOX для всех уровней вложенности списков.
BULLET_ARROW_DIAMOND_DISC Маркированный список со ARROW , DIAMOND и DISC для первых 3 уровней вложенности списка.
BULLET_STAR_CIRCLE_SQUARE Маркированный список со STAR , CIRCLE и SQUARE для первых 3 уровней вложенности списка.
BULLET_ARROW3D_CIRCLE_SQUARE Маркированный список с маркерами ARROW3D , CIRCLE и SQUARE для первых 3 уровней вложенности списка.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Маркированный список с маркерами LEFTTRIANGLE , DIAMOND и DISC для первых 3 уровней вложенности списка.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Маркированный список с маркерами DIAMONDX , HOLLOWDIAMOND и SQUARE для первых 3 уровней вложенности списка.
BULLET_DIAMOND_CIRCLE_SQUARE Маркированный список с маркированными символами DIAMOND , CIRCLE и SQUARE для первых 3 уровней вложенности списка.
NUMBERED_DIGIT_ALPHA_ROMAN Нумерованный список с числовыми символами DIGIT , ALPHA и ROMAN для первых 3 уровней вложенности списка, за которыми следуют точки.
NUMBERED_DIGIT_ALPHA_ROMAN_PARENS Нумерованный список с числовыми символами DIGIT , ALPHA и ROMAN для первых 3 уровней вложенности списка, за которыми следуют круглые скобки.
NUMBERED_DIGIT_NESTED Нумерованный список с числовыми глифами DIGIT разделенными точками, где каждый уровень вложенности использует глиф предыдущего уровня в качестве префикса. Например: «1.», «1.1.», «2.», «2.2.».
NUMBERED_UPPERALPHA_ALPHA_ROMAN Нумерованный список с числовыми символами UPPERALPHA , ALPHA и ROMAN для первых 3 уровней вложенности списка, за которыми следуют точки.
NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT Нумерованный список с числовыми символами UPPERROMAN , UPPERALPHA и DIGIT для первых 3 уровней вложенности списка, за которыми следуют точки.
NUMBERED_ZERODIGIT_ALPHA_ROMAN Нумерованный список с числовыми символами ZERODIGIT , ALPHA и ROMAN для первых 3 уровней вложенности списка, за которыми следуют точки.

Заменить все фигуры с имажерекуест

Заменяет все фигуры, соответствующие заданным критериям, предоставленным изображением.

Изображения, заменяющие фигуры, после вставки в презентацию имеют прямоугольную форму и не принимают форму фигур.

Представление JSON
{
  "replaceMethod": enum (ReplaceMethod),
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "pageObjectIds": [
    string
  ],

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.

  // Union field image_source can be only one of the following:
  "imageUrl": string
  // End of list of possible types for union field image_source.
}
Поля
replaceMethod
(deprecated)

enum ( ReplaceMethod )

Метод замены.

Устарело : вместо этого используйте imageReplaceMethod .

Если вы укажете и replaceMethod , и imageReplaceMethod , imageReplaceMethod имеет приоритет.

imageReplaceMethod

enum ( ImageReplaceMethod )

Метод замены изображения.

Если вы укажете и replaceMethod , и imageReplaceMethod , imageReplaceMethod имеет приоритет.

Если вы не указываете значение для imageReplaceMethod , но указываете значение для replaceMethod , используется указанное значение replaceMethod .

Если вы не укажете ни то, ни другое, то используется CENTER_INSIDE.

pageObjectIds[]

string

Если не пусто, ограничивает совпадения элементами страницы только на заданных страницах.

Возвращает ошибку неверного запроса 400, если задан идентификатор объекта страницы notes page или notes master , или если страница с таким идентификатором объекта не существует в презентации.

criteria поля объединения. Критерии, которым должны соответствовать фигуры, чтобы их можно было заменить. criteria может быть только одним из следующих:
containsText

object ( SubstringMatchCriteria )

Если установлено, этот запрос заменит все фигуры, содержащие данный текст.

Поле объединения image_source . Тип источника изображения. image_source может быть только одним из следующих:
imageUrl

string

URL-адрес изображения.

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

Предоставленный URL-адрес может иметь длину не более 2 КБ. Сам URL-адрес сохраняется вместе с изображением и отображается через поле Image.source_url .

Заменить метод

Метод замены.

перечисления
CENTER_INSIDE Scales and centers the image to fit within the bounds of the original shape and maintains the image's aspect ratio. The rendered size of the image may be smaller than the size of the shape. This is the default method when one is not specified.
CENTER_CROP Scales and centers the image to fill the bounds of the original shape. The image may be cropped in order to fill the shape. The rendered size of the image will be the same as that of the original shape.

ImageReplaceMethod

The image replace method.

Enums
IMAGE_REPLACE_METHOD_UNSPECIFIED Unspecified image replace method. This value must not be used.
CENTER_INSIDE Scales and centers the image to fit within the bounds of the original shape and maintains the image's aspect ratio. The rendered size of the image may be smaller than the size of the shape. This is the default method when one is not specified.
CENTER_CROP Scales and centers the image to fill the bounds of the original shape. The image may be cropped in order to fill the shape. The rendered size of the image will be the same as the original shape.

DuplicateObjectRequest

Duplicates a slide or page element.

When duplicating a slide, the duplicate slide will be created immediately following the specified slide. When duplicating a page element, the duplicate will be placed on the same page at the same position as the original.

JSON representation
{
  "objectId": string,
  "objectIds": {
    string: string,
    ...
  }
}
Fields
objectId

string

The ID of the object to duplicate.

objectIds

map (key: string, value: string)

The object being duplicated may contain other objects, for example when duplicating a slide or a group page element. This map defines how the IDs of duplicated objects are generated: the keys are the IDs of the original objects and its values are the IDs that will be assigned to the corresponding duplicate object. The ID of the source object's duplicate may be specified in this map as well, using the same value of the objectId field as a key and the newly desired ID as the value.

All keys must correspond to existing IDs in the presentation. All values must be unique in the presentation and must start with an alphanumeric character or an underscore (matches regex [a-zA-Z0-9_] ); remaining characters may include those as well as a hyphen or colon (matches regex [a-zA-Z0-9_-:] ). The length of the new ID must not be less than 5 or greater than 50.

If any IDs of source objects are omitted from the map, a new random ID will be assigned. If the map is empty or unset, all duplicate objects will receive a new random ID.

UpdateTextStyleRequest

Update the styling of text in a Shape or Table .

JSON representation
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (TextStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
Fields
objectId

string

The object ID of the shape or table with the text to be styled.

cellLocation

object ( TableCellLocation )

The location of the cell in the table containing the text to style. If objectId refers to a table, cellLocation must have a value. Otherwise, it must not.

style

object ( TextStyle )

The style(s) to set on the text.

If the value for a particular style matches that of the parent, that style will be set to inherit.

Certain text style changes may cause other changes meant to mirror the behavior of the Slides editor. See the documentation of TextStyle for more information.

textRange

object ( Range )

The range of text to style.

The range may be extended to include adjacent newlines.

If the range fully contains a paragraph belonging to a list, the paragraph's bullet is also updated with the matching text style.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root style is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example, to update the text style to bold, set fields to "bold" .

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

ReplaceAllShapesWithSheetsChartRequest

Replaces all shapes that match the given criteria with the provided Google Sheets chart. The chart will be scaled and centered to fit within the bounds of the original shape.

NOTE: Replacing shapes with a chart requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.

JSON representation
{
  "containsText": {
    object (SubstringMatchCriteria)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode),
  "pageObjectIds": [
    string
  ]
}
Fields
containsText

object ( SubstringMatchCriteria )

The criteria that the shapes must match in order to be replaced. The request will replace all of the shapes that contain the given text.

spreadsheetId

string

The ID of the Google Sheets spreadsheet that contains the chart.

chartId

integer

The ID of the specific chart in the Google Sheets spreadsheet.

linkingMode

enum ( LinkingMode )

The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked.

pageObjectIds[]

string

If non-empty, limits the matches to page elements only on the given pages.

Returns a 400 bad request error if given the page object ID of a notes page or a notes master , or if a page with that object ID doesn't exist in the presentation.

LinkingMode

The mode with which the chart is linked to the source spreadsheet.

Enums
NOT_LINKED_IMAGE The chart is not associated with the source spreadsheet and cannot be updated. A chart that is not linked will be inserted as an image.
LINKED Linking the chart allows it to be updated, and other collaborators will see a link to the spreadsheet.

DeleteParagraphBulletsRequest

Deletes bullets from all of the paragraphs that overlap with the given text index range .

The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph.

JSON representation
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
Fields
objectId

string

The object ID of the shape or table containing the text to delete bullets from.

cellLocation

object ( TableCellLocation )

The optional table cell location if the text to be modified is in a table cell. If present, the objectId must refer to a table.

textRange

object ( Range )

The range of text to delete bullets from, based on TextElement indexes.

UpdateParagraphStyleRequest

Updates the styling for all of the paragraphs within a Shape or Table that overlap with the given text index range.

JSON representation
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (ParagraphStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
Fields
objectId

string

The object ID of the shape or table with the text to be styled.

cellLocation

object ( TableCellLocation )

The location of the cell in the table containing the paragraph(s) to style. If objectId refers to a table, cellLocation must have a value. Otherwise, it must not.

style

object ( ParagraphStyle )

The paragraph's style.

textRange

object ( Range )

The range of text containing the paragraph(s) to style.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root style is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example, to update the paragraph alignment, set fields to "alignment" .

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

UpdateTableBorderPropertiesRequest

Updates the properties of the table borders in a Table .

JSON representation
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "borderPosition": enum (BorderPosition),
  "tableBorderProperties": {
    object (TableBorderProperties)
  },
  "fields": string
}
Fields
objectId

string

The object ID of the table.

tableRange

object ( TableRange )

The table range representing the subset of the table to which the updates are applied. If a table range is not specified, the updates will apply to the entire table.

borderPosition

enum ( BorderPosition )

The border position in the table range the updates should apply to. If a border position is not specified, the updates will apply to all borders in the table range.

tableBorderProperties

object ( TableBorderProperties )

The table border properties to update.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tableBorderProperties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the table border solid fill color, set fields to "tableBorderFill.solidFill.color" .

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

BorderPosition

The table border position.

Enums
ALL All borders in the range.
BOTTOM Borders at the bottom of the range.
INNER Borders on the inside of the range.
INNER_HORIZONTAL Horizontal borders on the inside of the range.
INNER_VERTICAL Vertical borders on the inside of the range.
LEFT Borders at the left of the range.
OUTER Borders along the outside of the range.
RIGHT Borders at the right of the range.
TOP Borders at the top of the range.

UpdateTableColumnPropertiesRequest

Updates the properties of a Table column.

JSON representation
{
  "objectId": string,
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Fields
objectId

string

The object ID of the table.

columnIndices[]

integer

The list of zero-based indices specifying which columns to update. If no indices are provided, all columns in the table will be updated.

tableColumnProperties

object ( TableColumnProperties )

The table column properties to update.

If the value of tableColumnProperties#columnWidth in the request is less than 406,400 EMU (32 points), a 400 bad request error is returned.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tableColumnProperties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the column width, set fields to "columnWidth" .

If '"columnWidth"' is included in the field mask but the property is left unset, the column width will default to 406,400 EMU (32 points).

UpdateTableRowPropertiesRequest

Updates the properties of a Table row.

JSON representation
{
  "objectId": string,
  "rowIndices": [
    integer
  ],
  "tableRowProperties": {
    object (TableRowProperties)
  },
  "fields": string
}
Fields
objectId

string

The object ID of the table.

rowIndices[]

integer

The list of zero-based indices specifying which rows to update. If no indices are provided, all rows in the table will be updated.

tableRowProperties

object ( TableRowProperties )

The table row properties to update.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tableRowProperties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the minimum row height, set fields to "minRowHeight" .

If '"minRowHeight"' is included in the field mask but the property is left unset, the minimum row height will default to 0.

MergeTableCellsRequest

Merges cells in a Table .

JSON representation
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
Fields
objectId

string

The object ID of the table.

tableRange

object ( TableRange )

The table range specifying which cells of the table to merge.

Any text in the cells being merged will be concatenated and stored in the upper-left ("head") cell of the range. If the range is non-rectangular (which can occur in some cases where the range covers cells that are already merged), a 400 bad request error is returned.

UnmergeTableCellsRequest

Unmerges cells in a Table .

JSON representation
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
Fields
objectId

string

The object ID of the table.

tableRange

object ( TableRange )

The table range specifying which cells of the table to unmerge.

All merged cells in this range will be unmerged, and cells that are already unmerged will not be affected. If the range has no merged cells, the request will do nothing. If there is text in any of the merged cells, the text will remain in the upper-left ("head") cell of the resulting block of unmerged cells.

GroupObjectsRequest

Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.

JSON representation
{
  "groupObjectId": string,
  "childrenObjectIds": [
    string
  ]
}
Fields
groupObjectId

string

A user-supplied object ID for the group to be created.

If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex [a-zA-Z0-9_] ); remaining characters may include those as well as a hyphen or colon (matches regex [a-zA-Z0-9_-:] ). The length of the ID must not be less than 5 or greater than 50.

If you don't specify an ID, a unique one is generated.

childrenObjectIds[]

string

The object IDs of the objects to group.

Only page elements can be grouped. There should be at least two page elements on the same page that are not already in another group. Some page elements, such as videos , tables and placeholders cannot be grouped.

UngroupObjectsRequest

Ungroups objects, such as groups .

JSON representation
{
  "objectIds": [
    string
  ]
}
Fields
objectIds[]

string

The object IDs of the objects to ungroup.

Only groups that are not inside other groups can be ungrouped. All the groups should be on the same page. The group itself is deleted. The visual sizes and positions of all the children are preserved.

UpdatePageElementAltTextRequest

Updates the alt text title and/or description of a page element .

JSON representation
{
  "objectId": string,
  "title": string,
  "description": string
}
Fields
objectId

string

The object ID of the page element the updates are applied to.

title

string

The updated alt text title of the page element. If unset the existing value will be maintained. The title is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element.

description

string

The updated alt text description of the page element. If unset the existing value will be maintained. The description is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element.

ReplaceImageRequest

Replaces an existing image with a new image.

Replacing an image removes some image effects from the existing image.

JSON representation
{
  "imageObjectId": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),

  // Union field image_source can be only one of the following:
  "url": string
  // End of list of possible types for union field image_source.
}
Fields
imageObjectId

string

The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.

imageReplaceMethod

enum ( ImageReplaceMethod )

The replacement method.

Union field image_source . The kind of image source. image_source can be only one of the following:
url

string

The image URL.

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

The provided URL can't surpass 2 KB in length. The URL is saved with the image, and exposed through the Image.source_url field.

UpdateSlidePropertiesRequest

Updates the properties of a Slide.

JSON representation
{
  "objectId": string,
  "slideProperties": {
    object (SlideProperties)
  },
  "fields": string
}
Fields
objectId

string

The object ID of the slide the update is applied to.

slideProperties

object ( SlideProperties )

The slide properties to update.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root 'slideProperties' is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update whether a slide is skipped, set fields to "isSkipped" .

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

UpdatePageElementsZOrderRequest

Updates the Z-order of page elements. Z-order is an ordering of the elements on the page from back to front. The page element in the front may cover the elements that are behind it.

JSON representation
{
  "pageElementObjectIds": [
    string
  ],
  "operation": enum (ZOrderOperation)
}
Fields
pageElementObjectIds[]

string

The object IDs of the page elements to update.

All the page elements must be on the same page and must not be grouped.

operation

enum ( ZOrderOperation )

The Z-order operation to apply on the page elements.

When applying the operation on multiple page elements, the relative Z-orders within these page elements before the operation is maintained.

ZOrderOperation

The operation to update a page element's Z-order.

Enums
Z_ORDER_OPERATION_UNSPECIFIED Unspecified operation.
BRING_TO_FRONT Brings the page elements to the front of the page.
BRING_FORWARD Brings the page elements forward on the page by one element relative to the forwardmost one in the specified page elements.
SEND_BACKWARD Sends the page elements backward on the page by one element relative to the furthest behind one in the specified page elements.
SEND_TO_BACK Sends the page elements to the back of the page.

UpdateLineCategoryRequest

Updates the category of a line .

JSON representation
{
  "objectId": string,
  "lineCategory": enum (LineCategory)
}
Fields
objectId

string

The object ID of the line the update is applied to.

Only a line with a category indicating it is a "connector" can be updated.

The line may be rerouted after updating its category.

lineCategory

enum ( LineCategory )

The line category to update to.

The exact line type is determined based on the category to update to and how it's routed to connect to other page elements.

RerouteLineRequest

Reroutes a line such that it's connected at the two closest connection sites on the connected page elements.

JSON representation
{
  "objectId": string
}
Fields
objectId

string

The object ID of the line to reroute.

Only a line with a category indicating it is a "connector" can be rerouted. The start and end connections of the line must be on different page elements.