googleapis.slides
Module googleapis.slides
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_googleapis.slides_1.4.0.png)
ballerinax/googleapis.slides Ballerina library
Overview
This is a generated connector for Google Slides API v1 OpenAPI specification. Reads and writes Google Slides presentations.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Google account
- Obtain tokens - Follow this link
Quickstart
To use the Google Slides connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
Import the ballerinax/googleapis.slides module into the Ballerina project.
import ballerinax/googleapis.slides as slides;
Step 2: Create a new connector instance
You can now enter the credentials in the Google Slides client configuration and create Google Slides client by passing the configuration:
slides:ClientConfig clientConfig = { auth: { clientId: <CLIENT_ID>, clientSecret: <CLIENT_SECRET>, refreshUrl: <REFRESH_URL>, refreshToken: <REFRESH_TOKEN> } }; slides:Client baseClient = check new Client(clientConfig);
Step 3: Invoke connector operation
-
You can create a presentation as follows with
createPresentation
method by passing aPresentation
record as parameter.slides:Presentation createPayload = { "title": "Sample Presentation" }; slides:Presentation presentation = check baseClient->createPresentation(createPayload);
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
googleapis.slides: Client![](/images/permalink.svg)
This is a generated connector for Google Slides API v1 OpenAPI specification. Reads and writes Google Slides presentations.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Google account and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://slides.googleapis.com/" - URL of the target service
createPresentation![](/images/permalink.svg)
function createPresentation(Presentation payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Presentation|error
Creates a blank presentation using the title given in the request. 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.
Parameters
- payload Presentation - A record of type
Presentation
which contains the necessary data to create a presentation
- xgafv string? (default ()) - V1 error format
- alt string? (default ()) - Data format for response
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart")
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart")
Return Type
- Presentation|error - Successful response
getPresentation![](/images/permalink.svg)
function getPresentation(string presentationId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Presentation|error
Gets the latest version of the specified presentation.
Parameters
- presentationId string - The ID of the presentation to retrieve
- xgafv string? (default ()) - V1 error format
- alt string? (default ()) - Data format for response
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart")
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart")
Return Type
- Presentation|error - Successful response
getPresentationPage![](/images/permalink.svg)
function getPresentationPage(string presentationId, string pageObjectId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Page|error
Gets the latest version of the specified page in the presentation.
Parameters
- presentationId string - The ID of the presentation to retrieve
- pageObjectId string - The object ID of the page to retrieve
- xgafv string? (default ()) - V1 error format
- alt string? (default ()) - Data format for response
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart")
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart")
getPresentationPageThumbnail![](/images/permalink.svg)
function getPresentationPageThumbnail(string presentationId, string pageObjectId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? thumbnailpropertiesMimetype, string? thumbnailpropertiesThumbnailsize) returns Thumbnail|error
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.
Parameters
- presentationId string - The ID of the presentation to retrieve
- pageObjectId string - The object ID of the page whose thumbnail to retrieve
- xgafv string? (default ()) - V1 error format
- alt string? (default ()) - Data format for response
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart")
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart")
- thumbnailpropertiesMimetype string? (default ()) - The optional mime type of the thumbnail image. If you don't specify the mime type, the mime type defaults to PNG
- thumbnailpropertiesThumbnailsize string? (default ()) - The optional thumbnail image size. If you don't specify the size, the server chooses a default size of the image
batchUpdatePresentations![](/images/permalink.svg)
function batchUpdatePresentations(string presentationId, BatchUpdatePresentationRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns BatchUpdatePresentationResponse|error
Applies one or more updates to the presentation. 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.
Parameters
- presentationId string - The presentation to apply the updates to
- payload BatchUpdatePresentationRequest - A record of type
BatchUpdatePresentationRequest
which contains the necessary data to make one or more updates to the presentation
- xgafv string? (default ()) - V1 error format
- alt string? (default ()) - Data format for response
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart")
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart")
Return Type
- BatchUpdatePresentationResponse|error - Successful response
Records![](/images/permalink.svg)
googleapis.slides: AffineTransform![](/images/permalink.svg)
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.
Fields
- scaleX decimal? - The X coordinate scaling element.
- scaleY decimal? - The Y coordinate scaling element.
- shearX decimal? - The X coordinate shearing element.
- shearY decimal? - The Y coordinate shearing element.
- translateX decimal? - The X coordinate translation element.
- translateY decimal? - The Y coordinate translation element.
- unit string? - The units for translate elements.
googleapis.slides: Autofit![](/images/permalink.svg)
The autofit properties of a Shape.
Fields
- 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 float? - 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 float? - 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.
googleapis.slides: AutoText![](/images/permalink.svg)
A TextElement kind that represents auto text.
Fields
- content string? - The rendered content of this auto text, if available.
- style TextStyle? - 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.
- 'type string? - The type of this auto text.
googleapis.slides: BatchUpdatePresentationRequest![](/images/permalink.svg)
Request message for PresentationsService.BatchUpdatePresentation.
Fields
- requests Request[]? - A list of updates to apply to the presentation.
- writeControl WriteControl? - Provides control over how write requests are executed.
googleapis.slides: BatchUpdatePresentationResponse![](/images/permalink.svg)
Response message from a batch update.
Fields
- presentationId string? - The presentation the updates were applied to.
- replies Response[]? - The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.
- writeControl WriteControl? - Provides control over how write requests are executed.
googleapis.slides: Bullet![](/images/permalink.svg)
Describes the bullet of a paragraph.
Fields
- bulletStyle TextStyle? - 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.
- glyph string? - The rendered bullet glyph for this paragraph.
- listId string? - The ID of the list this paragraph belongs to.
- nestingLevel int? - The nesting level of this paragraph in the list.
googleapis.slides: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
googleapis.slides: ColorScheme![](/images/permalink.svg)
The palette of predefined colors for a page.
Fields
- colors ThemeColorPair[]? - The ThemeColorType and corresponding concrete color pairs.
googleapis.slides: ColorStop![](/images/permalink.svg)
A color and position in a gradient band.
Fields
- alpha float? - The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque.
- color OpaqueColor? - A themeable solid color value.
- position float? - 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].
googleapis.slides: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
googleapis.slides: CreateImageRequest![](/images/permalink.svg)
Creates an image.
Fields
- elementProperties PageElementProperties? - Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both
size
andtransform
, but the visual size will be unchanged.
- 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
[a-zA-Z0-9_]
); remaining characters may include those as well as a hyphen or colon (matches regex[a-zA-Z0-9_-:]
). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.
- 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 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.
googleapis.slides: CreateImageResponse![](/images/permalink.svg)
The result of creating an image.
Fields
- objectId string? - The object ID of the created image.
googleapis.slides: CreateLineRequest![](/images/permalink.svg)
Creates a line.
Fields
- 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
category
and aline_category
, thecategory
takes precedence. If you do not specify a value forcategory
, but specify a value forline_category
, then the specifiedline_category
value is used. If you do not specify either, then STRAIGHT is used.
- elementProperties PageElementProperties? - Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both
size
andtransform
, but the visual size will be unchanged.
- lineCategory string? - The category of the line to be created. Deprecated: use
category
instead. 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 acategory
and aline_category
, thecategory
takes precedence.
- 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
[a-zA-Z0-9_]
); remaining characters may include those as well as a hyphen or colon (matches regex[a-zA-Z0-9_-:]
). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.
googleapis.slides: CreateLineResponse![](/images/permalink.svg)
The result of creating a line.
Fields
- objectId string? - The object ID of the created line.
googleapis.slides: CreateParagraphBulletsRequest![](/images/permalink.svg)
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.
Fields
- bulletPreset string? - The kinds of bullet glyphs to be used. Defaults to the
BULLET_DISC_CIRCLE_SQUARE
preset.
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- objectId string? - The object ID of the shape or table containing the text to add bullets to.
- textRange Range? - Specifies a contiguous range of an indexed collection, such as characters in text.
googleapis.slides: CreateShapeRequest![](/images/permalink.svg)
Creates a new shape.
Fields
- elementProperties PageElementProperties? - Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both
size
andtransform
, but the visual size will be unchanged.
- 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
[a-zA-Z0-9_]
); remaining characters may include those as well as a hyphen or colon (matches regex[a-zA-Z0-9_-:]
). The length of the ID must not be less than 5 or greater than 50. If empty, a unique identifier will be generated.
- shapeType string? - The shape type.
googleapis.slides: CreateShapeResponse![](/images/permalink.svg)
The result of creating a shape.
Fields
- objectId string? - The object ID of the created shape.
googleapis.slides: CreateSheetsChartRequest![](/images/permalink.svg)
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.
Fields
- chartId int? - The ID of the specific chart in the Google Sheets spreadsheet.
- elementProperties PageElementProperties? - Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both
size
andtransform
, but the visual size will be unchanged.
- 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.
- 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.
- 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.
googleapis.slides: CreateSheetsChartResponse![](/images/permalink.svg)
The result of creating an embedded Google Sheets chart.
Fields
- objectId string? - The object ID of the created chart.
googleapis.slides: CreateSlideRequest![](/images/permalink.svg)
Creates a new slide.
Fields
- insertionIndex int? - The optional zero-based index indicating where to insert the slides. If you don't specify an index, the new slide is created at the end.
- 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
[a-zA-Z0-9_]
); remaining characters may include those as well as a hyphen or colon (matches regex[a-zA-Z0-9_-:]
). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.
- placeholderIdMappings LayoutPlaceholderIdMapping[]? - An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s) that will be created on the new slide from that specified layout. Can only be used when
slide_layout_reference
is specified.
- slideLayoutReference LayoutReference? - Slide layout reference. This may reference either: - A predefined layout - One of the layouts in the presentation.
googleapis.slides: CreateSlideResponse![](/images/permalink.svg)
The result of creating a slide.
Fields
- objectId string? - The object ID of the created slide.
googleapis.slides: CreateTableRequest![](/images/permalink.svg)
Creates a new table.
Fields
- columns int? - Number of columns in the table.
- elementProperties PageElementProperties? - Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both
size
andtransform
, but the visual size will be unchanged.
- 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
[a-zA-Z0-9_]
); remaining characters may include those as well as a hyphen or colon (matches regex[a-zA-Z0-9_-:]
). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.
- rows int? - Number of rows in the table.
googleapis.slides: CreateTableResponse![](/images/permalink.svg)
The result of creating a table.
Fields
- objectId string? - The object ID of the created table.
googleapis.slides: CreateVideoRequest![](/images/permalink.svg)
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.
Fields
- elementProperties PageElementProperties? - Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both
size
andtransform
, but the visual size will be unchanged.
- 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.
- 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
[a-zA-Z0-9_]
); remaining characters may include those as well as a hyphen or colon (matches regex[a-zA-Z0-9_-:]
). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.
- 'source string? - The video source.
googleapis.slides: CreateVideoResponse![](/images/permalink.svg)
The result of creating a video.
Fields
- objectId string? - The object ID of the created video.
googleapis.slides: CropProperties![](/images/permalink.svg)
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.
Fields
- angle float? - The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset.
- bottomOffset float? - 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.
- leftOffset float? - 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 float? - 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 float? - 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.
googleapis.slides: DeleteObjectRequest![](/images/permalink.svg)
Deletes an object, either pages or page elements, from the presentation.
Fields
- 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.
googleapis.slides: DeleteParagraphBulletsRequest![](/images/permalink.svg)
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.
Fields
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- objectId string? - The object ID of the shape or table containing the text to delete bullets from.
- textRange Range? - Specifies a contiguous range of an indexed collection, such as characters in text.
googleapis.slides: DeleteTableColumnRequest![](/images/permalink.svg)
Deletes a column from a table.
Fields
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- tableObjectId string? - The table to delete columns from.
googleapis.slides: DeleteTableRowRequest![](/images/permalink.svg)
Deletes a row from a table.
Fields
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- tableObjectId string? - The table to delete rows from.
googleapis.slides: DeleteTextRequest![](/images/permalink.svg)
Deletes text from a shape or a table cell.
Fields
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- objectId string? - The object ID of the shape or table from which the text will be deleted.
- textRange Range? - Specifies a contiguous range of an indexed collection, such as characters in text.
googleapis.slides: Dimension![](/images/permalink.svg)
A magnitude in a single direction in the specified units.
Fields
- magnitude decimal? - The magnitude.
- unit string? - The units for magnitude.
googleapis.slides: DuplicateObjectRequest![](/images/permalink.svg)
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.
Fields
- objectId string? - The ID of the object to duplicate.
- objectIds record {}? - 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
object_id
field as a key and the newly desired ID as the value. All keys must correspond to existing IDs in the presentation. All values must be unique in the presentation and must start with an alphanumeric character or an underscore (matches regex[a-zA-Z0-9_]
); remaining characters may include those as well as a hyphen or colon (matches regex[a-zA-Z0-9_-:]
). The length of the new ID must not be less than 5 or greater than 50. If any IDs of source objects are omitted from the map, a new random ID will be assigned. If the map is empty or unset, all duplicate objects will receive a new random ID.
googleapis.slides: DuplicateObjectResponse![](/images/permalink.svg)
The response of duplicating an object.
Fields
- objectId string? - The ID of the new duplicate object.
googleapis.slides: Group![](/images/permalink.svg)
A PageElement kind representing a joined collection of PageElements.
Fields
- children PageElement[]? - The collection of elements in the group. The minimum size of a group is 2.
googleapis.slides: GroupObjectsRequest![](/images/permalink.svg)
Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.
Fields
- childrenObjectIds string[]? - The object IDs of the objects to group. Only page elements can be grouped. There should be at least two page elements on the same page that are not already in another group. Some page elements, such as videos, tables and placeholders cannot be grouped.
- groupObjectId string? - A user-supplied object ID for the group to be created. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex
[a-zA-Z0-9_]
); remaining characters may include those as well as a hyphen or colon (matches regex[a-zA-Z0-9_-:]
). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.
googleapis.slides: GroupObjectsResponse![](/images/permalink.svg)
The result of grouping objects.
Fields
- objectId string? - The object ID of the created group.
googleapis.slides: Image![](/images/permalink.svg)
A PageElement kind representing an image.
Fields
- 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.
googleapis.slides: ImageProperties![](/images/permalink.svg)
The properties of the Image.
Fields
- brightness float? - 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 float? - 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.
- cropProperties CropProperties? - 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.
- link Link? - A hypertext link.
- outline Outline? - 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.
- recolor Recolor? - A recolor effect applied on an image.
- shadow Shadow? - 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.
- transparency float? - 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.
googleapis.slides: InsertTableColumnsRequest![](/images/permalink.svg)
Inserts columns into a table. Other columns in the table will be resized to fit the new column.
Fields
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- insertRight boolean? - Whether to insert new columns to the right of the reference cell location. -
True
: insert to the right. -False
: insert to the left.
- number int? - The number of columns to be inserted. Maximum 20 per request.
- tableObjectId string? - The table to insert columns into.
googleapis.slides: InsertTableRowsRequest![](/images/permalink.svg)
Inserts rows into a table.
Fields
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- insertBelow boolean? - Whether to insert new rows below the reference cell location. -
True
: insert below the cell. -False
: insert above the cell.
- number int? - The number of rows to be inserted. Maximum 20 per request.
- tableObjectId string? - The table to insert rows into.
googleapis.slides: InsertTextRequest![](/images/permalink.svg)
Inserts text into a shape or a table cell.
Fields
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- insertionIndex int? - 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.
- objectId string? - The object ID of the shape or table where the text will be inserted.
- 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.
googleapis.slides: LayoutPlaceholderIdMapping![](/images/permalink.svg)
The user-specified ID mapping for a placeholder that will be created on a slide from a specified layout.
Fields
- layoutPlaceholder Placeholder? - The placeholder information that uniquely identifies a placeholder shape.
- 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
[a-zA-Z0-9_]
); remaining characters may include those as well as a hyphen or colon (matches regex[a-zA-Z0-9_-:]
). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.
googleapis.slides: LayoutProperties![](/images/permalink.svg)
The properties of Page are only relevant for pages with page_type LAYOUT.
Fields
- displayName string? - The human-readable name of the layout.
- masterObjectId string? - The object ID of the master that this layout is based on.
- name string? - The name of the layout.
googleapis.slides: LayoutReference![](/images/permalink.svg)
Slide layout reference. This may reference either: - A predefined layout - One of the layouts in the presentation.
Fields
- layoutId string? - Layout ID: the object ID of one of the layouts in the presentation.
- predefinedLayout string? - Predefined layout.
googleapis.slides: Line![](/images/permalink.svg)
A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector.
Fields
- lineCategory string? - The category of the line. It matches the
category
specified in CreateLineRequest, and can be updated with UpdateLineCategoryRequest.
- lineProperties LineProperties? - The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor.
- lineType string? - The type of the line.
googleapis.slides: LineConnection![](/images/permalink.svg)
The properties for one end of a Line connection.
Fields
- 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 int? - 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] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor.
googleapis.slides: LineFill![](/images/permalink.svg)
The fill of the line.
Fields
- solidFill SolidFill? - 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.
googleapis.slides: LineProperties![](/images/permalink.svg)
The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor.
Fields
- dashStyle string? - The dash style of the line.
- endArrow string? - The style of the arrow at the end of the line.
- endConnection LineConnection? - The properties for one end of a Line connection.
- lineFill LineFill? - The fill of the line.
- link Link? - A hypertext link.
- startArrow string? - The style of the arrow at the beginning of the line.
- startConnection LineConnection? - The properties for one end of a Line connection.
- weight Dimension? - A magnitude in a single direction in the specified units.
googleapis.slides: Link![](/images/permalink.svg)
A hypertext link.
Fields
- 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.
- relativeLink string? - If set, indicates this is a link to a slide in this presentation, addressed by its position.
- slideIndex int? - 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.
- url string? - If set, indicates this is a link to the external web page at this URL.
googleapis.slides: List![](/images/permalink.svg)
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.
Fields
- listId string? - The ID of the list.
- nestingLevel record {}? - 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.
googleapis.slides: MasterProperties![](/images/permalink.svg)
The properties of Page that are only relevant for pages with page_type MASTER.
Fields
- displayName string? - The human-readable name of the master.
googleapis.slides: MergeTableCellsRequest![](/images/permalink.svg)
Merges cells in a Table.
Fields
- objectId string? - The object ID of the table.
- tableRange TableRange? - A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with location = (0, 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ]
googleapis.slides: NestingLevel![](/images/permalink.svg)
Contains properties describing the look and feel of a list bullet at a given level of nesting.
Fields
- bulletStyle TextStyle? - 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.
googleapis.slides: NotesProperties![](/images/permalink.svg)
The properties of Page that are only relevant for pages with page_type NOTES.
Fields
- 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
GetPresentation
orGetPage
action will always return the latest object ID.
googleapis.slides: OAuth2RefreshTokenGrantConfig![](/images/permalink.svg)
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL
googleapis.slides: OpaqueColor![](/images/permalink.svg)
A themeable solid color value.
Fields
- rgbColor RgbColor? - An RGB color.
- themeColor string? - An opaque theme color.
googleapis.slides: OptionalColor![](/images/permalink.svg)
A color that can either be fully opaque or fully transparent.
Fields
- opaqueColor OpaqueColor? - A themeable solid color value.
googleapis.slides: Outline![](/images/permalink.svg)
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.
Fields
- dashStyle string? - The dash style of the outline.
- outlineFill OutlineFill? - The fill of the outline.
- propertyState string? - The outline property state. Updating the outline on a page element will implicitly update this field to
RENDERED
, unless another value is specified in the same request. To have no outline on a page element, set this field toNOT_RENDERED
. In this case, any other outline fields set in the same request will be ignored.
- weight Dimension? - A magnitude in a single direction in the specified units.
googleapis.slides: OutlineFill![](/images/permalink.svg)
The fill of the outline.
Fields
- solidFill SolidFill? - 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.
googleapis.slides: Page![](/images/permalink.svg)
A page in a presentation.
Fields
- layoutProperties LayoutProperties? - The properties of Page are only relevant for pages with page_type LAYOUT.
- masterProperties MasterProperties? - The properties of Page that are only relevant for pages with page_type MASTER.
- notesProperties NotesProperties? - The properties of Page that are only relevant for pages with page_type NOTES.
- objectId string? - The object ID for this page. Object IDs used by Page and PageElement share the same namespace.
- pageElements PageElement[]? - The page elements rendered on the page.
- pageProperties PageProperties? - 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.
- pageType string? - The type of the page.
- revisionId string? - The revision ID of the presentation containing this page. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. 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.
- slideProperties SlideProperties? - The properties of Page that are only relevant for pages with page_type SLIDE.
googleapis.slides: PageBackgroundFill![](/images/permalink.svg)
The page background fill.
Fields
- propertyState string? - The background fill property state. Updating the fill on a page will implicitly update this field to
RENDERED
, unless another value is specified in the same request. To have no fill on a page, set this field toNOT_RENDERED
. In this case, any other fill fields set in the same request will be ignored.
- solidFill SolidFill? - 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.
- stretchedPictureFill StretchedPictureFill? - The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container.
googleapis.slides: PageElement![](/images/permalink.svg)
A visual element rendered on a page.
Fields
- 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 PageElement kind representing a joined collection of PageElements.
- image Image? - A PageElement kind representing an image.
- line Line? - A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector.
- 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.
- shape Shape? - A PageElement kind representing a generic shape that does not have a more specific classification.
- sheetsChart SheetsChart? - A PageElement kind representing a linked chart embedded from Google Sheets.
- size Size? - A width and height.
- 'table Table? - A PageElement kind representing a table.
- title string? - The title of the page element. Combined with description to display alt text. The field is not supported for Group elements.
- transform AffineTransform? - 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.
- video Video? - A PageElement kind representing a video.
- wordArt WordArt? - A PageElement kind representing word art.
googleapis.slides: PageElementProperties![](/images/permalink.svg)
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.
Fields
- pageObjectId string? - The object ID of the page where the element is located.
- size Size? - A width and height.
- transform AffineTransform? - 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.
googleapis.slides: PageProperties![](/images/permalink.svg)
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.
Fields
- colorScheme ColorScheme? - The palette of predefined colors for a page.
- pageBackgroundFill PageBackgroundFill? - The page background fill.
googleapis.slides: ParagraphMarker![](/images/permalink.svg)
A TextElement kind that represents the beginning of a new paragraph.
Fields
- bullet Bullet? - Describes the bullet of a paragraph.
- style ParagraphStyle? - 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.
googleapis.slides: ParagraphStyle![](/images/permalink.svg)
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.
Fields
- alignment string? - The text alignment for this paragraph.
- direction string? - The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited.
- indentEnd Dimension? - A magnitude in a single direction in the specified units.
- indentFirstLine Dimension? - A magnitude in a single direction in the specified units.
- indentStart Dimension? - A magnitude in a single direction in the specified units.
- lineSpacing float? - 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.
- spaceAbove Dimension? - A magnitude in a single direction in the specified units.
- spaceBelow Dimension? - A magnitude in a single direction in the specified units.
- spacingMode string? - The spacing mode for the paragraph.
googleapis.slides: Placeholder![](/images/permalink.svg)
The placeholder information that uniquely identifies a placeholder shape.
Fields
- index int? - 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.
- 'type string? - The type of the placeholder.
googleapis.slides: Presentation![](/images/permalink.svg)
A Google Slides presentation.
Fields
- layouts Page[]? - 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.
- masters Page[]? - 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.
- notesMaster Page? - A page in a presentation.
- pageSize Size? - A width and height.
- presentationId string? - The ID of the presentation.
- revisionId string? - The revision ID of the presentation. Can be used in update requests to assert that the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. 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.
- slides Page[]? - The slides in the presentation. A slide inherits properties from a slide layout.
- title string? - The title of the presentation.
googleapis.slides: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
googleapis.slides: Range![](/images/permalink.svg)
Specifies a contiguous range of an indexed collection, such as characters in text.
Fields
- endIndex int? - The optional zero-based index of the end of the collection. Required for
FIXED_RANGE
ranges.
- startIndex int? - The optional zero-based index of the beginning of the collection. Required for
FIXED_RANGE
andFROM_START_INDEX
ranges.
- 'type string? - The type of range.
googleapis.slides: Recolor![](/images/permalink.svg)
A recolor effect applied on an image.
Fields
- name string? - The name of the recolor effect. The name is determined from the
recolor_stops
by matching the gradient against the colors in the page's current color scheme. This property is read-only.
- recolorStops ColorStop[]? - 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.
googleapis.slides: RefreshSheetsChartRequest![](/images/permalink.svg)
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.
Fields
- objectId string? - The object ID of the chart to refresh.
googleapis.slides: ReplaceAllShapesWithImageRequest![](/images/permalink.svg)
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.
Fields
- containsText SubstringMatchCriteria? - A criteria that matches a specific string of text in a shape or table.
- imageReplaceMethod string? - The image replace method. If you specify both a
replace_method
and animage_replace_method
, theimage_replace_method
takes precedence. If you do not specify a value forimage_replace_method
, but specify a value forreplace_method
, then the specifiedreplace_method
value is used. If you do not specify either, then CENTER_INSIDE is used.
- 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.
- pageObjectIds string[]? - If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation.
- replaceMethod string? - The replace method. Deprecated: use
image_replace_method
instead. If you specify both areplace_method
and animage_replace_method
, theimage_replace_method
takes precedence.
googleapis.slides: ReplaceAllShapesWithImageResponse![](/images/permalink.svg)
The result of replacing shapes with an image.
Fields
- occurrencesChanged int? - The number of shapes replaced with images.
googleapis.slides: ReplaceAllShapesWithSheetsChartRequest![](/images/permalink.svg)
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.
Fields
- chartId int? - The ID of the specific chart in the Google Sheets spreadsheet.
- containsText SubstringMatchCriteria? - A criteria that matches a specific string of text in a shape or table.
- 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 string[]? - If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes page or a notes master, or if a page with that object ID doesn't exist in the presentation.
- spreadsheetId string? - The ID of the Google Sheets spreadsheet that contains the chart.
googleapis.slides: ReplaceAllShapesWithSheetsChartResponse![](/images/permalink.svg)
The result of replacing shapes with a Google Sheets chart.
Fields
- occurrencesChanged int? - The number of shapes replaced with charts.
googleapis.slides: ReplaceAllTextRequest![](/images/permalink.svg)
Replaces all instances of text matching a criteria with replace text.
Fields
- containsText SubstringMatchCriteria? - A criteria that matches a specific string of text in a shape or table.
- pageObjectIds string[]? - If non-empty, limits the matches to page elements only on the given pages. Returns a 400 bad request error if given the page object ID of a notes master, or if a page with that object ID doesn't exist in the presentation.
- replaceText string? - The text that will replace the matched text.
googleapis.slides: ReplaceAllTextResponse![](/images/permalink.svg)
The result of replacing text.
Fields
- occurrencesChanged int? - The number of occurrences changed by replacing all text.
googleapis.slides: ReplaceImageRequest![](/images/permalink.svg)
Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image.
Fields
- imageObjectId string? - The ID of the existing image that will be replaced.
- imageReplaceMethod string? - The replacement method.
- 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 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.
googleapis.slides: Request![](/images/permalink.svg)
A single kind of update to apply to a presentation.
Fields
- createImage CreateImageRequest? - Creates an image.
- createLine CreateLineRequest? - Creates a line.
- createParagraphBullets CreateParagraphBulletsRequest? - Creates bullets for all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list.
- createShape CreateShapeRequest? - Creates a new shape.
- createSheetsChart CreateSheetsChartRequest? - Creates an embedded Google Sheets chart. NOTE: Chart creation requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, drive.file, or drive OAuth scopes.
- createSlide CreateSlideRequest? - Creates a new slide.
- createTable CreateTableRequest? - Creates a new table.
- createVideo CreateVideoRequest? - Creates a video. NOTE: Creating a video from Google Drive requires that the requesting app have at least one of the drive, drive.readonly, or drive.file OAuth scopes.
- deleteObject DeleteObjectRequest? - Deletes an object, either pages or page elements, from the presentation.
- deleteParagraphBullets DeleteParagraphBulletsRequest? - Deletes bullets from all of the paragraphs that overlap with the given text index range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph.
- deleteTableColumn DeleteTableColumnRequest? - Deletes a column from a table.
- deleteTableRow DeleteTableRowRequest? - Deletes a row from a table.
- deleteText DeleteTextRequest? - Deletes text from a shape or a table cell.
- duplicateObject DuplicateObjectRequest? - Duplicates a slide or page element. When duplicating a slide, the duplicate slide will be created immediately following the specified slide. When duplicating a page element, the duplicate will be placed on the same page at the same position as the original.
- groupObjects GroupObjectsRequest? - Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.
- insertTableColumns InsertTableColumnsRequest? - Inserts columns into a table. Other columns in the table will be resized to fit the new column.
- insertTableRows InsertTableRowsRequest? - Inserts rows into a table.
- insertText InsertTextRequest? - Inserts text into a shape or a table cell.
- mergeTableCells MergeTableCellsRequest? - Merges cells in a Table.
- refreshSheetsChart RefreshSheetsChartRequest? - Refreshes an embedded Google Sheets chart by replacing it with the latest version of the chart from Google Sheets. NOTE: Refreshing charts requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.
- replaceAllShapesWithImage ReplaceAllShapesWithImageRequest? - Replaces all shapes that match the given criteria with the provided image. The images replacing the shapes are rectangular after being inserted into the presentation and do not take on the forms of the shapes.
- replaceAllShapesWithSheetsChart ReplaceAllShapesWithSheetsChartRequest? - Replaces all shapes that match the given criteria with the provided Google Sheets chart. The chart will be scaled and centered to fit within the bounds of the original shape. NOTE: Replacing shapes with a chart requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.
- replaceAllText ReplaceAllTextRequest? - Replaces all instances of text matching a criteria with replace text.
- replaceImage ReplaceImageRequest? - Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image.
- rerouteLine RerouteLineRequest? - Reroutes a line such that it's connected at the two closest connection sites on the connected page elements.
- ungroupObjects UngroupObjectsRequest? - Ungroups objects, such as groups.
- unmergeTableCells UnmergeTableCellsRequest? - Unmerges cells in a Table.
- updateImageProperties UpdateImagePropertiesRequest? - Update the properties of an Image.
- updateLineCategory UpdateLineCategoryRequest? - Updates the category of a line.
- updateLineProperties UpdateLinePropertiesRequest? - Updates the properties of a Line.
- updatePageElementAltText UpdatePageElementAltTextRequest? - Updates the alt text title and/or description of a page element.
- updatePageElementTransform UpdatePageElementTransformRequest? - Updates the transform of a page element. Updating the transform of a group will change the absolute transform of the page elements in that group, which can change their visual appearance. See the documentation for PageElement.transform for more details.
- updatePageElementsZOrder UpdatePageElementsZOrderRequest? - Updates the Z-order of page elements. Z-order is an ordering of the elements on the page from back to front. The page element in the front may cover the elements that are behind it.
- updatePageProperties UpdatePagePropertiesRequest? - Updates the properties of a Page.
- updateParagraphStyle UpdateParagraphStyleRequest? - Updates the styling for all of the paragraphs within a Shape or Table that overlap with the given text index range.
- updateShapeProperties UpdateShapePropertiesRequest? - Update the properties of a Shape.
- updateSlideProperties UpdateSlidePropertiesRequest? - Updates the properties of a Slide.
- updateSlidesPosition UpdateSlidesPositionRequest? - Updates the position of slides in the presentation.
- updateTableBorderProperties UpdateTableBorderPropertiesRequest? - Updates the properties of the table borders in a Table.
- updateTableCellProperties UpdateTableCellPropertiesRequest? - Update the properties of a TableCell.
- updateTableColumnProperties UpdateTableColumnPropertiesRequest? - Updates the properties of a Table column.
- updateTableRowProperties UpdateTableRowPropertiesRequest? - Updates the properties of a Table row.
- updateTextStyle UpdateTextStyleRequest? - Update the styling of text in a Shape or Table.
- updateVideoProperties UpdateVideoPropertiesRequest? - Update the properties of a Video.
googleapis.slides: RerouteLineRequest![](/images/permalink.svg)
Reroutes a line such that it's connected at the two closest connection sites on the connected page elements.
Fields
- objectId string? - The object ID of the line to reroute. Only a line with a category indicating it is a "connector" can be rerouted. The start and end connections of the line must be on different page elements.
googleapis.slides: Response![](/images/permalink.svg)
A single response from an update.
Fields
- createImage CreateImageResponse? - The result of creating an image.
- createLine CreateLineResponse? - The result of creating a line.
- createShape CreateShapeResponse? - The result of creating a shape.
- createSheetsChart CreateSheetsChartResponse? - The result of creating an embedded Google Sheets chart.
- createSlide CreateSlideResponse? - The result of creating a slide.
- createTable CreateTableResponse? - The result of creating a table.
- createVideo CreateVideoResponse? - The result of creating a video.
- duplicateObject DuplicateObjectResponse? - The response of duplicating an object.
- groupObjects GroupObjectsResponse? - The result of grouping objects.
- replaceAllShapesWithImage ReplaceAllShapesWithImageResponse? - The result of replacing shapes with an image.
- replaceAllShapesWithSheetsChart ReplaceAllShapesWithSheetsChartResponse? - The result of replacing shapes with a Google Sheets chart.
- replaceAllText ReplaceAllTextResponse? - The result of replacing text.
googleapis.slides: RgbColor![](/images/permalink.svg)
An RGB color.
Fields
- blue float? - The blue component of the color, from 0.0 to 1.0.
- green float? - The green component of the color, from 0.0 to 1.0.
- red float? - The red component of the color, from 0.0 to 1.0.
googleapis.slides: Shadow![](/images/permalink.svg)
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.
Fields
- 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.
- alpha float? - The alpha of the shadow's color, from 0.0 to 1.0.
- blurRadius Dimension? - A magnitude in a single direction in the specified units.
- color OpaqueColor? - A themeable solid color value.
- propertyState string? - The shadow property state. Updating the shadow on a page element will implicitly update this field to
RENDERED
, unless another value is specified in the same request. To have no shadow on a page element, set this field toNOT_RENDERED
. In this case, any other shadow fields set in the same request will be ignored.
- rotateWithShape boolean? - Whether the shadow should rotate with the shape. This property is read-only.
- transform AffineTransform? - 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.
- 'type string? - The type of the shadow. This property is read-only.
googleapis.slides: Shape![](/images/permalink.svg)
A PageElement kind representing a generic shape that does not have a more specific classification.
Fields
- placeholder Placeholder? - The placeholder information that uniquely identifies a placeholder shape.
- shapeProperties ShapeProperties? - 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.
- shapeType string? - The type of the shape.
- text TextContent? - 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.
googleapis.slides: ShapeBackgroundFill![](/images/permalink.svg)
The shape background fill.
Fields
- propertyState string? - The background fill property state. Updating the fill on a shape will implicitly update this field to
RENDERED
, unless another value is specified in the same request. To have no fill on a shape, set this field toNOT_RENDERED
. In this case, any other fill fields set in the same request will be ignored.
- solidFill SolidFill? - 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.
googleapis.slides: ShapeProperties![](/images/permalink.svg)
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.
Fields
- autofit Autofit? - The autofit properties of a Shape.
- 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.
- link Link? - A hypertext link.
- outline Outline? - 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.
- shadow Shadow? - 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.
- shapeBackgroundFill ShapeBackgroundFill? - The shape background fill.
googleapis.slides: SheetsChart![](/images/permalink.svg)
A PageElement kind representing a linked chart embedded from Google Sheets.
Fields
- chartId int? - 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 SheetsChart.
- spreadsheetId string? - The ID of the Google Sheets spreadsheet that contains the source chart.
googleapis.slides: SheetsChartProperties![](/images/permalink.svg)
The properties of the SheetsChart.
Fields
- chartImageProperties ImageProperties? - The properties of the Image.
googleapis.slides: Size![](/images/permalink.svg)
A width and height.
Fields
- height Dimension? - A magnitude in a single direction in the specified units.
- width Dimension? - A magnitude in a single direction in the specified units.
googleapis.slides: SlideProperties![](/images/permalink.svg)
The properties of Page that are only relevant for pages with page_type SLIDE.
Fields
- isSkipped boolean? - Whether the slide is skipped in the presentation mode. Defaults to false.
- 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? - A page in a presentation.
googleapis.slides: SolidFill![](/images/permalink.svg)
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.
Fields
- alpha float? - The fraction of this
color
that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color.
- color OpaqueColor? - A themeable solid color value.
googleapis.slides: StretchedPictureFill![](/images/permalink.svg)
The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container.
Fields
- 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? - A width and height.
googleapis.slides: SubstringMatchCriteria![](/images/permalink.svg)
A criteria that matches a specific string of text in a shape or table.
Fields
- matchCase boolean? - Indicates whether the search should respect case: -
True
: the search is case sensitive. -False
: the search is case insensitive.
- text string? - The text to search for in the shape or table.
googleapis.slides: Table![](/images/permalink.svg)
A PageElement kind representing a table.
Fields
- columns int? - Number of columns in the table.
- horizontalBorderRows TableBorderRow[]? - 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.
- rows int? - Number of rows in the table.
- tableColumns TableColumnProperties[]? - Properties of each column.
- tableRows TableRow[]? - 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.
- verticalBorderRows TableBorderRow[]? - 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.
googleapis.slides: TableBorderCell![](/images/permalink.svg)
The properties of each border cell.
Fields
- location TableCellLocation? - A location of a single table cell within a table.
- tableBorderProperties TableBorderProperties? - The border styling properties of the TableBorderCell.
googleapis.slides: TableBorderFill![](/images/permalink.svg)
The fill of the border.
Fields
- solidFill SolidFill? - 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.
googleapis.slides: TableBorderProperties![](/images/permalink.svg)
The border styling properties of the TableBorderCell.
Fields
- dashStyle string? - The dash style of the border.
- tableBorderFill TableBorderFill? - The fill of the border.
- weight Dimension? - A magnitude in a single direction in the specified units.
googleapis.slides: TableBorderRow![](/images/permalink.svg)
Contents of each border row in a table.
Fields
- tableBorderCells TableBorderCell[]? - Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response.
googleapis.slides: TableCell![](/images/permalink.svg)
Properties and contents of each table cell.
Fields
- columnSpan int? - Column span of the cell.
- location TableCellLocation? - A location of a single table cell within a table.
- rowSpan int? - Row span of the cell.
- tableCellProperties TableCellProperties? - The properties of the TableCell.
- text TextContent? - 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.
googleapis.slides: TableCellBackgroundFill![](/images/permalink.svg)
The table cell background fill.
Fields
- propertyState string? - The background fill property state. Updating the fill on a table cell will implicitly update this field to
RENDERED
, unless another value is specified in the same request. To have no fill on a table cell, set this field toNOT_RENDERED
. In this case, any other fill fields set in the same request will be ignored.
- solidFill SolidFill? - 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.
googleapis.slides: TableCellLocation![](/images/permalink.svg)
A location of a single table cell within a table.
Fields
- columnIndex int? - The 0-based column index.
- rowIndex int? - The 0-based row index.
googleapis.slides: TableCellProperties![](/images/permalink.svg)
The properties of the TableCell.
Fields
- 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.
- tableCellBackgroundFill TableCellBackgroundFill? - The table cell background fill.
googleapis.slides: TableColumnProperties![](/images/permalink.svg)
Properties of each column in a table.
Fields
- columnWidth Dimension? - A magnitude in a single direction in the specified units.
googleapis.slides: TableRange![](/images/permalink.svg)
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 ]
Fields
- columnSpan int? - The column span of the table range.
- location TableCellLocation? - A location of a single table cell within a table.
- rowSpan int? - The row span of the table range.
googleapis.slides: TableRow![](/images/permalink.svg)
Properties and contents of each row in a table.
Fields
- rowHeight Dimension? - A magnitude in a single direction in the specified units.
- tableCells TableCell[]? - 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.
- tableRowProperties TableRowProperties? - Properties of each row in a table.
googleapis.slides: TableRowProperties![](/images/permalink.svg)
Properties of each row in a table.
Fields
- minRowHeight Dimension? - A magnitude in a single direction in the specified units.
googleapis.slides: TextContent![](/images/permalink.svg)
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.
Fields
- lists record {}? - The bulleted lists contained in this text, keyed by list ID.
- textElements TextElement[]? - The text contents broken down into its component parts, including styling information. This property is read-only.
googleapis.slides: TextElement![](/images/permalink.svg)
A TextElement describes the content of a range of indices in the text content of a Shape or TableCell.
Fields
- autoText AutoText? - A TextElement kind that represents auto text.
- endIndex int? - The zero-based end index of this text element, exclusive, in Unicode code units.
- paragraphMarker ParagraphMarker? - A TextElement kind that represents the beginning of a new paragraph.
- startIndex int? - The zero-based start index of this text element, in Unicode code units.
- textRun TextRun? - A TextElement kind that represents a run of text that all has the same styling.
googleapis.slides: TextRun![](/images/permalink.svg)
A TextElement kind that represents a run of text that all has the same styling.
Fields
- content string? - The text of this run.
- style TextStyle? - 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.
googleapis.slides: TextStyle![](/images/permalink.svg)
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.
Fields
- backgroundColor OptionalColor? - A color that can either be fully opaque or fully transparent.
- baselineOffset string? - The text's vertical offset from its normal position. Text with
SUPERSCRIPT
orSUBSCRIPT
baseline offsets is automatically rendered in a smaller font size, computed based on thefont_size
field. Thefont_size
itself is not affected by changes in this field.
- bold boolean? - Whether or not the text is rendered as bold.
- 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] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in
Arial
. Some fonts can affect the weight of the text. If an update request specifies values for bothfont_family
andbold
, the explicitly-setbold
value is used.
- fontSize Dimension? - A magnitude in a single direction in the specified units.
- foregroundColor OptionalColor? - A color that can either be fully opaque or fully transparent.
- italic boolean? - Whether or not the text is italicized.
- link Link? - A hypertext link.
- 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? - Represents a font family and weight used to style a TextRun.
googleapis.slides: ThemeColorPair![](/images/permalink.svg)
A pair mapping a theme color type to the concrete color it represents.
Fields
- color RgbColor? - An RGB color.
- 'type string? - The type of the theme color.
googleapis.slides: Thumbnail![](/images/permalink.svg)
The thumbnail of a page.
Fields
- 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
GetPageThumbnailRequest
.
- height int? - The positive height in pixels of the thumbnail image.
- width int? - The positive width in pixels of the thumbnail image.
googleapis.slides: UngroupObjectsRequest![](/images/permalink.svg)
Ungroups objects, such as groups.
Fields
- objectIds string[]? - The object IDs of the objects to ungroup. Only groups that are not inside other groups can be ungrouped. All the groups should be on the same page. The group itself is deleted. The visual sizes and positions of all the children are preserved.
googleapis.slides: UnmergeTableCellsRequest![](/images/permalink.svg)
Unmerges cells in a Table.
Fields
- objectId string? - The object ID of the table.
- tableRange TableRange? - A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with location = (0, 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ]
googleapis.slides: UpdateImagePropertiesRequest![](/images/permalink.svg)
Update the properties of an Image.
Fields
- fields string? - The fields that should be updated. At least one field must be specified. The root
imageProperties
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example to update the image outline color, setfields
to"outline.outlineFill.solidFill.color"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- imageProperties ImageProperties? - The properties of the Image.
- objectId string? - The object ID of the image the updates are applied to.
googleapis.slides: UpdateLineCategoryRequest![](/images/permalink.svg)
Updates the category of a line.
Fields
- 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.
- 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.
googleapis.slides: UpdateLinePropertiesRequest![](/images/permalink.svg)
Updates the properties of a Line.
Fields
- fields string? - The fields that should be updated. At least one field must be specified. The root
lineProperties
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example to update the line solid fill color, setfields
to"lineFill.solidFill.color"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- lineProperties LineProperties? - The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor.
- objectId string? - The object ID of the line the update is applied to.
googleapis.slides: UpdatePageElementAltTextRequest![](/images/permalink.svg)
Updates the alt text title and/or description of a page element.
Fields
- 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.
- 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.
googleapis.slides: UpdatePageElementsZOrderRequest![](/images/permalink.svg)
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.
Fields
- 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.
- pageElementObjectIds string[]? - The object IDs of the page elements to update. All the page elements must be on the same page and must not be grouped.
googleapis.slides: UpdatePageElementTransformRequest![](/images/permalink.svg)
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.
Fields
- applyMode string? - The apply mode of the transform update.
- objectId string? - The object ID of the page element to update.
- transform AffineTransform? - 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.
googleapis.slides: UpdatePagePropertiesRequest![](/images/permalink.svg)
Updates the properties of a Page.
Fields
- fields string? - The fields that should be updated. At least one field must be specified. The root
pageProperties
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example to update the page background solid fill color, setfields
to"pageBackgroundFill.solidFill.color"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- objectId string? - The object ID of the page the update is applied to.
- pageProperties PageProperties? - 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.
googleapis.slides: UpdateParagraphStyleRequest![](/images/permalink.svg)
Updates the styling for all of the paragraphs within a Shape or Table that overlap with the given text index range.
Fields
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- fields string? - The fields that should be updated. At least one field must be specified. The root
style
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example, to update the paragraph alignment, setfields
to"alignment"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- objectId string? - The object ID of the shape or table with the text to be styled.
- style ParagraphStyle? - 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.
- textRange Range? - Specifies a contiguous range of an indexed collection, such as characters in text.
googleapis.slides: UpdateShapePropertiesRequest![](/images/permalink.svg)
Update the properties of a Shape.
Fields
- fields string? - The fields that should be updated. At least one field must be specified. The root
shapeProperties
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example to update the shape background solid fill color, setfields
to"shapeBackgroundFill.solidFill.color"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- objectId string? - The object ID of the shape the updates are applied to.
- shapeProperties ShapeProperties? - 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.
googleapis.slides: UpdateSlidePropertiesRequest![](/images/permalink.svg)
Updates the properties of a Slide.
Fields
- 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
"*"
can be used as short-hand for listing every field. For example to update whether a slide is skipped, setfields
to"isSkipped"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- objectId string? - The object ID of the slide the update is applied to.
- slideProperties SlideProperties? - The properties of Page that are only relevant for pages with page_type SLIDE.
googleapis.slides: UpdateSlidesPositionRequest![](/images/permalink.svg)
Updates the position of slides in the presentation.
Fields
- insertionIndex int? - 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.
- slideObjectIds string[]? - 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.
googleapis.slides: UpdateTableBorderPropertiesRequest![](/images/permalink.svg)
Updates the properties of the table borders in a Table.
Fields
- 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.
- fields string? - The fields that should be updated. At least one field must be specified. The root
tableBorderProperties
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example to update the table border solid fill color, setfields
to"tableBorderFill.solidFill.color"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- objectId string? - The object ID of the table.
- tableBorderProperties TableBorderProperties? - The border styling properties of the TableBorderCell.
- tableRange TableRange? - A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with location = (0, 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ]
googleapis.slides: UpdateTableCellPropertiesRequest![](/images/permalink.svg)
Update the properties of a TableCell.
Fields
- fields string? - The fields that should be updated. At least one field must be specified. The root
tableCellProperties
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example to update the table cell background solid fill color, setfields
to"tableCellBackgroundFill.solidFill.color"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- objectId string? - The object ID of the table.
- tableCellProperties TableCellProperties? - The properties of the TableCell.
- tableRange TableRange? - A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with location = (0, 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ]
googleapis.slides: UpdateTableColumnPropertiesRequest![](/images/permalink.svg)
Updates the properties of a Table column.
Fields
- columnIndices int[]? - The list of zero-based indices specifying which columns to update. If no indices are provided, all columns in the table will be updated.
- fields string? - The fields that should be updated. At least one field must be specified. The root
tableColumnProperties
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example to update the column width, setfields
to"column_width"
. If '"column_width"' is included in the field mask but the property is left unset, the column width will default to 406,400 EMU (32 points).
- objectId string? - The object ID of the table.
- tableColumnProperties TableColumnProperties? - Properties of each column in a table.
googleapis.slides: UpdateTableRowPropertiesRequest![](/images/permalink.svg)
Updates the properties of a Table row.
Fields
- fields string? - The fields that should be updated. At least one field must be specified. The root
tableRowProperties
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example to update the minimum row height, setfields
to"min_row_height"
. If '"min_row_height"' is included in the field mask but the property is left unset, the minimum row height will default to 0.
- objectId string? - The object ID of the table.
- rowIndices int[]? - 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? - Properties of each row in a table.
googleapis.slides: UpdateTextStyleRequest![](/images/permalink.svg)
Update the styling of text in a Shape or Table.
Fields
- cellLocation TableCellLocation? - A location of a single table cell within a table.
- fields string? - The fields that should be updated. At least one field must be specified. The root
style
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example, to update the text style to bold, setfields
to"bold"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- objectId string? - The object ID of the shape or table with the text to be styled.
- style TextStyle? - 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.
- textRange Range? - Specifies a contiguous range of an indexed collection, such as characters in text.
googleapis.slides: UpdateVideoPropertiesRequest![](/images/permalink.svg)
Update the properties of a Video.
Fields
- fields string? - The fields that should be updated. At least one field must be specified. The root
videoProperties
is implied and should not be specified. A single"*"
can be used as short-hand for listing every field. For example to update the video outline color, setfields
to"outline.outlineFill.solidFill.color"
. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
- objectId string? - The object ID of the video the updates are applied to.
- videoProperties VideoProperties? - The properties of the Video.
googleapis.slides: Video![](/images/permalink.svg)
A PageElement kind representing a video.
Fields
- id string? - The video source's unique identifier for this video.
- 'source string? - The video source.
- url string? - An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change.
- videoProperties VideoProperties? - The properties of the Video.
googleapis.slides: VideoProperties![](/images/permalink.svg)
The properties of the Video.
Fields
- autoPlay boolean? - Whether to enable video autoplay when the page is displayed in present mode. Defaults to false.
- end int? - 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.
- outline Outline? - 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.
- 'start int? - 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.
googleapis.slides: WeightedFontFamily![](/images/permalink.svg)
Represents a font family and weight used to style a TextRun.
Fields
- 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] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in
Arial
.
- weight int? - The rendered weight of the text. This field can have any value that is a multiple of
100
between100
and900
, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, section 15.6, with non-numerical values disallowed. Weights greater than or equal to700
are considered bold, and weights less than700
are not bold. The default value is400
("normal").
googleapis.slides: WordArt![](/images/permalink.svg)
A PageElement kind representing word art.
Fields
- renderedText string? - The text rendered as word art.
googleapis.slides: WriteControl![](/images/permalink.svg)
Provides control over how write requests are executed.
Fields
- requiredRevisionId string? - The revision ID of the presentation required for the write request. If specified and the
required_revision_id
doesn't exactly match the presentation's currentrevision_id
, the request will not be processed and will return a 400 bad request error.
Import
import ballerinax/googleapis.slides;
Metadata
Released date: almost 2 years ago
Version: 1.4.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 1
Weekly downloads
Keywords
Content & Files/Documents
Cost/Freemium
Vendor/Google
Contributors
Dependencies