API Reference google_api_slides v0.24.0

View Source

Modules

API client metadata for GoogleApi.Slides.V1.

API calls for all endpoints tagged Presentations.

Handle Tesla connections for GoogleApi.Slides.V1.

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.

A TextElement kind that represents auto text.

The autofit properties of a Shape. This property is only set for shapes that allow text.

Request message for PresentationsService.BatchUpdatePresentation.

Response message from a batch update.

Describes the bullet of a paragraph.

The palette of predefined colors for a page.

A color and position in a gradient band.

The result of creating an image.

The result of creating a line.

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.

The result of creating a shape.

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.

The result of creating an embedded Google Sheets chart.

The result of creating a slide.

The result of creating a table.

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.

The result of creating a video.

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.

Deletes an object, either pages or page elements, from the presentation.

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.

Deletes text from a shape or a table cell.

A magnitude in a single direction in the specified units.

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.

The response of duplicating an object.

A PageElement kind representing a joined collection of PageElements.

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

The result of grouping objects.

A PageElement kind representing an image.

The properties of the Image.

Inserts columns into a table. Other columns in the table will be resized to fit the new column.

Inserts text into a shape or a table cell.

The user-specified ID mapping for a placeholder that will be created on a slide from a specified layout.

The properties of Page are only relevant for pages with page_type LAYOUT.

Slide layout reference. This may reference either: - A predefined layout - One of the layouts in the presentation.

A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector.

The properties for one end of a Line connection.

The fill of the line.

The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor.

A hypertext link.

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.

The properties of Page that are only relevant for pages with page_type MASTER.

Contains properties describing the look and feel of a list bullet at a given level of nesting.

The properties of Page that are only relevant for pages with page_type NOTES.

A themeable solid color value.

A color that can either be fully opaque or fully transparent.

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.

The fill of the outline.

A page in a presentation.

A visual element rendered on a page.

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.

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.

A TextElement kind that represents the beginning of a new 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.

The placeholder information that uniquely identifies a placeholder shape.

A Google Slides presentation.

Specifies a contiguous range of an indexed collection, such as characters in text.

A recolor effect applied on an image.

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.

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.

The result of replacing shapes with an image.

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.

The result of replacing shapes with a Google Sheets chart.

Replaces all instances of text matching a criteria with replace text.

The result of replacing text.

Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image.

A single kind of update to apply to a presentation.

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

A single response from an update.

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.

A PageElement kind representing a generic shape that doesn't have a more specific classification. For more information, see Size and position page elements.

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.

A PageElement kind representing a linked chart embedded from Google Sheets.

The properties of the SheetsChart.

A width and height.

The properties of Page that are only relevant for pages with page_type SLIDE.

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.

A PageElement kind representing a Speaker Spotlight.

The properties of the SpeakerSpotlight.

The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container.

A criteria that matches a specific string of text in a shape or table.

A PageElement kind representing a table.

The properties of each border cell.

The border styling properties of the TableBorderCell.

Contents of each border row in a table.

Properties and contents of each table cell.

The table cell background fill.

A location of a single table cell within a table.

The properties of the TableCell.

Properties of each column in a table.

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 ]

Properties and contents of each row in a table.

Properties of each row in a table.

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.

A TextElement describes the content of a range of indices in the text content of a Shape or TableCell.

A TextElement kind that represents a run of text that all has the same styling.

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.

A pair mapping a theme color type to the concrete color it represents.

The thumbnail of a page.

Ungroups objects, such as groups.

Update the properties of an Image.

Updates the category of a line.

Updates the properties of a Line.

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

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.

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.

Updates the properties of a Page.

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

Update the properties of a Shape.

Updates the properties of a Slide.

Updates the position of slides in the presentation.

Updates the properties of the table borders in a Table.

Update the properties of a TableCell.

Updates the properties of a Table column.

Updates the properties of a Table row.

Update the styling of text in a Shape or Table.

Update the properties of a Video.

A PageElement kind representing a video.

The properties of the Video.

Represents a font family and weight used to style a TextRun.

A PageElement kind representing word art.

Provides control over how write requests are executed.