Request
A single kind of update to apply to a presentation.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
kind . The kind of update. Exactly one field is required.
kind
can be only one of the following:
|
|
createSlide
|
Creates a new slide. |
createShape
|
Creates a new shape. |
createTable
|
Creates a new table. |
insertText
|
Inserts text into a shape or table cell. |
insertTableRows
|
Inserts rows into a table. |
insertTableColumns
|
Inserts columns into a table. |
deleteTableRow
|
Deletes a row from a table. |
deleteTableColumn
|
Deletes a column from a table. |
replaceAllText
|
Replaces all instances of specified text. |
deleteObject
|
Deletes a page or page element from the presentation. |
updatePageElementTransform
|
Updates the transform of a page element. |
updateSlidesPosition
|
Updates the position of a set of slides in the presentation. |
deleteText
|
Deletes text from a shape or a table cell. |
createImage
|
Creates an image. |
createVideo
|
Creates a video. |
createSheetsChart
|
Creates an embedded Google Sheets chart. |
createLine
|
Creates a line. |
refreshSheetsChart
|
Refreshes a Google Sheets chart. |
updateShapeProperties
|
Updates the properties of a
|
updateImageProperties
|
Updates the properties of an
|
updateVideoProperties
|
Updates the properties of a
|
updatePageProperties
|
Updates the properties of a
|
updateTableCellProperties
|
Updates the properties of a
|
updateLineProperties
|
Updates the properties of a
|
createParagraphBullets
|
Creates bullets for paragraphs. |
replaceAllShapesWithImage
|
Replaces all shapes matching some criteria with an image. |
duplicateObject
|
Duplicates a slide or page element. |
updateTextStyle
|
|
replaceAllShapesWithSheetsChart
|
Replaces all shapes matching some criteria with a Google Sheets chart. |
deleteParagraphBullets
|
Deletes bullets from paragraphs. |
updateParagraphStyle
|
|
updateTableBorderProperties
|
Updates the properties of the table borders in a
|
updateTableColumnProperties
|
Updates the properties of a
|
updateTableRowProperties
|
Updates the properties of a
|
mergeTableCells
|
Merges cells in a
|
unmergeTableCells
|
Unmerges cells in a
|
groupObjects
|
Groups objects, such as page elements. |
ungroupObjects
|
Ungroups objects, such as
|
updatePageElementAltText
|
Updates the alt text title and/or description of a
|
replaceImage
|
Replaces an existing image with a new image. |
updateSlideProperties
|
Updates the properties of a Slide |
updatePageElementsZOrder
|
Updates the Z-order of
|
updateLineCategory
|
Updates the category of a
|
rerouteLine
|
Reroutes a
|
CreateSlideRequest
Creates a slide.
JSON representation |
---|
{ "objectId": string, "insertionIndex": integer, "slideLayoutReference": { object ( |
Fields | |
---|---|
objectId
|
A user-supplied object ID.
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
If you don't specify an ID, a unique one is generated. |
insertionIndex
|
The optional zero-based index indicating where to insert the slides. If you don't specify an index, the slide is created at the end. |
slideLayoutReference
|
Layout reference of the slide to be inserted, based on the current master, which is one of the following:
If the LayoutReference is not found in the current master, a 400 bad request error is returned.
If you don't specify a layout reference, the slide uses the predefined
|
placeholderIdMappings[]
|
An optional list of object ID mappings from the
|
LayoutReference
Slide layout reference. This may reference either:
- A predefined layout
- One of the layouts in the presentation.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
kind . The kind of LayoutReference.
kind
can be only one of the following:
|
|
predefinedLayout
|
Predefined layout. |
layoutId
|
Layout ID: the object ID of one of the layouts in the presentation. |
PredefinedLayout
Predefined layout types. These are commonly found layouts in presentations. However, there is no guarantee that these layouts are present in the current master as they could have been deleted or not part of the used theme. Additionally, the placeholders on each layout may have been changed.
Enums | |
---|---|
PREDEFINED_LAYOUT_UNSPECIFIED
|
Unspecified layout. |
BLANK
|
Blank layout, with no placeholders. |
CAPTION_ONLY
|
Layout with a caption at the bottom. |
TITLE
|
Layout with a title and a subtitle. |
TITLE_AND_BODY
|
Layout with a title and body. |
TITLE_AND_TWO_COLUMNS
|
Layout with a title and two columns. |
TITLE_ONLY
|
Layout with only a title. |
SECTION_HEADER
|
Layout with a section title. |
SECTION_TITLE_AND_DESCRIPTION
|
Layout with a title and subtitle on one side and description on the other. |
ONE_COLUMN_TEXT
|
Layout with one title and one body, arranged in a single column. |
MAIN_POINT
|
Layout with a main point. |
BIG_NUMBER
|
Layout with a big number heading. |
LayoutPlaceholderIdMapping
The user-specified ID mapping for a placeholder that will be created on a slide from a specified layout.
JSON representation |
---|
{ "objectId": string, // Union field |
Fields | |
---|---|
objectId
|
A user-supplied object ID for the placeholder identified above that to be created onto a slide.
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
If you don't specify an ID, a unique one is generated. |
Union field
kind . The kind to identify a placeholder on a layout.
kind
can be only one of the following:
|
|
layoutPlaceholder
|
The placeholder on a layout that will be applied to a slide. Only
|
layoutPlaceholderObjectId
|
The object ID of the placeholder on a layout that will be applied to a slide. |
CreateShapeRequest
Creates a new shape.
JSON representation |
---|
{ "objectId": string, "elementProperties": { object ( |
Fields | |
---|---|
objectId
|
A user-supplied object ID.
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
|
elementProperties
|
The element properties for the shape. |
shapeType
|
The shape type. |
PageElementProperties
Common properties for a page element.
Note: When you initially create a
PageElement
, the API may modify the values of both
size
and
transform
, but the visual size will be unchanged.
JSON representation |
---|
{ "pageObjectId": string, "size": { object ( |
Fields | |
---|---|
pageObjectId
|
The object ID of the page where the element is located. |
size
|
The size of the element. |
transform
|
The transform for the element. |
CreateTableRequest
Creates a new table.
JSON representation |
---|
{
"objectId": string,
"elementProperties": {
object ( |
Fields | |
---|---|
objectId
|
A user-supplied object ID.
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
If you don't specify an ID, a unique one is generated. |
elementProperties
|
The element properties for the table. The table will be created at the provided size, subject to a minimum size. If no size is provided, the table will be automatically sized. Table transforms must have a scale of 1 and no shear components. If no transform is provided, the table will be centered on the page. |
rows
|
Number of rows in the table. |
columns
|
Number of columns in the table. |
InsertTextRequest
Inserts text into a shape or a table cell.
JSON representation |
---|
{
"objectId": string,
"cellLocation": {
object ( |
Fields | |
---|---|
objectId
|
The object ID of the shape or table where the text will be inserted. |
cellLocation
|
The optional table cell location if the text is to be inserted into a table cell. If present, the objectId must refer to a table. |
text
|
The text to be inserted.
Inserting a newline character will implicitly create a new
Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text will be added to the
Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text. |
insertionIndex
|
The index where the text will be inserted, in Unicode code units, based on
The index is zero-based and is computed from the start of the string. The index may be adjusted to prevent insertions inside Unicode grapheme clusters. In these cases, the text will be inserted immediately after the grapheme cluster. |
InsertTableRowsRequest
Inserts rows into a table.
JSON representation |
---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
Fields | |
---|---|
tableObjectId
|
The table to insert rows into. |
cellLocation
|
The reference table cell location from which rows will be inserted. A new row will be inserted above (or below) the row where the reference cell is. If the reference cell is a merged cell, a new row will be inserted above (or below) the merged cell. |
insertBelow
|
Whether to insert new rows below the reference cell location.
|
number
|
The number of rows to be inserted. Maximum 20 per request. |
InsertTableColumnsRequest
Inserts columns into a table.
Other columns in the table will be resized to fit the new column.
JSON representation |
---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
Fields | |
---|---|
tableObjectId
|
The table to insert columns into. |
cellLocation
|
The reference table cell location from which columns will be inserted. A new column will be inserted to the left (or right) of the column where the reference cell is. If the reference cell is a merged cell, a new column will be inserted to the left (or right) of the merged cell. |
insertRight
|
Whether to insert new columns to the right of the reference cell location.
|
number
|
The number of columns to be inserted. Maximum 20 per request. |
DeleteTableRowRequest
Deletes a row from a table.
JSON representation |
---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
Fields | |
---|---|
tableObjectId
|
The table to delete rows from. |
cellLocation
|
The reference table cell location from which a row will be deleted. The row this cell spans will be deleted. If this is a merged cell, multiple rows will be deleted. If no rows remain in the table after this deletion, the whole table is deleted. |
DeleteTableColumnRequest
Deletes a column from a table.
JSON representation |
---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
Fields | |
---|---|
tableObjectId
|
The table to delete columns from. |
cellLocation
|
The reference table cell location from which a column will be deleted. The column this cell spans will be deleted. If this is a merged cell, multiple columns will be deleted. If no columns remain in the table after this deletion, the whole table is deleted. |
ReplaceAllTextRequest
Replaces all instances of text matching a criteria with
replace text
.
JSON representation |
---|
{ "replaceText": string, "pageObjectIds": [ string ], // Union field |
Fields | |
---|---|
replaceText
|
The text that will replace the matched text. |
pageObjectIds[]
|
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
|
Union field
criteria . The criteria used to match text to replace.
criteria
can be only one of the following:
|
|
containsText
|
Finds text in a shape matching this substring. |
SubstringMatchCriteria
A criteria that matches a specific string of text in a shape or table.
JSON representation |
---|
{ "text": string, "matchCase": boolean } |
Fields | |
---|---|
text
|
The text to search for in the shape or table. |
matchCase
|
Indicates whether the search should respect case:
|
DeleteObjectRequest
Deletes an object, either
pages
or
page elements
, from the presentation.
JSON representation |
---|
{ "objectId": string } |
Fields | |
---|---|
objectId
|
The object ID of the page or page element to delete.
If after a delete operation a
If a placeholder is deleted on a layout, any empty inheriting placeholders are also deleted. |
UpdatePageElementTransformRequest
Updates the transform of a page element.
Updating the transform of a group will change the absolute transform of the page elements in that group, which can change their visual appearance. See the documentation for
PageElement.transform
for more details.
JSON representation |
---|
{ "objectId": string, "transform": { object ( |
Fields | |
---|---|
objectId
|
The object ID of the page element to update. |
transform
|
The input transform matrix used to update the page element. |
applyMode
|
The apply mode of the transform update. |
ApplyMode
The apply modes of the transform update.
Enums | |
---|---|
APPLY_MODE_UNSPECIFIED
|
Unspecified mode. |
RELATIVE
|
Applies the new AffineTransform matrix to the existing one, and replaces the existing one with the resulting concatenation. |
ABSOLUTE
|
Replaces the existing AffineTransform matrix with the new one. |
UpdateSlidesPositionRequest
Updates the position of slides in the presentation.
JSON representation |
---|
{ "slideObjectIds": [ string ], "insertionIndex": integer } |
Fields | |
---|---|
slideObjectIds[]
|
The IDs of the slides in the presentation that should be moved. The slides in this list must be in existing presentation order, without duplicates. |
insertionIndex
|
The index where the slides should be inserted, based on the slide arrangement before the move takes place. Must be between zero and the number of slides in the presentation, inclusive. |
DeleteTextRequest
Deletes text from a shape or a table cell.
JSON representation |
---|
{ "objectId": string, "cellLocation": { object ( |
Fields | |
---|---|
objectId
|
The object ID of the shape or table from which the text will be deleted. |
cellLocation
|
The optional table cell location if the text is to be deleted from a table cell. If present, the objectId must refer to a table. |
textRange
|
The range of text to delete, based on
There is always an implicit newline character at the end of a shape's or table cell's text that cannot be deleted.
Deleting text that crosses a paragraph boundary may result in changes to paragraph styles and lists as the two paragraphs are merged. Ranges that include only one code unit of a surrogate pair are expanded to include both code units. |
Range
Specifies a contiguous range of an indexed collection, such as characters in text.
JSON representation |
---|
{
"startIndex": integer,
"endIndex": integer,
"type": enum ( |
Fields | |
---|---|
startIndex
|
The optional zero-based index of the beginning of the collection. Required for
|
endIndex
|
The optional zero-based index of the end of the collection. Required for
|
type
|
The type of range. |
Type
The types of ranges.
Enums | |
---|---|
RANGE_TYPE_UNSPECIFIED
|
Unspecified range type. This value must not be used. |
FIXED_RANGE
|
A fixed range. Both the
startIndex
and
endIndex
must be specified.
|
FROM_START_INDEX
|
Starts the range at
startIndex
and continues until the end of the collection. The
endIndex
must not be specified.
|
ALL
|
Sets the range to be the whole length of the collection. Both the
startIndex
and the
endIndex
must not be specified.
|
CreateImageRequest
Creates an image.
JSON representation |
---|
{ "objectId": string, "elementProperties": { object ( |
Fields | |
---|---|
objectId
|
A user-supplied object ID.
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
If you don't specify an ID, a unique one is generated. |
elementProperties
|
The element properties for the image. When the aspect ratio of the provided size does not match the image aspect ratio, the image is scaled and centered with respect to the size in order to maintain the aspect ratio. The provided transform is applied after this operation.
The
The
|
Union field
image_source . The kind of image source.
image_source
can be only one of the following:
|
|
url
|
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 50 MB in size, can't exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF formats.
The provided URL must be publicly accessible and up to 2 KB in length. The URL is saved with the image, and exposed through the
|
CreateVideoRequest
Creates a video.
NOTE: Creating a video from Google Drive requires that the requesting app have at least one of the drive, drive.readonly, or drive.file OAuth scopes.
JSON representation |
---|
{ "objectId": string, "elementProperties": { object ( |
Fields | |
---|---|
objectId
|
A user-supplied object ID.
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
If you don't specify an ID, a unique one is generated. |
elementProperties
|
The element properties for the video.
The
The
|
source
|
The video source. |
id
|
The video source's unique identifier for this video. e.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0, the ID is 7U3axjORYZ0. For a Google Drive video https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q the ID is 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q. To access a Google Drive video file, you might need to add a resource key to the HTTP header for a subset of old files. For more information, see Access link-shared files using resource keys. |
CreateSheetsChartRequest
Creates an embedded Google Sheets chart.
NOTE: Chart creation requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, drive.file, or drive OAuth scopes.
JSON representation |
---|
{ "objectId": string, "elementProperties": { object ( |
Fields | |
---|---|
objectId
|
A user-supplied object ID. If specified, the ID must be unique among all pages and page elements in the presentation. The ID should start with a word character [a-zA-Z0-9_] and then followed by any number of the following characters [a-zA-Z0-9_-:]. The length of the ID should not be less than 5 or greater than 50. If empty, a unique identifier will be generated. |
elementProperties
|
The element properties for the chart. When the aspect ratio of the provided size does not match the chart aspect ratio, the chart is scaled and centered with respect to the size in order to maintain aspect ratio. The provided transform is applied after this operation. |
spreadsheetId
|
The ID of the Google Sheets spreadsheet that contains the chart. You might need to add a resource key to the HTTP header for a subset of old files. For more information, see Access link-shared files using resource keys. |
chartId
|
The ID of the specific chart in the Google Sheets spreadsheet. |
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. |
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. |
CreateLineRequest
Creates a line.
JSON representation |
---|
{ "objectId": string, "elementProperties": { object ( |
Fields | |
---|---|
objectId
|
A user-supplied object ID.
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
If you don't specify an ID, a unique one is generated. |
elementProperties
|
The element properties for the line. |
lineCategory
|
The category of the line to be created.
Deprecated
: use
The exact
If you specify both a
|
category
|
The category of the line to be created.
The exact
If you specify both a
If you do not specify a value for
If you do not specify either, then
|
Category
The line categories.
Enums | |
---|---|
STRAIGHT
|
Straight connectors, including straight connector 1. The is the default category when one is not specified. |
BENT
|
Bent connectors, including bent connector 2 to 5. |
CURVED
|
Curved connectors, including curved connector 2 to 5. |
RefreshSheetsChartRequest
Refreshes an embedded Google Sheets chart by replacing it with the latest version of the chart from Google Sheets.
NOTE: Refreshing charts requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.
JSON representation |
---|
{ "objectId": string } |
Fields | |
---|---|
objectId
|
The object ID of the chart to refresh. |
UpdateShapePropertiesRequest
Update the properties of a
Shape
.
JSON representation |
---|
{
"objectId": string,
"shapeProperties": {
object ( |
Fields | |
---|---|
objectId
|
The object ID of the shape the updates are applied to. |
shapeProperties
|
The shape properties to update. |
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example to update the shape background solid fill color, set
To reset a property to its default value, include its field name in the field mask but leave the field itself unset. |
UpdateImagePropertiesRequest
Update the properties of an
Image
.
JSON representation |
---|
{
"objectId": string,
"imageProperties": {
object ( |
Fields | |
---|---|
objectId
|
The object ID of the image the updates are applied to. |
imageProperties
|
The image properties to update. |
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example to update the image outline color, set
To reset a property to its default value, include its field name in the field mask but leave the field itself unset. |
UpdateVideoPropertiesRequest
Update the properties of a
Video
.
JSON representation |
---|
{
"objectId": string,
"videoProperties": {
object ( |
Fields | |
---|---|
objectId
|
The object ID of the video the updates are applied to. |
videoProperties
|
The video properties to update. |
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example to update the video outline color, set
To reset a property to its default value, include its field name in the field mask but leave the field itself unset. |
UpdatePagePropertiesRequest
Updates the properties of a
Page
.
JSON representation |
---|
{
"objectId": string,
"pageProperties": {
object ( |
Fields | |
---|---|
objectId
|
The object ID of the page the update is applied to. |
pageProperties
|
The page properties to update. |
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example to update the page background solid fill color, set
To reset a property to its default value, include its field name in the field mask but leave the field itself unset. |
UpdateTableCellPropertiesRequest
Update the properties of a
TableCell
.
JSON representation |
---|
{ "objectId": string, "tableRange": { object ( |
Fields | |
---|---|
objectId
|
The object ID of the table. |
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. |
tableCellProperties
|
The table cell properties to update. |
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example to update the table cell background solid fill color, set
To reset a property to its default value, include its field name in the field mask but leave the field itself unset. |
TableRange
A table range represents a reference to a subset of a table.
It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this:
[ ][ ][ ]
[ ][ ][ ]
[ ]
A table range with location = (0, 0), row span = 3 and column span = 2 specifies the following cells:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
JSON representation |
---|
{
"location": {
object ( |
Fields | |
---|---|
location
|
The starting location of the table range. |
rowSpan
|
The row span of the table range. |
columnSpan
|
The column span of the table range. |
UpdateLinePropertiesRequest
Updates the properties of a
Line
.
JSON representation |
---|
{
"objectId": string,
"lineProperties": {
object ( |
Fields | |
---|---|
objectId
|
The object ID of the line the update is applied to. |
lineProperties
|
The line properties to update. |
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example to update the line solid fill color, set
To reset a property to its default value, include its field name in the field mask but leave the field itself unset. |
CreateParagraphBulletsRequest
Creates bullets for all of the paragraphs that overlap with the given text index range.
The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text.
If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list.
JSON representation |
---|
{ "objectId": string, "cellLocation": { object ( |
Fields | |
---|---|
objectId
|
The object ID of the shape or table containing the text to add bullets to. |
cellLocation
|
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
|
The range of text to apply the bullet presets to, based on
|
bulletPreset
|
The kinds of bullet glyphs to be used. Defaults to the
|
BulletGlyphPreset
Preset patterns of bullet glyphs for lists in text.
These patterns use these kinds of bullets:
-
ARROW
: An arrow, corresponding to a Unicode U+2794 code point -
ARROW3D
: An arrow with 3D shading, corresponding to a Unicode U+27a2 code point -
CHECKBOX
: A hollow square, corresponding to a Unicode U+274f code point -
CIRCLE
: A hollow circle, corresponding to a Unicode U+25cb code point -
DIAMOND
: A solid diamond, corresponding to a Unicode U+25c6 code point -
DIAMONDX
: A diamond with an 'x', corresponding to a Unicode U+2756 code point -
HOLLOWDIAMOND
: A hollow diamond, corresponding to a Unicode U+25c7 code point -
DISC
: A solid circle, corresponding to a Unicode U+25cf code point -
SQUARE
: A solid square, corresponding to a Unicode U+25a0 code point -
STAR
: A star, corresponding to a Unicode U+2605 code point -
ALPHA
: A lowercase letter, like 'a', 'b', or 'c'. -
UPPERALPHA
: An uppercase letter, like 'A', 'B', or 'C'. -
DIGIT
: A number, like '1', '2', or '3'. -
ZERODIGIT
: A number where single digit numbers are prefixed with a zero, like '01', '02', or '03'. Numbers with more than one digit are not prefixed a zero. -
ROMAN
: A lowercase roman numeral, like 'i', 'ii', or 'iii'. -
UPPERROMAN
: A uppercase roman numeral, like 'I', 'II', or 'III'. -
LEFTTRIANGLE
: A triangle pointing left, corresponding to a Unicode U+25c4 code point
Enums | |
---|---|
BULLET_DISC_CIRCLE_SQUARE
|
A bulleted list with a
DISC ,
CIRCLE
and
SQUARE
bullet glyph for the first 3 list nesting levels.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
A bulleted list with a
DIAMONDX ,
ARROW3D
and
SQUARE
bullet glyph for the first 3 list nesting levels.
|
BULLET_CHECKBOX
|
A bulleted list with
CHECKBOX
bullet glyphs for all list nesting levels.
|
BULLET_ARROW_DIAMOND_DISC
|
A bulleted list with a
ARROW ,
DIAMOND
and
DISC
bullet glyph for the first 3 list nesting levels.
|
BULLET_STAR_CIRCLE_SQUARE
|
A bulleted list with a
STAR ,
CIRCLE
and
SQUARE
bullet glyph for the first 3 list nesting levels.
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
A bulleted list with a
ARROW3D ,
CIRCLE
and
SQUARE
bullet glyph for the first 3 list nesting levels.
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
A bulleted list with a
LEFTTRIANGLE ,
DIAMOND
and
DISC
bullet glyph for the first 3 list nesting levels.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
A bulleted list with a
DIAMONDX ,
HOLLOWDIAMOND
and
SQUARE
bullet glyph for the first 3 list nesting levels.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
A bulleted list with a
DIAMOND ,
CIRCLE
and
SQUARE
bullet glyph for the first 3 list nesting levels.
|
NUMBERED_DIGIT_ALPHA_ROMAN
|
A numbered list with
DIGIT ,
ALPHA
and
ROMAN
numeric glyphs for the first 3 list nesting levels, followed by periods.
|
NUMBERED_DIGIT_ALPHA_ROMAN_PARENS
|
A numbered list with
DIGIT ,
ALPHA
and
ROMAN
numeric glyphs for the first 3 list nesting levels, followed by parenthesis.
|
NUMBERED_DIGIT_NESTED
|
A numbered list with
DIGIT
numeric glyphs separated by periods, where each nesting level uses the previous nesting level's glyph as a prefix. For example: '1.', '1.1.', '2.', '2.2.'.
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
A numbered list with
UPPERALPHA ,
ALPHA
and
ROMAN
numeric glyphs for the first 3 list nesting levels, followed by periods.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT
|
A numbered list with
UPPERROMAN ,
UPPERALPHA
and
DIGIT
numeric glyphs for the first 3 list nesting levels, followed by periods.
|
NUMBERED_ZERODIGIT_ALPHA_ROMAN
|
A numbered list with
ZERODIGIT ,
ALPHA
and
ROMAN
numeric glyphs for the first 3 list nesting levels, followed by periods.
|
ReplaceAllShapesWithImageRequest
Replaces all shapes that match the given criteria with the provided image.
The images replacing the shapes are rectangular after being inserted into the presentation and do not take on the forms of the shapes.
JSON representation |
---|
{ "replaceMethod": enum ( |
Fields | |
---|---|
replaceMethod
|
The replace method.
Deprecated
: use
If you specify both a
|
imageReplaceMethod
|
The image replace method.
If you specify both a
If you do not specify a value for
If you do not specify either, then CENTER_INSIDE is used. |
pageObjectIds[]
|
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
|
Union field
criteria . The criteria that the shapes must match in order to be replaced.
criteria
can be only one of the following:
|
|
containsText
|
If set, this request will replace all of the shapes that contain the given text. |
Union field
image_source . The kind of image source.
image_source
can be only one of the following:
|
|
imageUrl
|
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 in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format.
The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the
|
ReplaceMethod
The replace method.
Enums | |
---|---|
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
|
The ID of the object to duplicate. |
objectIds
|
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
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
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
JSON representation |
---|
{ "objectId": string, "cellLocation": { object ( |
Fields | |
---|---|
objectId
|
The object ID of the shape or table with the text to be styled. |
cellLocation
|
The location of the cell in the table containing the text to style. If
|
style
|
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
|
textRange
|
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
|
The fields that should be updated.
At least one field must be specified. The root
For example, to update the text style to bold, set
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 ( |
Fields | |
---|---|
containsText
|
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
|
The ID of the Google Sheets spreadsheet that contains the chart. |
chartId
|
The ID of the specific chart in the Google Sheets spreadsheet. |
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[]
|
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
|
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 ( |
Fields | |
---|---|
objectId
|
The object ID of the shape or table containing the text to delete bullets from. |
cellLocation
|
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
|
The range of text to delete bullets from, based on
|
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 ( |
Fields | |
---|---|
objectId
|
The object ID of the shape or table with the text to be styled. |
cellLocation
|
The location of the cell in the table containing the paragraph(s) to style. If
|
style
|
The paragraph's style. |
textRange
|
The range of text containing the paragraph(s) to style. |
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example, to update the paragraph alignment, set
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 ( |
Fields | |
---|---|
objectId
|
The object ID of the table. |
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
|
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
|
The table border properties to update. |
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example to update the table border solid fill color, set
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 ( |
Fields | |
---|---|
objectId
|
The object ID of the table. |
columnIndices[]
|
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
|
The table column properties to update.
If the value of
|
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example to update the column width, set
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 ( |
Fields | |
---|---|
objectId
|
The object ID of the table. |
rowIndices[]
|
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
|
The table row properties to update. |
fields
|
The fields that should be updated.
At least one field must be specified. The root
For example to update the minimum row height, set
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 ( |
Fields | |
---|---|
objectId
|
The object ID of the table. |
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 ( |
Fields | |
---|---|
objectId
|
The object ID of the table. |
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
|
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
If you don't specify an ID, a unique one is generated. |
childrenObjectIds[]
|
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
|
UngroupObjectsRequest
Ungroups objects, such as
groups
.
JSON representation |
---|
{ "objectIds": [ string ] } |
Fields | |
---|---|
objectIds[]
|
The object IDs of the objects to ungroup.
Only
|
UpdatePageElementAltTextRequest
Updates the alt text title and/or description of a
page element
.
JSON representation |
---|
{ "objectId": string, "title": string, "description": string } |
Fields | |
---|---|
objectId
|
The object ID of the page element the updates are applied to. |
title
|
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
|
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 ( |
Fields | |
---|---|
imageObjectId
|
The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request. |
imageReplaceMethod
|
The replacement method. |
Union field
image_source . The kind of image source.
image_source
can be only one of the following:
|
|
url
|
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
|
UpdateSlidePropertiesRequest
Updates the properties of a Slide.
JSON representation |
---|
{
"objectId": string,
"slideProperties": {
object ( |
Fields | |
---|---|
objectId
|
The object ID of the slide the update is applied to. |
slideProperties
|
The slide properties to update. |
fields
|
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
For example to update whether a slide is skipped, set
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 ( |
Fields | |
---|---|
pageElementObjectIds[]
|
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
|
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 ( |
Fields | |
---|---|
objectId
|
The object ID of the line the update is applied to.
Only a line with a
The line may be rerouted after updating its category. |
lineCategory
|
The line category to update to.
The exact
|
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
|
The object ID of the line to reroute.
Only a line with a
|