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 Таблицах.

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 Таблиц.

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

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

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

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

insertionIndex

integer

Дополнительный индекс с нулевой отметкой, указывающий место вставки слайдов.

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

slideLayoutReference

object ( LayoutReference )

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

  • Указатель предыдущих слайдов.
  • Если insertionIndex равен нулю, то это будет основной слайд первого изображения.
  • Первый слайд в презентации, если слайдов нет.

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

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

placeholderIdMappings[]

object ( LayoutPlaceholderIdMapping )

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

LayoutReference

Справочный материал по макету слайда. Он может содержать ссылку на один из следующих пунктов:

  • Предварительно заданная структура
  • Один из вариантов оформления презентации.
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 поля объединения. Тип 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

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

Если вы указываете идентификатор (ID), он должен быть уникальным среди всех страниц и элементов страниц в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [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

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

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

elementProperties

object ( PageElementProperties )

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

shapeType

enum ( Type )

Тип формы.

PageElementProperties

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

Примечание: При первоначальном создании 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

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

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

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

elementProperties

object ( PageElementProperties )

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

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

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

rows

integer

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

columns

integer

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

InsertTextRequest

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

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 (U+E000-U+F8FF) будут удалены из вставленного текста.

insertionIndex

integer

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

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

InsertTableRowsRequest

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

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

string

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

cellLocation

object ( TableCellLocation )

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

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

insertBelow

boolean

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

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

integer

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

InsertTableColumnsRequest

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

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

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

string

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

cellLocation

object ( TableCellLocation )

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

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

insertRight

boolean

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

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

integer

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

DeleteTableRowRequest

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

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

string

Таблица, из которой нужно удалить строки.

cellLocation

object ( TableCellLocation )

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

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

DeleteTableColumnRequest

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

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

string

Таблица, из которой нужно удалить столбцы.

cellLocation

object ( TableCellLocation )

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

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

ReplaceAllTextRequest

Заменяет все вхождения текста, соответствующего заданным критериям, на 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 Bad Request, если указан идентификатор объекта страницы из notes master или если страница с таким идентификатором объекта отсутствует в презентации.

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

object ( SubstringMatchCriteria )

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

SubstringMatchCriteria

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

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

string

Текст, который нужно найти в фигуре или таблице.

matchCase

boolean

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

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

boolean

Необязательный параметр. Значение true указывает, следует ли рассматривать найденное значение как регулярное выражение. Все обратные косые черты в шаблоне должны быть экранированы.

  • True : поисковый текст обрабатывается как регулярное выражение.
  • False : поисковый текст рассматривается как подстрока для сопоставления.

DeleteObjectRequest

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

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

string

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

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

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

UpdatePageElementTransformRequest

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

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

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

string

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

transform

object ( AffineTransform )

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

applyMode

enum ( ApplyMode )

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

ApplyMode

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

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

UpdateSlidesPositionRequest

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

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

string

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

insertionIndex

integer

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

DeleteTextRequest

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

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", за которым следует неявный символ новой строки, то максимальное значение для textRange.start_index равно 2, а для textRange.end_index — 3.

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

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

Диапазон

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

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

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

Если вы указываете идентификатор (ID), он должен быть уникальным среди всех страниц и элементов страниц в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [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 .

CreateVideoRequest

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

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

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

string

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

Если вы указываете идентификатор (ID), он должен быть уникальным среди всех страниц и элементов страниц в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [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 Drive https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q идентификатор — 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q.

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

CreateSheetsChartRequest

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

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

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

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

Если вы указываете идентификатор (ID), он должен быть уникальным среди всех страниц и элементов страниц в презентации. Идентификатор должен начинаться с буквенно-цифрового символа или символа подчеркивания (соответствует регулярному выражению [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.

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

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

string

Идентификатор объекта диаграммы, которую необходимо обновить.

UpdateShapePropertiesRequest

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

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

string

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

shapeProperties

object ( ShapeProperties )

Свойства формы, которые необходимо обновить.

fields

string ( FieldMask format)

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

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

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

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

UpdateImagePropertiesRequest

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

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

string

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

imageProperties

object ( ImageProperties )

Свойства изображения, которые необходимо обновить.

fields

string ( FieldMask format)

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

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

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

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

UpdateVideoPropertiesRequest

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

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

string

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

videoProperties

object ( VideoProperties )

Свойства видео, которые необходимо обновить.

fields

string ( FieldMask format)

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

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

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

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

UpdatePagePropertiesRequest

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

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

string

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

pageProperties

object ( PageProperties )

Свойства страницы, которые необходимо обновить.

fields

string ( FieldMask format)

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

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

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

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

UpdateTableCellPropertiesRequest

Обновите свойства ячейки 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х3, где все ячейки последней строки объединены. Таблица будет выглядеть так:

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

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

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

object ( TableCellLocation )

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

rowSpan

integer

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

columnSpan

integer

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

UpdateLinePropertiesRequest

Обновляет свойства 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 : Заглавная буква, например, «А», «В» или «С».
  • 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 для первых трех уровней вложенности списка.
BULLET_DIAMONDX_ARROW3D_SQUARE Маркированный список с использованием символов DIAMONDX , ARROW3D и SQUARE для первых трех уровней вложенности списка.
BULLET_CHECKBOX Маркированный список с флажками CHECKBOX для всех уровней вложенности списка.
BULLET_ARROW_DIAMOND_DISC Маркированный список с символами ARROW , DIAMOND и DISC для первых 3 уровней вложенности списка.
BULLET_STAR_CIRCLE_SQUARE Маркированный список с символами STAR , CIRCLE и SQUARE » для первых трех уровней вложенности списка.
BULLET_ARROW3D_CIRCLE_SQUARE Маркированный список с символами ARROW3D , CIRCLE и SQUARE для первых трех уровней вложенности списка.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Маркированный список с символами LEFTTRIANGLE , DIAMOND и DISC для первых трех уровней вложенности списка.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Маркированный список с символами DIAMONDX , HOLLOWDIAMOND и SQUARE для первых 3 уровней вложенности списка.
BULLET_DIAMOND_CIRCLE_SQUARE Маркированный список с DIAMOND , CIRCLE и SQUARE для первых трех уровней вложенности списка.
NUMBERED_DIGIT_ALPHA_ROMAN Пронумерованный список с DIGIT , ALPHA и ROMAN цифрами для первых трех уровней вложенности списка, за которыми следуют точки.
NUMBERED_DIGIT_ALPHA_ROMAN_PARENS Пронумерованный список с DIGIT , ALPHA и ROMAN цифрами для первых трех уровней вложенности списка, за которыми следуют скобки.
NUMBERED_DIGIT_NESTED Пронумерованный список, содержащий цифровые символы, разделенные DIGIT , где каждый уровень вложенности использует символ предыдущего уровня в качестве префикса. Например: '1.', '1.1.', '2.', '2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Пронумерованный список с использованием UPPERALPHA , ALPHA и ROMAN цифр для первых трех уровней вложенности списка, за которыми следуют точки.
NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT Пронумерованный список с цифрами UPPERROMAN , UPPERALPHA и DIGIT для первых 3 уровней вложенности списка, за которыми следуют точки.
NUMBERED_ZERODIGIT_ALPHA_ROMAN Пронумерованный список с цифрами ZERODIGIT , ALPHA и ROMAN для первых 3 уровней вложенности списка, за которыми следуют точки.

ReplaceAllShapesWithImageRequest

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

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

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 Bad Request, если указан идентификатор объекта 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 .

ReplaceMethod

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

Перечисления
CENTER_INSIDE Масштабирует и центрирует изображение таким образом, чтобы оно соответствовало границам исходной фигуры, сохраняя при этом пропорции изображения. Размер отображаемого изображения может быть меньше размера фигуры. Это метод по умолчанию, если он не указан.
CENTER_CROP Масштабирует и центрирует изображение, чтобы оно заполнило границы исходной фигуры. Изображение может быть обрезано, чтобы заполнить фигуру. Размер отображаемого изображения будет таким же, как и у исходной фигуры.

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

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

Перечисления
IMAGE_REPLACE_METHOD_UNSPECIFIED Метод замены изображения не указан. Это значение использовать нельзя.
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-представление
{
  "objectId": string,
  "objectIds": {
    string: string,
    ...
  }
}
Поля
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-представление
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (TextStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
Поля
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-представление
{
  "containsText": {
    object (SubstringMatchCriteria)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode),
  "pageObjectIds": [
    string
  ]
}
Поля
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.

Перечисления
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-представление
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
Поля
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-представление
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (ParagraphStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
Поля
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-представление
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "borderPosition": enum (BorderPosition),
  "tableBorderProperties": {
    object (TableBorderProperties)
  },
  "fields": string
}
Поля
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.

Перечисления
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-представление
{
  "objectId": string,
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Поля
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-представление
{
  "objectId": string,
  "rowIndices": [
    integer
  ],
  "tableRowProperties": {
    object (TableRowProperties)
  },
  "fields": string
}
Поля
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-представление
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
Поля
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-представление
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
Поля
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-представление
{
  "groupObjectId": string,
  "childrenObjectIds": [
    string
  ]
}
Поля
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-представление
{
  "objectIds": [
    string
  ]
}
Поля
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-представление
{
  "objectId": string,
  "title": string,
  "description": string
}
Поля
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-представление
{
  "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.
}
Поля
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-представление
{
  "objectId": string,
  "slideProperties": {
    object (SlideProperties)
  },
  "fields": string
}
Поля
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-представление
{
  "pageElementObjectIds": [
    string
  ],
  "operation": enum (ZOrderOperation)
}
Поля
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.

Перечисления
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-представление
{
  "objectId": string,
  "lineCategory": enum (LineCategory)
}
Поля
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-представление
{
  "objectId": string
}
Поля
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.