| Title: | Google Slides API client and tools |
|---|---|
| Description: | Create, read and modify Slides presentations with full REST API functionality. |
| Authors: | Isaac Gravestock [cre, com], Google [cph] (Creator of API and documentation) |
| Maintainer: | Isaac Gravestock <[email protected]> |
| License: | GPL-3 |
| Version: | 0.0.1 |
| Built: | 2026-06-04 09:05:15 UTC |
| Source: | https://github.com/igrave/ladder.api |
AffineTransform Object
AffineTransform( scaleX = NULL, scaleY = NULL, shearX = NULL, shearY = NULL, translateX = NULL, translateY = NULL, unit = NULL )AffineTransform( scaleX = NULL, scaleY = NULL, shearX = NULL, shearY = NULL, translateX = NULL, translateY = NULL, unit = NULL )
scaleX |
(number) The X coordinate scaling element. |
scaleY |
(number) The Y coordinate scaling element. |
shearX |
(number) The X coordinate shearing element. |
shearY |
(number) The Y coordinate shearing element. |
translateX |
(number) The X coordinate translation element. |
translateY |
(number) The Y coordinate translation element. |
unit |
(string) The units for translate elements.
|
AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements.
AffineTransform object
Autofit Object
Autofit(autofitType = NULL, fontScale = NULL, lineSpacingReduction = NULL)Autofit(autofitType = NULL, fontScale = NULL, lineSpacingReduction = NULL)
autofitType |
(string) The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values.
|
fontScale |
(number) The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that is rendered in the editor. This property is read-only. |
lineSpacingReduction |
(number) The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that is rendered in the editor. This property is read-only. |
The autofit properties of a Shape.
Autofit object
AutoText Object
AutoText(type = NULL, content = NULL, style = NULL)AutoText(type = NULL, content = NULL, style = NULL)
type |
(string) The type of this auto text.
|
content |
(string) The rendered content of this auto text, if available. |
style |
(TextStyle) The styling applied to this auto text. |
A TextElement kind that represents auto text.
AutoText object
BatchUpdatePresentationRequest Object
BatchUpdatePresentationRequest(requests = NULL, writeControl = NULL)BatchUpdatePresentationRequest(requests = NULL, writeControl = NULL)
requests |
(list of Request objects) A list of updates to apply to the presentation. |
writeControl |
(WriteControl) Provides control over how write requests are executed. |
Request message for PresentationsService.BatchUpdatePresentation.
BatchUpdatePresentationRequest object
BatchUpdatePresentationResponse Object
BatchUpdatePresentationResponse( presentationId = NULL, replies = NULL, writeControl = NULL )BatchUpdatePresentationResponse( presentationId = NULL, replies = NULL, writeControl = NULL )
presentationId |
(string) The presentation the updates were applied to. |
replies |
(list of Response objects) The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. |
writeControl |
(WriteControl) The updated write control after applying the request. |
Response message from a batch update.
BatchUpdatePresentationResponse object
Bullet Object
Bullet(listId = NULL, nestingLevel = NULL, glyph = NULL, bulletStyle = NULL)Bullet(listId = NULL, nestingLevel = NULL, glyph = NULL, bulletStyle = NULL)
listId |
(string) The ID of the list this paragraph belongs to. |
nestingLevel |
(integer) The nesting level of this paragraph in the list. |
glyph |
(string) The rendered bullet glyph for this paragraph. |
bulletStyle |
(TextStyle) The paragraph specific text style applied to this bullet. |
Describes the bullet of a paragraph.
Bullet object
Opens a webpage for a user to authenticate with Google and select a presentation. This presentation is then authorised for use with ladder.
choose_slides()choose_slides()
A presentation id
id <- choose_slides()id <- choose_slides()
ColorScheme Object
ColorScheme(colors = NULL)ColorScheme(colors = NULL)
colors |
(list of ThemeColorPair objects) The ThemeColorType and corresponding concrete color pairs. |
The palette of predefined colors for a page.
ColorScheme object
ColorStop Object
ColorStop(color = NULL, alpha = NULL, position = NULL)ColorStop(color = NULL, alpha = NULL, position = NULL)
color |
(OpaqueColor) The color of the gradient stop. |
alpha |
(number) The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. |
position |
(number) The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. |
A color and position in a gradient band.
ColorStop object
CreateImageRequest Object
CreateImageRequest(objectId = NULL, elementProperties = NULL, url = NULL)CreateImageRequest(objectId = NULL, elementProperties = NULL, url = NULL)
objectId |
(string)
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 |
(PageElementProperties) 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 PageElementProperties.size property is optional. If you don't specify the size, the default size of the image is used. The PageElementProperties.transform property is optional. If you don't specify a transform, the image will be placed at the top-left corner of the page. |
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 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 Image.source_url field. |
Creates an image.
CreateImageRequest object
CreateImageResponse Object
CreateImageResponse(objectId = NULL)CreateImageResponse(objectId = NULL)
objectId |
(string) The object ID of the created image. |
The result of creating an image.
CreateImageResponse object
CreateLineRequest Object
CreateLineRequest( objectId = NULL, elementProperties = NULL, lineCategory = NULL, category = NULL )CreateLineRequest( objectId = NULL, elementProperties = NULL, lineCategory = NULL, category = NULL )
objectId |
(string)
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 |
(PageElementProperties) The element properties for the line. |
lineCategory |
(string)
The category of the line to be created. Deprecated: use
|
category |
(string)
The category of the line to be created. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a
|
Creates a line.
CreateLineRequest object
CreateLineResponse Object
CreateLineResponse(objectId = NULL)CreateLineResponse(objectId = NULL)
objectId |
(string) The object ID of the created line. |
The result of creating a line.
CreateLineResponse object
CreateParagraphBulletsRequest Object
CreateParagraphBulletsRequest( objectId = NULL, cellLocation = NULL, textRange = NULL, bulletPreset = NULL )CreateParagraphBulletsRequest( objectId = NULL, cellLocation = NULL, textRange = NULL, bulletPreset = NULL )
objectId |
(string) The object ID of the shape or table containing the text to add bullets to. |
cellLocation |
(TableCellLocation) The optional table cell location if the text to be modified is in a table cell. If present, the object_id must refer to a table. |
textRange |
(Range) The range of text to apply the bullet presets to, based on TextElement indexes. |
bulletPreset |
(string)
The kinds of bullet glyphs to be used. Defaults to the
|
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.
CreateParagraphBulletsRequest object
CreateShapeRequest Object
CreateShapeRequest(objectId = NULL, elementProperties = NULL, shapeType = NULL)CreateShapeRequest(objectId = NULL, elementProperties = NULL, shapeType = NULL)
objectId |
(string)
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 |
(PageElementProperties) The element properties for the shape. |
shapeType |
(string) The shape type.
|
Creates a new shape.
CreateShapeRequest object
CreateShapeResponse Object
CreateShapeResponse(objectId = NULL)CreateShapeResponse(objectId = NULL)
objectId |
(string) The object ID of the created shape. |
The result of creating a shape.
CreateShapeResponse object
CreateSheetsChartRequest Object
CreateSheetsChartRequest( objectId = NULL, elementProperties = NULL, spreadsheetId = NULL, chartId = NULL, linkingMode = NULL )CreateSheetsChartRequest( objectId = NULL, elementProperties = NULL, spreadsheetId = NULL, chartId = NULL, linkingMode = NULL )
objectId |
(string) 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 |
(PageElementProperties) 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 |
(string) 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 |
(integer) The ID of the specific chart in the Google Sheets spreadsheet. |
linkingMode |
(string) 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.
|
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.
CreateSheetsChartRequest object
CreateSheetsChartResponse Object
CreateSheetsChartResponse(objectId = NULL)CreateSheetsChartResponse(objectId = NULL)
objectId |
(string) The object ID of the created chart. |
The result of creating an embedded Google Sheets chart.
CreateSheetsChartResponse object
CreateSlideRequest Object
CreateSlideRequest( objectId = NULL, insertionIndex = NULL, slideLayoutReference = NULL, placeholderIdMappings = NULL )CreateSlideRequest( objectId = NULL, insertionIndex = NULL, slideLayoutReference = NULL, placeholderIdMappings = NULL )
objectId |
(string)
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 |
insertionIndex |
(integer) 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 |
(LayoutReference)
Layout reference of the slide to be inserted, based on the current master, which is one of the following: - The master of the previous slide index. - The master of the first slide, if the insertion_index is zero. - The first master in the presentation, if there are no slides. 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 |
(list of LayoutPlaceholderIdMapping objects)
An optional list of object ID mappings from the placeholder(s) on the layout to the placeholders that are created on the slide from the specified layout. Can only be used when |
Creates a slide.
CreateSlideRequest object
CreateSlideResponse Object
CreateSlideResponse(objectId = NULL)CreateSlideResponse(objectId = NULL)
objectId |
(string) The object ID of the created slide. |
The result of creating a slide.
CreateSlideResponse object
CreateTableRequest Object
CreateTableRequest( objectId = NULL, elementProperties = NULL, rows = NULL, columns = NULL )CreateTableRequest( objectId = NULL, elementProperties = NULL, rows = NULL, columns = NULL )
objectId |
(string)
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 |
(PageElementProperties) 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 |
(integer) Number of rows in the table. |
columns |
(integer) Number of columns in the table. |
Creates a new table.
CreateTableRequest object
CreateTableResponse Object
CreateTableResponse(objectId = NULL)CreateTableResponse(objectId = NULL)
objectId |
(string) The object ID of the created table. |
The result of creating a table.
CreateTableResponse object
CreateVideoRequest Object
CreateVideoRequest( objectId = NULL, elementProperties = NULL, source = NULL, id = NULL )CreateVideoRequest( objectId = NULL, elementProperties = NULL, source = NULL, id = NULL )
objectId |
(string)
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 |
(PageElementProperties) The element properties for the video. The PageElementProperties.size property is optional. If you don't specify a size, a default size is chosen by the server. The PageElementProperties.transform property is optional. The transform must not have shear components. If you don't specify a transform, the video will be placed at the top left corner of the page. |
source |
(string) The video source.
|
id |
(string) 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. |
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.
CreateVideoRequest object
CreateVideoResponse Object
CreateVideoResponse(objectId = NULL)CreateVideoResponse(objectId = NULL)
objectId |
(string) The object ID of the created video. |
The result of creating a video.
CreateVideoResponse object
CropProperties Object
CropProperties( leftOffset = NULL, rightOffset = NULL, topOffset = NULL, bottomOffset = NULL, angle = NULL )CropProperties( leftOffset = NULL, rightOffset = NULL, topOffset = NULL, bottomOffset = NULL, angle = NULL )
leftOffset |
(number) The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. |
rightOffset |
(number) The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. |
topOffset |
(number) The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. |
bottomOffset |
(number) The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. |
angle |
(number) The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. |
The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions.
If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle.
If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle.
If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally.
If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically.
If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container.
CropProperties object
DeleteObjectRequest Object
DeleteObjectRequest(objectId = NULL)DeleteObjectRequest(objectId = NULL)
objectId |
(string) The object ID of the page or page element to delete. If after a delete operation a group contains only 1 or no page elements, the group is also deleted. If a placeholder is deleted on a layout, any empty inheriting placeholders are also deleted. |
Deletes an object, either pages or page elements, from the presentation.
DeleteObjectRequest object
DeleteParagraphBulletsRequest Object
DeleteParagraphBulletsRequest( objectId = NULL, cellLocation = NULL, textRange = NULL )DeleteParagraphBulletsRequest( objectId = NULL, cellLocation = NULL, textRange = NULL )
objectId |
(string) The object ID of the shape or table containing the text to delete bullets from. |
cellLocation |
(TableCellLocation) The optional table cell location if the text to be modified is in a table cell. If present, the object_id must refer to a table. |
textRange |
(Range) The range of text to delete bullets from, based on TextElement indexes. |
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.
DeleteParagraphBulletsRequest object
DeleteTableColumnRequest Object
DeleteTableColumnRequest(tableObjectId = NULL, cellLocation = NULL)DeleteTableColumnRequest(tableObjectId = NULL, cellLocation = NULL)
tableObjectId |
(string) The table to delete columns from. |
cellLocation |
(TableCellLocation) 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. |
Deletes a column from a table.
DeleteTableColumnRequest object
DeleteTableRowRequest Object
DeleteTableRowRequest(tableObjectId = NULL, cellLocation = NULL)DeleteTableRowRequest(tableObjectId = NULL, cellLocation = NULL)
tableObjectId |
(string) The table to delete rows from. |
cellLocation |
(TableCellLocation) 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. |
Deletes a row from a table.
DeleteTableRowRequest object
DeleteTextRequest Object
DeleteTextRequest(objectId = NULL, cellLocation = NULL, textRange = NULL)DeleteTextRequest(objectId = NULL, cellLocation = NULL, textRange = NULL)
objectId |
(string) The object ID of the shape or table from which the text will be deleted. |
cellLocation |
(TableCellLocation) The optional table cell location if the text is to be deleted from a table cell. If present, the object_id must refer to a table. |
textRange |
(Range)
The range of text to delete, based on TextElement indexes. There is always an implicit newline character at the end of a shape's or table cell's text that cannot be deleted. |
Deletes text from a shape or a table cell.
DeleteTextRequest object
Dimension Object
Dimension(magnitude = NULL, unit = NULL)Dimension(magnitude = NULL, unit = NULL)
magnitude |
(number) The magnitude. |
unit |
(string) The units for magnitude.
|
A magnitude in a single direction in the specified units.
Dimension object
DuplicateObjectRequest Object
DuplicateObjectRequest(objectId = NULL, objectIds = NULL)DuplicateObjectRequest(objectId = NULL, objectIds = NULL)
objectId |
(string) The ID of the object to duplicate. |
objectIds |
(named list of string objects)
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 |
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.
DuplicateObjectRequest object
DuplicateObjectResponse Object
DuplicateObjectResponse(objectId = NULL)DuplicateObjectResponse(objectId = NULL)
objectId |
(string) The ID of the new duplicate object. |
The response of duplicating an object.
DuplicateObjectResponse object
Group Object
Group(children = NULL)Group(children = NULL)
children |
(list of PageElement objects) The collection of elements in the group. The minimum size of a group is 2. |
A PageElement kind representing a joined collection of PageElements.
Group object
GroupObjectsRequest Object
GroupObjectsRequest(groupObjectId = NULL, childrenObjectIds = NULL)GroupObjectsRequest(groupObjectId = NULL, childrenObjectIds = NULL)
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 |
childrenObjectIds |
(list of string objects) 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. |
Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.
GroupObjectsRequest object
GroupObjectsResponse Object
GroupObjectsResponse(objectId = NULL)GroupObjectsResponse(objectId = NULL)
objectId |
(string) The object ID of the created group. |
The result of grouping objects.
GroupObjectsResponse object
Image Object
Image( contentUrl = NULL, imageProperties = NULL, sourceUrl = NULL, placeholder = NULL )Image( contentUrl = NULL, imageProperties = NULL, sourceUrl = NULL, placeholder = NULL )
contentUrl |
(string) An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. |
imageProperties |
(ImageProperties) The properties of the image. |
sourceUrl |
(string) The source URL is the URL used to insert the image. The source URL can be empty. |
placeholder |
(Placeholder) Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the image is a placeholder image and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. |
A PageElement kind representing an image.
Image object
ImageProperties Object
ImageProperties( cropProperties = NULL, transparency = NULL, brightness = NULL, contrast = NULL, recolor = NULL, outline = NULL, shadow = NULL, link = NULL )ImageProperties( cropProperties = NULL, transparency = NULL, brightness = NULL, contrast = NULL, recolor = NULL, outline = NULL, shadow = NULL, link = NULL )
cropProperties |
(CropProperties) The crop properties of the image. If not set, the image is not cropped. This property is read-only. |
transparency |
(number) The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. |
brightness |
(number) The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. |
contrast |
(number) The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. |
recolor |
(Recolor) The recolor effect of the image. If not set, the image is not recolored. This property is read-only. |
outline |
(Outline) The outline of the image. If not set, the image has no outline. |
shadow |
(Shadow) The shadow of the image. If not set, the image has no shadow. This property is read-only. |
link |
(Link) The hyperlink destination of the image. If unset, there is no link. |
The properties of the Image.
ImageProperties object
InsertTableColumnsRequest Object
InsertTableColumnsRequest( tableObjectId = NULL, cellLocation = NULL, insertRight = NULL, number = NULL )InsertTableColumnsRequest( tableObjectId = NULL, cellLocation = NULL, insertRight = NULL, number = NULL )
tableObjectId |
(string) The table to insert columns into. |
cellLocation |
(TableCellLocation) 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 |
(boolean)
Whether to insert new columns to the right of the reference cell location. - |
number |
(integer) The number of columns to be inserted. Maximum 20 per request. |
Inserts columns into a table. Other columns in the table will be resized to fit the new column.
InsertTableColumnsRequest object
InsertTableRowsRequest Object
InsertTableRowsRequest( tableObjectId = NULL, cellLocation = NULL, insertBelow = NULL, number = NULL )InsertTableRowsRequest( tableObjectId = NULL, cellLocation = NULL, insertBelow = NULL, number = NULL )
tableObjectId |
(string) The table to insert rows into. |
cellLocation |
(TableCellLocation) 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 |
(boolean)
Whether to insert new rows below the reference cell location. - |
number |
(integer) The number of rows to be inserted. Maximum 20 per request. |
Inserts rows into a table.
InsertTableRowsRequest object
InsertTextRequest Object
InsertTextRequest( objectId = NULL, cellLocation = NULL, text = NULL, insertionIndex = NULL )InsertTextRequest( objectId = NULL, cellLocation = NULL, text = NULL, insertionIndex = NULL )
objectId |
(string) The object ID of the shape or table where the text will be inserted. |
cellLocation |
(TableCellLocation) The optional table cell location if the text is to be inserted into a table cell. If present, the object_id must refer to a table. |
text |
(string) The text to be inserted. Inserting a newline character will implicitly create a new ParagraphMarker at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. 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 TextRun that exists at the insertion index. 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 |
(integer) The index where the text will be inserted, in Unicode code units, based on TextElement indexes. 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. |
Inserts text into a shape or a table cell.
InsertTextRequest object
Authorize ladder.api to view and manage your presentations. This function is a
wrapper around gargle::token_fetch().
By default, you are directed to a web browser, asked to sign in to your Google account, and to grant ladder.api permission to operate on your behalf with Google Slides. By default, with your permission, these user credentials are cached in a folder below your home directory, from where they can be automatically refreshed, as necessary. Storage at the user level means the same token can be used across multiple projects and tokens are less likely to be synced to the cloud by accident.
ladder_auth( email = gargle::gargle_oauth_email(), path = NULL, subject = NULL, scopes = c("https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/presentations.currentonly"), cache = gargle::gargle_oauth_cache(), use_oob = gargle::gargle_oob_default(), token = NULL )ladder_auth( email = gargle::gargle_oauth_email(), path = NULL, subject = NULL, scopes = c("https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/presentations.currentonly"), cache = gargle::gargle_oauth_cache(), use_oob = gargle::gargle_oob_default(), token = NULL )
email |
Optional. If specified,
Defaults to the option named |
path |
JSON identifying the service account, in one of the forms
supported for the |
subject |
An optional subject claim. Specify this if you wish to use the
service account represented by |
scopes |
A character vector of scopes to request. Pick from those listed at https://developers.google.com/identity/protocols/oauth2/scopes. |
cache |
Specifies the OAuth token cache. Defaults to the option named
|
use_oob |
Whether to use out-of-band authentication (or, perhaps, a
variant implemented by gargle and known as "pseudo-OOB") when first
acquiring the token. Defaults to the value returned by
If the OAuth client is provided implicitly by a wrapper package, its type
probably defaults to the value returned by
|
token |
A token with class Token2.0 or an object of
httr's class |
Most users, most of the time, do not need to call ladder_auth()
explicitly – it is triggered by the first action that requires
authorization. Even when called, the default arguments often suffice.
However, when necessary, ladder_auth() allows the user to explicitly:
Declare which Google identity to use, via an email specification.
Use a service account token or workload identity federation via
path.
Bring your own token.
Customize scopes.
Use a non-default cache folder or turn caching off.
Explicitly request out-of-band (OOB) auth via use_oob.
If you are interacting with R within a browser (applies to RStudio
Server, Posit Workbench, Posit Cloud, and Google Colaboratory), you need
OOB auth or the pseudo-OOB variant. If this does not happen
automatically, you can request it explicitly with use_oob = TRUE or,
more persistently, by setting an option via
options(gargle_oob_default = TRUE).
The choice between conventional OOB or pseudo-OOB auth is determined
by the type of OAuth client. If the client is of the "installed" type,
use_oob = TRUE results in conventional OOB auth. If the client is of
the "web" type, use_oob = TRUE results in pseudo-OOB auth. Packages
that provide a built-in OAuth client can usually detect which type of
client to use. But if you need to set this explicitly, use the
"gargle_oauth_client_type" option:
options(gargle_oauth_client_type = "web") # pseudo-OOB # or, alternatively options(gargle_oauth_client_type = "installed") # conventional OOB
For details on the many ways to find a token, see
gargle::token_fetch(). For deeper control over auth, use
ladder_auth_configure() to bring your own OAuth client or API key.
To learn more about gargle options, see gargle::gargle_options.
Other auth functions:
ladder_auth_configure(),
ladder_deauth()
# load/refresh existing credentials, if available # otherwise, go to browser for authentication and authorization ladder_auth() # see user associated with current token ladder_user() # force use of a token associated with a specific email ladder_auth(email = "[email protected]") ladder_user() # force the OAuth web dance ladder_auth(email = NA) # use a 'read only' scope, so it's impossible to edit or delete files ladder_auth(scopes = "slides.readonly") # use a service account token ladder_auth(path = "foofy-83ee9e7c9c48.json")# load/refresh existing credentials, if available # otherwise, go to browser for authentication and authorization ladder_auth() # see user associated with current token ladder_user() # force use of a token associated with a specific email ladder_auth(email = "[email protected]") ladder_user() # force the OAuth web dance ladder_auth(email = NA) # use a 'read only' scope, so it's impossible to edit or delete files ladder_auth(scopes = "slides.readonly") # use a service account token ladder_auth(path = "foofy-83ee9e7c9c48.json")
These functions give more control over and visibility into the auth
configuration than ladder_auth() does. ladder_auth_configure()
lets the user specify their own:
OAuth client, which is used when obtaining a user token.
API key. If ladder.api is de-authorized via ladder_deauth(), all
requests are sent with an API key in lieu of a token.
See the vignette("get-api-credentials", package = "gargle")
for more.
If the user does not configure these settings, internal defaults
are used.
ladder_oauth_client() and ladder_api_key() retrieve the
currently configured OAuth client and API key, respectively.
ladder_auth_configure(client, path, api_key, app) ladder_api_key() ladder_oauth_client()ladder_auth_configure(client, path, api_key, app) ladder_api_key() ladder_oauth_client()
client |
A Google OAuth client, presumably constructed via
|
path |
JSON downloaded from Google Cloud Console, containing a client id and
secret, in one of the forms supported for the |
api_key |
API key. |
app |
ladder_auth_configure(): An object of R6 class
gargle::AuthState, invisibly.
ladder_oauth_client(): the current user-configured OAuth client.
ladder_api_key(): the current user-configured API key.
Other auth functions:
ladder_auth(),
ladder_deauth()
# see and store the current user-configured OAuth client (probaby `NULL`) (original_client <- ladder_oauth_client()) # see and store the current user-configured API key (probaby `NULL`) (original_api_key <- ladder_api_key()) # the preferred way to configure your own client is via a JSON file # downloaded from Google Developers Console # this example JSON is indicative, but fake path_to_json <- system.file( "extdata", "client_secret_installed.googleusercontent.com.json", package = "gargle" ) ladder_auth_configure(path = path_to_json) # this is also obviously a fake API key ladder_auth_configure(api_key = "the_key_I_got_for_a_google_API") # confirm the changes ladder_oauth_client() ladder_api_key() # restore original auth config ladder_auth_configure(client = original_client, api_key = original_api_key)# see and store the current user-configured OAuth client (probaby `NULL`) (original_client <- ladder_oauth_client()) # see and store the current user-configured API key (probaby `NULL`) (original_api_key <- ladder_api_key()) # the preferred way to configure your own client is via a JSON file # downloaded from Google Developers Console # this example JSON is indicative, but fake path_to_json <- system.file( "extdata", "client_secret_installed.googleusercontent.com.json", package = "gargle" ) ladder_auth_configure(path = path_to_json) # this is also obviously a fake API key ladder_auth_configure(api_key = "the_key_I_got_for_a_google_API") # confirm the changes ladder_oauth_client() ladder_api_key() # restore original auth config ladder_auth_configure(client = original_client, api_key = original_api_key)
Put ladder.api into a de-authorized state. Instead of sending a token,
ladder.api will send an API key. This can be used to access public
resources for which no Google sign-in is required. This is handy for using
ladder.api in a non-interactive setting to make requests that do not
require a token. It will prevent the attempt to obtain a token
interactively in the browser. The user can configure their own API key
via ladder_auth_configure() and retrieve that key via
ladder_api_key().
In the absence of a user-configured key, a built-in default key is used.
ladder_deauth()ladder_deauth()
Other auth functions:
ladder_auth(),
ladder_auth_configure()
## Not run: ladder_deauth() ladder_user() ## End(Not run)## Not run: ladder_deauth() ladder_user() ## End(Not run)
Reports whether ladder.api has stored a token, ready for use in downstream requests.
ladder_has_token()ladder_has_token()
Logical.
Other low-level API functions:
ladder_token()
ladder_has_token()ladder_has_token()
For internal use or for those programming around the Slides API.
Returns a token pre-processed with httr::config(). Most users
do not need to handle tokens "by hand" or, even if they need some
control, ladder_auth() is what they need. If there is no current
token, ladder_auth() is called to either load from cache or
initiate OAuth2.0 flow.
If auth has been deactivated via ladder_deauth(), ladder_token()
returns NULL.
ladder_token()ladder_token()
A request object (an S3 class provided by httr).
Other low-level API functions:
ladder_has_token()
## Not run: ladder_token() ## End(Not run)## Not run: ladder_token() ## End(Not run)
Reveals the email address of the user associated with the current token. If no token has been loaded yet, this function does not initiate auth.
ladder_user()ladder_user()
An email address or, if no token has been loaded, NULL.
gargle::token_userinfo(), gargle::token_email(),
gargle::token_tokeninfo()
## Not run: ladder_user() ## End(Not run)## Not run: ladder_user() ## End(Not run)
LayoutPlaceholderIdMapping Object
LayoutPlaceholderIdMapping( layoutPlaceholder = NULL, layoutPlaceholderObjectId = NULL, objectId = NULL )LayoutPlaceholderIdMapping( layoutPlaceholder = NULL, layoutPlaceholderObjectId = NULL, objectId = NULL )
layoutPlaceholder |
(Placeholder)
The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a predefined |
layoutPlaceholderObjectId |
(string) The object ID of the placeholder on a layout that will be applied to a slide. |
objectId |
(string)
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 |
The user-specified ID mapping for a placeholder that will be created on a slide from a specified layout.
LayoutPlaceholderIdMapping object
LayoutProperties Object
LayoutProperties(masterObjectId = NULL, name = NULL, displayName = NULL)LayoutProperties(masterObjectId = NULL, name = NULL, displayName = NULL)
masterObjectId |
(string) The object ID of the master that this layout is based on. |
name |
(string) The name of the layout. |
displayName |
(string) The human-readable name of the layout. |
The properties of Page are only relevant for pages with page_type LAYOUT.
LayoutProperties object
LayoutReference Object
LayoutReference(predefinedLayout = NULL, layoutId = NULL)LayoutReference(predefinedLayout = NULL, layoutId = NULL)
predefinedLayout |
(string) Predefined layout.
|
layoutId |
(string) Layout ID: the object ID of one of the layouts in the presentation. |
Slide layout reference. This may reference either:
A predefined layout - One of the layouts in the presentation.
LayoutReference object
Line Object
Line(lineProperties = NULL, lineType = NULL, lineCategory = NULL)Line(lineProperties = NULL, lineType = NULL, lineCategory = NULL)
lineProperties |
(LineProperties) The properties of the line. |
lineType |
(string) The type of the line.
|
lineCategory |
(string)
The category of the line. It matches the
|
A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector.
Line object
LineConnection Object
LineConnection(connectedObjectId = NULL, connectionSiteIndex = NULL)LineConnection(connectedObjectId = NULL, connectionSiteIndex = NULL)
connectedObjectId |
(string) The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. |
connectionSiteIndex |
(integer) The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of ECMA-376 5th edition. The position of each connection site can also be viewed from Slides editor. |
The properties for one end of a Line connection.
LineConnection object
LineFill Object
LineFill(solidFill = NULL)LineFill(solidFill = NULL)
solidFill |
(SolidFill) Solid color fill. |
The fill of the line.
LineFill object
LineProperties Object
LineProperties( lineFill = NULL, weight = NULL, dashStyle = NULL, startArrow = NULL, endArrow = NULL, link = NULL, startConnection = NULL, endConnection = NULL )LineProperties( lineFill = NULL, weight = NULL, dashStyle = NULL, startArrow = NULL, endArrow = NULL, link = NULL, startConnection = NULL, endConnection = NULL )
lineFill |
(LineFill) The fill of the line. The default line fill matches the defaults for new lines created in the Slides editor. |
weight |
(Dimension) The thickness of the line. |
dashStyle |
(string) The dash style of the line.
|
startArrow |
(string) The style of the arrow at the beginning of the line.
|
endArrow |
(string) The style of the arrow at the end of the line.
|
link |
(Link) The hyperlink destination of the line. If unset, there is no link. |
startConnection |
(LineConnection)
The connection at the beginning of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have a |
endConnection |
(LineConnection)
The connection at the end of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have an |
The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor.
LineProperties object
Link Object
Link(url = NULL, relativeLink = NULL, pageObjectId = NULL, slideIndex = NULL)Link(url = NULL, relativeLink = NULL, pageObjectId = NULL, slideIndex = NULL)
url |
(string) If set, indicates this is a link to the external web page at this URL. |
relativeLink |
(string) If set, indicates this is a link to a slide in this presentation, addressed by its position.
|
pageObjectId |
(string) If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. |
slideIndex |
(integer) If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. |
A hypertext link.
Link object
List Object
List(listId = NULL, nestingLevel = NULL)List(listId = NULL, nestingLevel = NULL)
listId |
(string) The ID of the list. |
nestingLevel |
(named list of NestingLevel objects) A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. |
A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID.
List object
MasterProperties Object
MasterProperties(displayName = NULL)MasterProperties(displayName = NULL)
displayName |
(string) The human-readable name of the master. |
The properties of Page that are only relevant for pages with page_type MASTER.
MasterProperties object
MergeTableCellsRequest Object
MergeTableCellsRequest(objectId = NULL, tableRange = NULL)MergeTableCellsRequest(objectId = NULL, tableRange = NULL)
objectId |
(string) The object ID of the table. |
tableRange |
(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. |
Merges cells in a Table.
MergeTableCellsRequest object
NestingLevel Object
NestingLevel(bulletStyle = NULL)NestingLevel(bulletStyle = NULL)
bulletStyle |
(TextStyle) The style of a bullet at this level of nesting. |
Contains properties describing the look and feel of a list bullet at a given level of nesting.
NestingLevel object
NotesProperties Object
NotesProperties(speakerNotesObjectId = NULL)NotesProperties(speakerNotesObjectId = NULL)
speakerNotesObjectId |
(string)
The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The |
The properties of Page that are only relevant for pages with page_type NOTES.
NotesProperties object
OpaqueColor Object
OpaqueColor(rgbColor = NULL, themeColor = NULL)OpaqueColor(rgbColor = NULL, themeColor = NULL)
rgbColor |
(RgbColor) An opaque RGB color. |
themeColor |
(string) An opaque theme color.
|
A themeable solid color value.
OpaqueColor object
OptionalColor Object
OptionalColor(opaqueColor = NULL)OptionalColor(opaqueColor = NULL)
opaqueColor |
(OpaqueColor) If set, this will be used as an opaque color. If unset, this represents a transparent color. |
A color that can either be fully opaque or fully transparent.
OptionalColor object
Outline Object
Outline( outlineFill = NULL, weight = NULL, dashStyle = NULL, propertyState = NULL )Outline( outlineFill = NULL, weight = NULL, dashStyle = NULL, propertyState = NULL )
outlineFill |
(OutlineFill) The fill of the outline. |
weight |
(Dimension) The thickness of the outline. |
dashStyle |
(string) The dash style of the outline.
|
propertyState |
(string)
The outline property state. Updating the outline on a page element will implicitly update this field to
|
The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind.
Outline object
OutlineFill Object
OutlineFill(solidFill = NULL)OutlineFill(solidFill = NULL)
solidFill |
(SolidFill) Solid color fill. |
The fill of the outline.
OutlineFill object
Page Object
Page( objectId = NULL, pageType = NULL, pageElements = NULL, slideProperties = NULL, layoutProperties = NULL, notesProperties = NULL, masterProperties = NULL, revisionId = NULL, pageProperties = NULL )Page( objectId = NULL, pageType = NULL, pageElements = NULL, slideProperties = NULL, layoutProperties = NULL, notesProperties = NULL, masterProperties = NULL, revisionId = NULL, pageProperties = NULL )
objectId |
(string) The object ID for this page. Object IDs used by Page and PageElement share the same namespace. |
pageType |
(string) The type of the page.
|
pageElements |
(list of PageElement objects) The page elements rendered on the page. |
slideProperties |
(SlideProperties) Slide specific properties. Only set if page_type = SLIDE. |
layoutProperties |
(LayoutProperties) Layout specific properties. Only set if page_type = LAYOUT. |
notesProperties |
(NotesProperties) Notes specific properties. Only set if page_type = NOTES. |
masterProperties |
(MasterProperties) Master specific properties. Only set if page_type = MASTER. |
revisionId |
(string) Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. |
pageProperties |
(PageProperties) The properties of the page. |
A page in a presentation.
Page object
PageBackgroundFill Object
PageBackgroundFill( propertyState = NULL, solidFill = NULL, stretchedPictureFill = NULL )PageBackgroundFill( propertyState = NULL, solidFill = NULL, stretchedPictureFill = NULL )
propertyState |
(string)
The background fill property state. Updating the fill on a page will implicitly update this field to
|
solidFill |
(SolidFill) Solid color fill. |
stretchedPictureFill |
(StretchedPictureFill) Stretched picture fill. |
The page background fill.
PageBackgroundFill object
PageElement Object
PageElement( objectId = NULL, size = NULL, transform = NULL, title = NULL, description = NULL, elementGroup = NULL, shape = NULL, image = NULL, video = NULL, line = NULL, table = NULL, wordArt = NULL, sheetsChart = NULL, speakerSpotlight = NULL )PageElement( objectId = NULL, size = NULL, transform = NULL, title = NULL, description = NULL, elementGroup = NULL, shape = NULL, image = NULL, video = NULL, line = NULL, table = NULL, wordArt = NULL, sheetsChart = NULL, speakerSpotlight = NULL )
objectId |
(string) The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace. |
size |
(Size) The size of the page element. |
transform |
(AffineTransform) The transform of the page element. The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field. The initial transform for the newly created Group is always the identity transform. |
title |
(string) The title of the page element. Combined with description to display alt text. The field is not supported for Group elements. |
description |
(string) The description of the page element. Combined with title to display alt text. The field is not supported for Group elements. |
elementGroup |
(Group) A collection of page elements joined as a single unit. |
shape |
(Shape) A generic shape. |
image |
(Image) An image page element. |
video |
(Video) A video page element. |
line |
(Line) A line page element. |
table |
(Table) A table page element. |
wordArt |
(WordArt) A word art page element. |
sheetsChart |
(SheetsChart) A linked chart embedded from Google Sheets. Unlinked charts are represented as images. |
speakerSpotlight |
(SpeakerSpotlight) A Speaker Spotlight. |
A visual element rendered on a page.
PageElement object
PageElementProperties Object
PageElementProperties(pageObjectId = NULL, size = NULL, transform = NULL)PageElementProperties(pageObjectId = NULL, size = NULL, transform = NULL)
pageObjectId |
(string) The object ID of the page where the element is located. |
size |
(Size) The size of the element. |
transform |
(AffineTransform) The transform for the element. |
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.
PageElementProperties object
PageProperties Object
PageProperties(pageBackgroundFill = NULL, colorScheme = NULL)PageProperties(pageBackgroundFill = NULL, colorScheme = NULL)
pageBackgroundFill |
(PageBackgroundFill) The background fill of the page. If unset, the background fill is inherited from a parent page if it exists. If the page has no parent, then the background fill defaults to the corresponding fill in the Slides editor. |
colorScheme |
(ColorScheme)
The color scheme of the page. If unset, the color scheme is inherited from a parent page. If the page has no parent, the color scheme uses a default Slides color scheme, matching the defaults in the Slides editor. Only the concrete colors of the first 12 ThemeColorTypes are editable. In addition, only the color scheme on |
The properties of the Page. The page will inherit properties from the parent page. Depending on the page type the hierarchy is defined in either SlideProperties or LayoutProperties.
PageProperties object
ParagraphMarker Object
ParagraphMarker(style = NULL, bullet = NULL)ParagraphMarker(style = NULL, bullet = NULL)
style |
(ParagraphStyle) The paragraph's style |
bullet |
(Bullet) The bullet for this paragraph. If not present, the paragraph does not belong to a list. |
A TextElement kind that represents the beginning of a new paragraph.
ParagraphMarker object
ParagraphStyle Object
ParagraphStyle( lineSpacing = NULL, alignment = NULL, indentStart = NULL, indentEnd = NULL, spaceAbove = NULL, spaceBelow = NULL, indentFirstLine = NULL, direction = NULL, spacingMode = NULL )ParagraphStyle( lineSpacing = NULL, alignment = NULL, indentStart = NULL, indentEnd = NULL, spaceAbove = NULL, spaceBelow = NULL, indentFirstLine = NULL, direction = NULL, spacingMode = NULL )
lineSpacing |
(number) The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. |
alignment |
(string) The text alignment for this paragraph.
|
indentStart |
(Dimension) The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. |
indentEnd |
(Dimension) The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. |
spaceAbove |
(Dimension) The amount of extra space above the paragraph. If unset, the value is inherited from the parent. |
spaceBelow |
(Dimension) The amount of extra space below the paragraph. If unset, the value is inherited from the parent. |
indentFirstLine |
(Dimension) The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. |
direction |
(string) The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited.
|
spacingMode |
(string) The spacing mode for the paragraph.
|
Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists:
A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder.
A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message.
ParagraphStyle object
Placeholder Object
Placeholder(type = NULL, index = NULL, parentObjectId = NULL)Placeholder(type = NULL, index = NULL, parentObjectId = NULL)
type |
(string) The type of the placeholder.
|
index |
(integer) The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. |
parentObjectId |
(string) The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. |
The placeholder information that uniquely identifies a placeholder shape.
Placeholder object
Presentation Object
Presentation( presentationId = NULL, pageSize = NULL, slides = NULL, title = NULL, masters = NULL, layouts = NULL, locale = NULL, revisionId = NULL, notesMaster = NULL )Presentation( presentationId = NULL, pageSize = NULL, slides = NULL, title = NULL, masters = NULL, layouts = NULL, locale = NULL, revisionId = NULL, notesMaster = NULL )
presentationId |
(string) The ID of the presentation. |
pageSize |
(Size) The size of pages in the presentation. |
slides |
(list of Page objects) The slides in the presentation. A slide inherits properties from a slide layout. |
title |
(string) The title of the presentation. |
masters |
(list of Page objects) The slide masters in the presentation. A slide master contains all common page elements and the common properties for a set of layouts. They serve three purposes: - Placeholder shapes on a master contain the default text styles and shape properties of all placeholder shapes on pages that use that master. - The master page properties define the common page properties inherited by its layouts. - Any other shapes on the master slide appear on all slides using that master, regardless of their layout. |
layouts |
(list of Page objects) The layouts in the presentation. A layout is a template that determines how content is arranged and styled on the slides that inherit from that layout. |
locale |
(string) The locale of the presentation, as an IETF BCP 47 language tag. |
revisionId |
(string) Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but a nebulous string. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. |
notesMaster |
(Page)
The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a |
A Google Slides presentation.
Presentation object
Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies: the reply to the third request, and another empty reply, in that order. Because other users may be editing the presentation, the presentation might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the presentation should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.
presentations.batchUpdate(BatchUpdatePresentationRequest, presentationId)presentations.batchUpdate(BatchUpdatePresentationRequest, presentationId)
BatchUpdatePresentationRequest |
The BatchUpdatePresentationRequest object to pass to this method |
presentationId |
The presentation to apply the updates to |
If a presentationId is provided, it is used as the ID of the new
presentation. Otherwise, a new ID is generated. Other fields in the request,
including any provided content, are ignored. Returns the created presentation.
presentations.create(Presentation)presentations.create(Presentation)
Presentation |
The Presentation object to pass to this method |
Gets the latest version of the specified presentation.
presentations.get(presentationId)presentations.get(presentationId)
presentationId |
The ID of the presentation to retrieve |
Gets the latest version of the specified page in the presentation.
presentations.pages.get(presentationId, pageObjectId)presentations.pages.get(presentationId, pageObjectId)
presentationId |
The ID of the presentation to retrieve |
pageObjectId |
The object ID of the page to retrieve |
Generates a thumbnail of the latest version of the specified page in the presentation and returns a URL to the thumbnail image. This request counts as an expensive read request for quota purposes.
presentations.pages.getThumbnail( presentationId, pageObjectId, thumbnailProperties.thumbnailSize = NULL, thumbnailProperties.mimeType = NULL )presentations.pages.getThumbnail( presentationId, pageObjectId, thumbnailProperties.thumbnailSize = NULL, thumbnailProperties.mimeType = NULL )
presentationId |
The ID of the presentation to retrieve |
pageObjectId |
The object ID of the page whose thumbnail to retrieve |
thumbnailProperties.thumbnailSize |
The optional thumbnail image size |
thumbnailProperties.mimeType |
The optional mime type of the thumbnail image |
Range Object
Range(startIndex = NULL, endIndex = NULL, type = NULL)Range(startIndex = NULL, endIndex = NULL, type = NULL)
startIndex |
(integer)
The optional zero-based index of the beginning of the collection. Required for |
endIndex |
(integer)
The optional zero-based index of the end of the collection. Required for |
type |
(string) The type of range.
|
Specifies a contiguous range of an indexed collection, such as characters in text.
Range object
Recolor Object
Recolor(recolorStops = NULL, name = NULL)Recolor(recolorStops = NULL, name = NULL)
recolorStops |
(list of ColorStop objects) The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. |
name |
(string)
The name of the recolor effect. The name is determined from the
|
A recolor effect applied on an image.
Recolor object
RefreshSheetsChartRequest Object
RefreshSheetsChartRequest(objectId = NULL)RefreshSheetsChartRequest(objectId = NULL)
objectId |
(string) The object ID of the chart to refresh. |
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.
RefreshSheetsChartRequest object
ReplaceAllShapesWithImageRequest Object
ReplaceAllShapesWithImageRequest( containsText = NULL, imageUrl = NULL, replaceMethod = NULL, imageReplaceMethod = NULL, pageObjectIds = NULL )ReplaceAllShapesWithImageRequest( containsText = NULL, imageUrl = NULL, replaceMethod = NULL, imageReplaceMethod = NULL, pageObjectIds = NULL )
containsText |
(SubstringMatchCriteria) If set, this request will replace all of the shapes that contain the given text. |
imageUrl |
(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 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 Image.source_url field. |
replaceMethod |
(string)
The replace method. Deprecated: use
|
imageReplaceMethod |
(string)
The image replace method. If you specify both a
|
pageObjectIds |
(list of string objects) 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. |
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.
ReplaceAllShapesWithImageRequest object
ReplaceAllShapesWithImageResponse Object
ReplaceAllShapesWithImageResponse(occurrencesChanged = NULL)ReplaceAllShapesWithImageResponse(occurrencesChanged = NULL)
occurrencesChanged |
(integer) The number of shapes replaced with images. |
The result of replacing shapes with an image.
ReplaceAllShapesWithImageResponse object
ReplaceAllShapesWithSheetsChartRequest Object
ReplaceAllShapesWithSheetsChartRequest( containsText = NULL, spreadsheetId = NULL, chartId = NULL, linkingMode = NULL, pageObjectIds = NULL )ReplaceAllShapesWithSheetsChartRequest( containsText = NULL, spreadsheetId = NULL, chartId = NULL, linkingMode = NULL, pageObjectIds = NULL )
containsText |
(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 |
(string) 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 |
(list of string objects) 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. |
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.
ReplaceAllShapesWithSheetsChartRequest object
ReplaceAllShapesWithSheetsChartResponse Object
ReplaceAllShapesWithSheetsChartResponse(occurrencesChanged = NULL)ReplaceAllShapesWithSheetsChartResponse(occurrencesChanged = NULL)
occurrencesChanged |
(integer) The number of shapes replaced with charts. |
The result of replacing shapes with a Google Sheets chart.
ReplaceAllShapesWithSheetsChartResponse object
ReplaceAllTextRequest Object
ReplaceAllTextRequest( replaceText = NULL, pageObjectIds = NULL, containsText = NULL )ReplaceAllTextRequest( replaceText = NULL, pageObjectIds = NULL, containsText = NULL )
replaceText |
(string) The text that will replace the matched text. |
pageObjectIds |
(list of string objects) 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 master, or if a page with that object ID doesn't exist in the presentation. |
containsText |
(SubstringMatchCriteria) Finds text in a shape matching this substring. |
Replaces all instances of text matching a criteria with replace text.
ReplaceAllTextRequest object
ReplaceAllTextResponse Object
ReplaceAllTextResponse(occurrencesChanged = NULL)ReplaceAllTextResponse(occurrencesChanged = NULL)
occurrencesChanged |
(integer) The number of occurrences changed by replacing all text. |
The result of replacing text.
ReplaceAllTextResponse object
ReplaceImageRequest Object
ReplaceImageRequest( imageObjectId = NULL, url = NULL, imageReplaceMethod = NULL )ReplaceImageRequest( imageObjectId = NULL, url = NULL, imageReplaceMethod = NULL )
imageObjectId |
(string) The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request. |
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. |
imageReplaceMethod |
(string) The replacement method.
|
Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image.
ReplaceImageRequest object
Request Object
Request(...)Request(...)
createSlide |
(CreateSlideRequest) Creates a new slide. |
createShape |
(CreateShapeRequest) Creates a new shape. |
createTable |
(CreateTableRequest) Creates a new table. |
insertText |
(InsertTextRequest) Inserts text into a shape or table cell. |
insertTableRows |
(InsertTableRowsRequest) Inserts rows into a table. |
insertTableColumns |
(InsertTableColumnsRequest) Inserts columns into a table. |
deleteTableRow |
(DeleteTableRowRequest) Deletes a row from a table. |
deleteTableColumn |
(DeleteTableColumnRequest) Deletes a column from a table. |
replaceAllText |
(ReplaceAllTextRequest) Replaces all instances of specified text. |
deleteObject |
(DeleteObjectRequest) Deletes a page or page element from the presentation. |
updatePageElementTransform |
(UpdatePageElementTransformRequest) Updates the transform of a page element. |
updateSlidesPosition |
(UpdateSlidesPositionRequest) Updates the position of a set of slides in the presentation. |
deleteText |
(DeleteTextRequest) Deletes text from a shape or a table cell. |
createImage |
(CreateImageRequest) Creates an image. |
createVideo |
(CreateVideoRequest) Creates a video. |
createSheetsChart |
(CreateSheetsChartRequest) Creates an embedded Google Sheets chart. |
createLine |
(CreateLineRequest) Creates a line. |
refreshSheetsChart |
(RefreshSheetsChartRequest) Refreshes a Google Sheets chart. |
updateShapeProperties |
(UpdateShapePropertiesRequest) Updates the properties of a Shape. |
updateImageProperties |
(UpdateImagePropertiesRequest) Updates the properties of an Image. |
updateVideoProperties |
(UpdateVideoPropertiesRequest) Updates the properties of a Video. |
updatePageProperties |
(UpdatePagePropertiesRequest) Updates the properties of a Page. |
updateTableCellProperties |
(UpdateTableCellPropertiesRequest) Updates the properties of a TableCell. |
updateLineProperties |
(UpdateLinePropertiesRequest) Updates the properties of a Line. |
createParagraphBullets |
(CreateParagraphBulletsRequest) Creates bullets for paragraphs. |
replaceAllShapesWithImage |
(ReplaceAllShapesWithImageRequest) Replaces all shapes matching some criteria with an image. |
duplicateObject |
(DuplicateObjectRequest) Duplicates a slide or page element. |
updateTextStyle |
(UpdateTextStyleRequest) Updates the styling of text within a Shape or Table. |
replaceAllShapesWithSheetsChart |
(ReplaceAllShapesWithSheetsChartRequest) Replaces all shapes matching some criteria with a Google Sheets chart. |
deleteParagraphBullets |
(DeleteParagraphBulletsRequest) Deletes bullets from paragraphs. |
updateParagraphStyle |
(UpdateParagraphStyleRequest) Updates the styling of paragraphs within a Shape or Table. |
updateTableBorderProperties |
(UpdateTableBorderPropertiesRequest) Updates the properties of the table borders in a Table. |
updateTableColumnProperties |
(UpdateTableColumnPropertiesRequest) Updates the properties of a Table column. |
updateTableRowProperties |
(UpdateTableRowPropertiesRequest) Updates the properties of a Table row. |
mergeTableCells |
(MergeTableCellsRequest) Merges cells in a Table. |
unmergeTableCells |
(UnmergeTableCellsRequest) Unmerges cells in a Table. |
groupObjects |
(GroupObjectsRequest) Groups objects, such as page elements. |
ungroupObjects |
(UngroupObjectsRequest) Ungroups objects, such as groups. |
updatePageElementAltText |
(UpdatePageElementAltTextRequest) Updates the alt text title and/or description of a page element. |
replaceImage |
(ReplaceImageRequest) Replaces an existing image with a new image. |
updateSlideProperties |
(UpdateSlidePropertiesRequest) Updates the properties of a Slide |
updatePageElementsZOrder |
(UpdatePageElementsZOrderRequest) Updates the Z-order of page elements. |
updateLineCategory |
(UpdateLineCategoryRequest) Updates the category of a line. |
rerouteLine |
(RerouteLineRequest) Reroutes a line such that it's connected at the two closest connection sites on the connected page elements. |
A single kind of update to apply to a presentation.
Request object
RerouteLineRequest Object
RerouteLineRequest(objectId = NULL)RerouteLineRequest(objectId = NULL)
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. |
Reroutes a line such that it's connected at the two closest connection sites on the connected page elements.
RerouteLineRequest object
Response Object
Response( createSlide = NULL, createShape = NULL, createTable = NULL, replaceAllText = NULL, createImage = NULL, createVideo = NULL, createSheetsChart = NULL, createLine = NULL, replaceAllShapesWithImage = NULL, duplicateObject = NULL, replaceAllShapesWithSheetsChart = NULL, groupObjects = NULL )Response( createSlide = NULL, createShape = NULL, createTable = NULL, replaceAllText = NULL, createImage = NULL, createVideo = NULL, createSheetsChart = NULL, createLine = NULL, replaceAllShapesWithImage = NULL, duplicateObject = NULL, replaceAllShapesWithSheetsChart = NULL, groupObjects = NULL )
createSlide |
(CreateSlideResponse) The result of creating a slide. |
createShape |
(CreateShapeResponse) The result of creating a shape. |
createTable |
(CreateTableResponse) The result of creating a table. |
replaceAllText |
(ReplaceAllTextResponse) The result of replacing text. |
createImage |
(CreateImageResponse) The result of creating an image. |
createVideo |
(CreateVideoResponse) The result of creating a video. |
createSheetsChart |
(CreateSheetsChartResponse) The result of creating a Google Sheets chart. |
createLine |
(CreateLineResponse) The result of creating a line. |
replaceAllShapesWithImage |
(ReplaceAllShapesWithImageResponse) The result of replacing all shapes matching some criteria with an image. |
duplicateObject |
(DuplicateObjectResponse) The result of duplicating an object. |
replaceAllShapesWithSheetsChart |
(ReplaceAllShapesWithSheetsChartResponse) The result of replacing all shapes matching some criteria with a Google Sheets chart. |
groupObjects |
(GroupObjectsResponse) The result of grouping objects. |
A single response from an update.
Response object
RgbColor Object
RgbColor(red = NULL, green = NULL, blue = NULL)RgbColor(red = NULL, green = NULL, blue = NULL)
red |
(number) The red component of the color, from 0.0 to 1.0. |
green |
(number) The green component of the color, from 0.0 to 1.0. |
blue |
(number) The blue component of the color, from 0.0 to 1.0. |
An RGB color.
RgbColor object
Shadow Object
Shadow( type = NULL, transform = NULL, alignment = NULL, blurRadius = NULL, color = NULL, alpha = NULL, rotateWithShape = NULL, propertyState = NULL )Shadow( type = NULL, transform = NULL, alignment = NULL, blurRadius = NULL, color = NULL, alpha = NULL, rotateWithShape = NULL, propertyState = NULL )
type |
(string) The type of the shadow. This property is read-only.
|
transform |
(AffineTransform) Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. |
alignment |
(string) The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only.
|
blurRadius |
(Dimension) The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. |
color |
(OpaqueColor) The shadow color value. |
alpha |
(number) The alpha of the shadow's color, from 0.0 to 1.0. |
rotateWithShape |
(boolean) Whether the shadow should rotate with the shape. This property is read-only. |
propertyState |
(string)
The shadow property state. Updating the shadow on a page element will implicitly update this field to
|
The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind.
Shadow object
Shape Object
Shape( shapeType = NULL, text = NULL, shapeProperties = NULL, placeholder = NULL )Shape( shapeType = NULL, text = NULL, shapeProperties = NULL, placeholder = NULL )
shapeType |
(string) The type of the shape.
|
text |
(TextContent) The text content of the shape. |
shapeProperties |
(ShapeProperties) The properties of the shape. |
placeholder |
(Placeholder) Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the shape is a placeholder shape and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. |
A PageElement kind representing a generic shape that does not have a more specific classification.
Shape object
ShapeBackgroundFill Object
ShapeBackgroundFill(propertyState = NULL, solidFill = NULL)ShapeBackgroundFill(propertyState = NULL, solidFill = NULL)
propertyState |
(string)
The background fill property state. Updating the fill on a shape will implicitly update this field to
|
solidFill |
(SolidFill) Solid color fill. |
The shape background fill.
ShapeBackgroundFill object
ShapeProperties Object
ShapeProperties( shapeBackgroundFill = NULL, outline = NULL, shadow = NULL, link = NULL, contentAlignment = NULL, autofit = NULL )ShapeProperties( shapeBackgroundFill = NULL, outline = NULL, shadow = NULL, link = NULL, contentAlignment = NULL, autofit = NULL )
shapeBackgroundFill |
(ShapeBackgroundFill) The background fill of the shape. If unset, the background fill is inherited from a parent placeholder if it exists. If the shape has no parent, then the default background fill depends on the shape type, matching the defaults for new shapes created in the Slides editor. |
outline |
(Outline) The outline of the shape. If unset, the outline is inherited from a parent placeholder if it exists. If the shape has no parent, then the default outline depends on the shape type, matching the defaults for new shapes created in the Slides editor. |
shadow |
(Shadow) The shadow properties of the shape. If unset, the shadow is inherited from a parent placeholder if it exists. If the shape has no parent, then the default shadow matches the defaults for new shapes created in the Slides editor. This property is read-only. |
link |
(Link) The hyperlink destination of the shape. If unset, there is no link. Links are not inherited from parent placeholders. |
contentAlignment |
(string) The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor.
|
autofit |
(Autofit) The autofit properties of the shape. This property is only set for shapes that allow text. |
The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value. Any text autofit settings on the shape are automatically deactivated by requests that can impact how text fits in the shape.
ShapeProperties object
SheetsChart Object
SheetsChart( spreadsheetId = NULL, chartId = NULL, contentUrl = NULL, sheetsChartProperties = NULL )SheetsChart( spreadsheetId = NULL, chartId = NULL, contentUrl = NULL, sheetsChartProperties = NULL )
spreadsheetId |
(string) The ID of the Google Sheets spreadsheet that contains the source chart. |
chartId |
(integer) The ID of the specific chart in the Google Sheets spreadsheet that is embedded. |
contentUrl |
(string) The URL of an image of the embedded chart, with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. |
sheetsChartProperties |
(SheetsChartProperties) The properties of the Sheets chart. |
A PageElement kind representing a linked chart embedded from Google Sheets.
SheetsChart object
SheetsChartProperties Object
SheetsChartProperties(chartImageProperties = NULL)SheetsChartProperties(chartImageProperties = NULL)
chartImageProperties |
(ImageProperties) The properties of the embedded chart image. |
The properties of the SheetsChart.
SheetsChartProperties object
Size Object
Size(width = NULL, height = NULL)Size(width = NULL, height = NULL)
width |
(Dimension) The width of the object. |
height |
(Dimension) The height of the object. |
A width and height.
Size object
SlideProperties Object
SlideProperties( layoutObjectId = NULL, masterObjectId = NULL, notesPage = NULL, isSkipped = NULL )SlideProperties( layoutObjectId = NULL, masterObjectId = NULL, notesPage = NULL, isSkipped = NULL )
layoutObjectId |
(string) The object ID of the layout that this slide is based on. This property is read-only. |
masterObjectId |
(string) The object ID of the master that this slide is based on. This property is read-only. |
notesPage |
(Page) The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. |
isSkipped |
(boolean) Whether the slide is skipped in the presentation mode. Defaults to false. |
The properties of Page that are only relevant for pages with page_type SLIDE.
SlideProperties object
SolidFill Object
SolidFill(color = NULL, alpha = NULL)SolidFill(color = NULL, alpha = NULL)
color |
(OpaqueColor) The color value of the solid fill. |
alpha |
(number)
The fraction of this
|
A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists.
SolidFill object
SpeakerSpotlight Object
SpeakerSpotlight(speakerSpotlightProperties = NULL)SpeakerSpotlight(speakerSpotlightProperties = NULL)
speakerSpotlightProperties |
(SpeakerSpotlightProperties) The properties of the Speaker Spotlight. |
A PageElement kind representing a Speaker Spotlight.
SpeakerSpotlight object
SpeakerSpotlightProperties Object
SpeakerSpotlightProperties(outline = NULL, shadow = NULL)SpeakerSpotlightProperties(outline = NULL, shadow = NULL)
outline |
(Outline) The outline of the Speaker Spotlight. If not set, it has no outline. |
shadow |
(Shadow) The shadow of the Speaker Spotlight. If not set, it has no shadow. |
The properties of the SpeakerSpotlight.
SpeakerSpotlightProperties object
StretchedPictureFill Object
StretchedPictureFill(contentUrl = NULL, size = NULL)StretchedPictureFill(contentUrl = NULL, size = NULL)
contentUrl |
(string) Reading the content_url: An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change. Writing the content_url: The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. |
size |
(Size) The original size of the picture fill. This field is read-only. |
The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container.
StretchedPictureFill object
SubstringMatchCriteria Object
SubstringMatchCriteria(text = NULL, matchCase = NULL)SubstringMatchCriteria(text = NULL, matchCase = NULL)
text |
(string) The text to search for in the shape or table. |
matchCase |
(boolean)
Indicates whether the search should respect case: - |
A criteria that matches a specific string of text in a shape or table.
SubstringMatchCriteria object
Table Object
Table( rows = NULL, columns = NULL, tableRows = NULL, tableColumns = NULL, horizontalBorderRows = NULL, verticalBorderRows = NULL )Table( rows = NULL, columns = NULL, tableRows = NULL, tableColumns = NULL, horizontalBorderRows = NULL, verticalBorderRows = NULL )
rows |
(integer) Number of rows in the table. |
columns |
(integer) Number of columns in the table. |
tableRows |
(list of TableRow objects) Properties and contents of each row. Cells that span multiple rows are contained in only one of these rows and have a row_span greater than 1. |
tableColumns |
(list of TableColumnProperties objects) Properties of each column. |
horizontalBorderRows |
(list of TableBorderRow objects) Properties of horizontal cell borders. A table's horizontal cell borders are represented as a grid. The grid has one more row than the number of rows in the table and the same number of columns as the table. For example, if the table is 3 x 3, its horizontal borders will be represented as a grid with 4 rows and 3 columns. |
verticalBorderRows |
(list of TableBorderRow objects) Properties of vertical cell borders. A table's vertical cell borders are represented as a grid. The grid has the same number of rows as the table and one more column than the number of columns in the table. For example, if the table is 3 x 3, its vertical borders will be represented as a grid with 3 rows and 4 columns. |
A PageElement kind representing a table.
Table object
TableBorderCell Object
TableBorderCell(location = NULL, tableBorderProperties = NULL)TableBorderCell(location = NULL, tableBorderProperties = NULL)
location |
(TableCellLocation) The location of the border within the border table. |
tableBorderProperties |
(TableBorderProperties) The border properties. |
The properties of each border cell.
TableBorderCell object
TableBorderFill Object
TableBorderFill(solidFill = NULL)TableBorderFill(solidFill = NULL)
solidFill |
(SolidFill) Solid fill. |
The fill of the border.
TableBorderFill object
TableBorderProperties Object
TableBorderProperties(tableBorderFill = NULL, weight = NULL, dashStyle = NULL)TableBorderProperties(tableBorderFill = NULL, weight = NULL, dashStyle = NULL)
tableBorderFill |
(TableBorderFill) The fill of the table border. |
weight |
(Dimension) The thickness of the border. |
dashStyle |
(string) The dash style of the border.
|
The border styling properties of the TableBorderCell.
TableBorderProperties object
TableBorderRow Object
TableBorderRow(tableBorderCells = NULL)TableBorderRow(tableBorderCells = NULL)
tableBorderCells |
(list of TableBorderCell objects) Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. |
Contents of each border row in a table.
TableBorderRow object
TableCell Object
TableCell( location = NULL, rowSpan = NULL, columnSpan = NULL, text = NULL, tableCellProperties = NULL )TableCell( location = NULL, rowSpan = NULL, columnSpan = NULL, text = NULL, tableCellProperties = NULL )
location |
(TableCellLocation) The location of the cell within the table. |
rowSpan |
(integer) Row span of the cell. |
columnSpan |
(integer) Column span of the cell. |
text |
(TextContent) The text content of the cell. |
tableCellProperties |
(TableCellProperties) The properties of the table cell. |
Properties and contents of each table cell.
TableCell object
TableCellBackgroundFill Object
TableCellBackgroundFill(propertyState = NULL, solidFill = NULL)TableCellBackgroundFill(propertyState = NULL, solidFill = NULL)
propertyState |
(string)
The background fill property state. Updating the fill on a table cell will implicitly update this field to
|
solidFill |
(SolidFill) Solid color fill. |
The table cell background fill.
TableCellBackgroundFill object
TableCellLocation Object
TableCellLocation(rowIndex = NULL, columnIndex = NULL)TableCellLocation(rowIndex = NULL, columnIndex = NULL)
rowIndex |
(integer) The 0-based row index. |
columnIndex |
(integer) The 0-based column index. |
A location of a single table cell within a table.
TableCellLocation object
TableCellProperties Object
TableCellProperties(tableCellBackgroundFill = NULL, contentAlignment = NULL)TableCellProperties(tableCellBackgroundFill = NULL, contentAlignment = NULL)
tableCellBackgroundFill |
(TableCellBackgroundFill) The background fill of the table cell. The default fill matches the fill for newly created table cells in the Slides editor. |
contentAlignment |
(string) The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Slides editor.
|
The properties of the TableCell.
TableCellProperties object
TableColumnProperties Object
TableColumnProperties(columnWidth = NULL)TableColumnProperties(columnWidth = NULL)
columnWidth |
(Dimension) Width of a column. |
Properties of each column in a table.
TableColumnProperties object
TableRange Object
TableRange(location = NULL, rowSpan = NULL, columnSpan = NULL)TableRange(location = NULL, rowSpan = NULL, columnSpan = NULL)
location |
(TableCellLocation) The starting location of the table range. |
rowSpan |
(integer) The row span of the table range. |
columnSpan |
(integer) The column span of the table range. |
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 ]
TableRange object
TableRow Object
TableRow(rowHeight = NULL, tableRowProperties = NULL, tableCells = NULL)TableRow(rowHeight = NULL, tableRowProperties = NULL, tableCells = NULL)
rowHeight |
(Dimension) Height of a row. |
tableRowProperties |
(TableRowProperties) Properties of the row. |
tableCells |
(list of TableCell objects) Properties and contents of each cell. Cells that span multiple columns are represented only once with a column_span greater than 1. As a result, the length of this collection does not always match the number of columns of the entire table. |
Properties and contents of each row in a table.
TableRow object
TableRowProperties Object
TableRowProperties(minRowHeight = NULL)TableRowProperties(minRowHeight = NULL)
minRowHeight |
(Dimension) Minimum height of the row. The row will be rendered in the Slides editor at a height equal to or greater than this value in order to show all the text in the row's cell(s). |
Properties of each row in a table.
TableRowProperties object
TextContent Object
TextContent(textElements = NULL, lists = NULL)TextContent(textElements = NULL, lists = NULL)
textElements |
(list of TextElement objects) The text contents broken down into its component parts, including styling information. This property is read-only. |
lists |
(named list of List objects) The bulleted lists contained in this text, keyed by list ID. |
The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page.
TextContent object
TextElement Object
TextElement( startIndex = NULL, endIndex = NULL, paragraphMarker = NULL, textRun = NULL, autoText = NULL )TextElement( startIndex = NULL, endIndex = NULL, paragraphMarker = NULL, textRun = NULL, autoText = NULL )
startIndex |
(integer) The zero-based start index of this text element, in Unicode code units. |
endIndex |
(integer) The zero-based end index of this text element, exclusive, in Unicode code units. |
paragraphMarker |
(ParagraphMarker)
A marker representing the beginning of a new paragraph. The |
textRun |
(TextRun)
A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The |
autoText |
(AutoText) A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. |
A TextElement describes the content of a range of indices in the text content of a Shape or TableCell.
TextElement object
TextRun Object
TextRun(content = NULL, style = NULL)TextRun(content = NULL, style = NULL)
content |
(string) The text of this run. |
style |
(TextStyle) The styling applied to this run. |
A TextElement kind that represents a run of text that all has the same styling.
TextRun object
TextStyle Object
TextStyle( backgroundColor = NULL, foregroundColor = NULL, bold = NULL, italic = NULL, fontFamily = NULL, fontSize = NULL, link = NULL, baselineOffset = NULL, smallCaps = NULL, strikethrough = NULL, underline = NULL, weightedFontFamily = NULL )TextStyle( backgroundColor = NULL, foregroundColor = NULL, bold = NULL, italic = NULL, fontFamily = NULL, fontSize = NULL, link = NULL, baselineOffset = NULL, smallCaps = NULL, strikethrough = NULL, underline = NULL, weightedFontFamily = NULL )
backgroundColor |
(OptionalColor)
The background color of the text. If set, the color is either opaque or transparent, depending on if the |
foregroundColor |
(OptionalColor)
The color of the text itself. If set, the color is either opaque or transparent, depending on if the |
bold |
(boolean) Whether or not the text is rendered as bold. |
italic |
(boolean) Whether or not the text is italicized. |
fontFamily |
(string)
The font family of the text. The font family can be any font from the Font menu in Slides or from Google Fonts. If the font name is unrecognized, the text is rendered in |
fontSize |
(Dimension)
The size of the text's font. When read, the |
link |
(Link) The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range:
|
baselineOffset |
(string)
The text's vertical offset from its normal position. Text with
|
smallCaps |
(boolean) Whether or not the text is in small capital letters. |
strikethrough |
(boolean) Whether or not the text is struck through. |
underline |
(boolean) Whether or not the text is underlined. |
weightedFontFamily |
(WeightedFontFamily)
The font family and rendered weight of the text. This field is an extension of
|
Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists:
A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder.
A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor.
TextStyle object
ThemeColorPair Object
ThemeColorPair(type = NULL, color = NULL)ThemeColorPair(type = NULL, color = NULL)
type |
(string) The type of the theme color.
|
color |
(RgbColor) The concrete color corresponding to the theme color type above. |
A pair mapping a theme color type to the concrete color it represents.
ThemeColorPair object
Thumbnail Object
Thumbnail(width = NULL, height = NULL, contentUrl = NULL)Thumbnail(width = NULL, height = NULL, contentUrl = NULL)
width |
(integer) The positive width in pixels of the thumbnail image. |
height |
(integer) The positive height in pixels of the thumbnail image. |
contentUrl |
(string)
The content URL of the thumbnail image. The URL to the image has a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. The mime type of the thumbnail image is the same as specified in the |
The thumbnail of a page.
Thumbnail object
UngroupObjectsRequest Object
UngroupObjectsRequest(objectIds = NULL)UngroupObjectsRequest(objectIds = NULL)
objectIds |
(list of string objects) 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. |
Ungroups objects, such as groups.
UngroupObjectsRequest object
UnmergeTableCellsRequest Object
UnmergeTableCellsRequest(objectId = NULL, tableRange = NULL)UnmergeTableCellsRequest(objectId = NULL, tableRange = NULL)
objectId |
(string) The object ID of the table. |
tableRange |
(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. |
Unmerges cells in a Table.
UnmergeTableCellsRequest object
UpdateImagePropertiesRequest Object
UpdateImagePropertiesRequest( objectId = NULL, imageProperties = NULL, fields = NULL )UpdateImagePropertiesRequest( objectId = NULL, imageProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the image the updates are applied to. |
imageProperties |
(ImageProperties) The image properties to update. |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Update the properties of an Image.
UpdateImagePropertiesRequest object
UpdateLineCategoryRequest Object
UpdateLineCategoryRequest(objectId = NULL, lineCategory = NULL)UpdateLineCategoryRequest(objectId = NULL, lineCategory = NULL)
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 |
(string) 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.
|
Updates the category of a line.
UpdateLineCategoryRequest object
UpdateLinePropertiesRequest Object
UpdateLinePropertiesRequest( objectId = NULL, lineProperties = NULL, fields = NULL )UpdateLinePropertiesRequest( objectId = NULL, lineProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the line the update is applied to. |
lineProperties |
(LineProperties) The line properties to update. |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Updates the properties of a Line.
UpdateLinePropertiesRequest object
UpdatePageElementAltTextRequest Object
UpdatePageElementAltTextRequest( objectId = NULL, title = NULL, description = NULL )UpdatePageElementAltTextRequest( objectId = NULL, title = NULL, description = NULL )
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. |
Updates the alt text title and/or description of a page element.
UpdatePageElementAltTextRequest object
UpdatePageElementsZOrderRequest Object
UpdatePageElementsZOrderRequest(pageElementObjectIds = NULL, operation = NULL)UpdatePageElementsZOrderRequest(pageElementObjectIds = NULL, operation = NULL)
pageElementObjectIds |
(list of string objects) 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 |
(string) 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.
|
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.
UpdatePageElementsZOrderRequest object
UpdatePageElementTransformRequest Object
UpdatePageElementTransformRequest( objectId = NULL, transform = NULL, applyMode = NULL )UpdatePageElementTransformRequest( objectId = NULL, transform = NULL, applyMode = NULL )
objectId |
(string) The object ID of the page element to update. |
transform |
(AffineTransform) The input transform matrix used to update the page element. |
applyMode |
(string) The apply mode of the transform update.
|
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.
UpdatePageElementTransformRequest object
UpdatePagePropertiesRequest Object
UpdatePagePropertiesRequest( objectId = NULL, pageProperties = NULL, fields = NULL )UpdatePagePropertiesRequest( objectId = NULL, pageProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the page the update is applied to. |
pageProperties |
(PageProperties) The page properties to update. |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Updates the properties of a Page.
UpdatePagePropertiesRequest object
UpdateParagraphStyleRequest Object
UpdateParagraphStyleRequest( objectId = NULL, cellLocation = NULL, style = NULL, textRange = NULL, fields = NULL )UpdateParagraphStyleRequest( objectId = NULL, cellLocation = NULL, style = NULL, textRange = NULL, fields = NULL )
objectId |
(string) The object ID of the shape or table with the text to be styled. |
cellLocation |
(TableCellLocation)
The location of the cell in the table containing the paragraph(s) to style. If |
style |
(ParagraphStyle) The paragraph's style. |
textRange |
(Range) The range of text containing the paragraph(s) to style. |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Updates the styling for all of the paragraphs within a Shape or Table that overlap with the given text index range.
UpdateParagraphStyleRequest object
UpdateShapePropertiesRequest Object
UpdateShapePropertiesRequest( objectId = NULL, shapeProperties = NULL, fields = NULL )UpdateShapePropertiesRequest( objectId = NULL, shapeProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the shape the updates are applied to. |
shapeProperties |
(ShapeProperties) The shape properties to update. |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Update the properties of a Shape.
UpdateShapePropertiesRequest object
UpdateSlidePropertiesRequest Object
UpdateSlidePropertiesRequest( objectId = NULL, slideProperties = NULL, fields = NULL )UpdateSlidePropertiesRequest( objectId = NULL, slideProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the slide the update is applied to. |
slideProperties |
(SlideProperties) The slide properties to update. |
fields |
(string)
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 |
Updates the properties of a Slide.
UpdateSlidePropertiesRequest object
UpdateSlidesPositionRequest Object
UpdateSlidesPositionRequest(slideObjectIds = NULL, insertionIndex = NULL)UpdateSlidesPositionRequest(slideObjectIds = NULL, insertionIndex = NULL)
slideObjectIds |
(list of string objects) 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 |
(integer) 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. |
Updates the position of slides in the presentation.
UpdateSlidesPositionRequest object
UpdateTableBorderPropertiesRequest Object
UpdateTableBorderPropertiesRequest( objectId = NULL, tableRange = NULL, borderPosition = NULL, tableBorderProperties = NULL, fields = NULL )UpdateTableBorderPropertiesRequest( objectId = NULL, tableRange = NULL, borderPosition = NULL, tableBorderProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the table. |
tableRange |
(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 |
(string) 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 |
(TableBorderProperties) The table border properties to update. |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Updates the properties of the table borders in a Table.
UpdateTableBorderPropertiesRequest object
UpdateTableCellPropertiesRequest Object
UpdateTableCellPropertiesRequest( objectId = NULL, tableRange = NULL, tableCellProperties = NULL, fields = NULL )UpdateTableCellPropertiesRequest( objectId = NULL, tableRange = NULL, tableCellProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the table. |
tableRange |
(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 |
(TableCellProperties) The table cell properties to update. |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Update the properties of a TableCell.
UpdateTableCellPropertiesRequest object
UpdateTableColumnPropertiesRequest Object
UpdateTableColumnPropertiesRequest( objectId = NULL, columnIndices = NULL, tableColumnProperties = NULL, fields = NULL )UpdateTableColumnPropertiesRequest( objectId = NULL, columnIndices = NULL, tableColumnProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the table. |
columnIndices |
(list of integer objects) 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 |
(TableColumnProperties)
The table column properties to update. If the value of |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Updates the properties of a Table column.
UpdateTableColumnPropertiesRequest object
UpdateTableRowPropertiesRequest Object
UpdateTableRowPropertiesRequest( objectId = NULL, rowIndices = NULL, tableRowProperties = NULL, fields = NULL )UpdateTableRowPropertiesRequest( objectId = NULL, rowIndices = NULL, tableRowProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the table. |
rowIndices |
(list of integer objects) 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 |
(TableRowProperties) The table row properties to update. |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Updates the properties of a Table row.
UpdateTableRowPropertiesRequest object
UpdateTextStyleRequest Object
UpdateTextStyleRequest( objectId = NULL, cellLocation = NULL, style = NULL, textRange = NULL, fields = NULL )UpdateTextStyleRequest( objectId = NULL, cellLocation = NULL, style = NULL, textRange = NULL, fields = NULL )
objectId |
(string) The object ID of the shape or table with the text to be styled. |
cellLocation |
(TableCellLocation)
The location of the cell in the table containing the text to style. If |
style |
(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 |
(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)
The fields that should be updated. At least one field must be specified. The root |
Update the styling of text in a Shape or Table.
UpdateTextStyleRequest object
UpdateVideoPropertiesRequest Object
UpdateVideoPropertiesRequest( objectId = NULL, videoProperties = NULL, fields = NULL )UpdateVideoPropertiesRequest( objectId = NULL, videoProperties = NULL, fields = NULL )
objectId |
(string) The object ID of the video the updates are applied to. |
videoProperties |
(VideoProperties) The video properties to update. |
fields |
(string)
The fields that should be updated. At least one field must be specified. The root |
Update the properties of a Video.
UpdateVideoPropertiesRequest object
Video Object
Video(url = NULL, source = NULL, id = NULL, videoProperties = NULL)Video(url = NULL, source = NULL, id = NULL, videoProperties = NULL)
url |
(string) An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change. |
source |
(string) The video source.
|
id |
(string) The video source's unique identifier for this video. |
videoProperties |
(VideoProperties) The properties of the video. |
A PageElement kind representing a video.
Video object
VideoProperties Object
VideoProperties( outline = NULL, autoPlay = NULL, start = NULL, end = NULL, mute = NULL )VideoProperties( outline = NULL, autoPlay = NULL, start = NULL, end = NULL, mute = NULL )
outline |
(Outline) The outline of the video. The default outline matches the defaults for new videos created in the Slides editor. |
autoPlay |
(boolean) Whether to enable video autoplay when the page is displayed in present mode. Defaults to false. |
start |
(integer) The time at which to start playback, measured in seconds from the beginning of the video. If set, the start time should be before the end time. If you set this to a value that exceeds the video's length in seconds, the video will be played from the last second. If not set, the video will be played from the beginning. |
end |
(integer) The time at which to end playback, measured in seconds from the beginning of the video. If set, the end time should be after the start time. If not set or if you set this to a value that exceeds the video's length, the video will be played until its end. |
mute |
(boolean) Whether to mute the audio during video playback. Defaults to false. |
The properties of the Video.
VideoProperties object
WeightedFontFamily Object
WeightedFontFamily(fontFamily = NULL, weight = NULL)WeightedFontFamily(fontFamily = NULL, weight = NULL)
fontFamily |
(string)
The font family of the text. The font family can be any font from the Font menu in Slides or from Google Fonts. If the font name is unrecognized, the text is rendered in |
weight |
(integer)
The rendered weight of the text. This field can have any value that is a multiple of |
Represents a font family and weight used to style a TextRun.
WeightedFontFamily object
WordArt Object
WordArt(renderedText = NULL)WordArt(renderedText = NULL)
renderedText |
(string) The text rendered as word art. |
A PageElement kind representing word art.
WordArt object
WriteControl Object
WriteControl(requiredRevisionId = NULL)WriteControl(requiredRevisionId = NULL)
requiredRevisionId |
(string) The revision ID of the presentation required for the write request. If specified and the required revision ID doesn't match the presentation's current revision ID, the request is not processed and returns a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied. |
Provides control over how write requests are executed.
WriteControl object