Blame - docs/dyn/slides_v1.presentations.pages.html - platform/external/python/google-api-python-client

2017-03-24 15:06:46 -0700

[diff] [blame]

80

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

81

<code><a href="#getThumbnail">getThumbnail(presentationId, pageObjectId, thumbnailProperties_thumbnailSize=None, thumbnailProperties_mimeType=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

82

<p class="firstline">Generates a thumbnail of the latest version of the specified page in the</p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

83

<h3>Method Details</h3>

84

85

<code class="details" id="get">get(presentationId, pageObjectId, x__xgafv=None)</code>

86

<pre>Gets the latest version of the specified page in the presentation.

87

88

Args:

89

presentationId: string, The ID of the presentation to retrieve. (required)

90

pageObjectId: string, The object ID of the page to retrieve. (required)

91

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

98

99

{ # A page in a presentation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

100

"objectId": "A String", # The object ID for this page. Object IDs used by

101

# Page and

102

# PageElement share the same namespace.

103

"pageProperties": { # The properties of the Page. # The properties of the page.

104

#

105

# The page will inherit properties from the parent page. Depending on the page

106

# type the hierarchy is defined in either

107

# SlideProperties or

108

# LayoutProperties.

109

"colorScheme": { # The palette of predefined colors for a page. # The color scheme of the page. If unset, the color scheme is inherited from

110

# a parent page. If the page has no parent, the color scheme uses a default

111

# Slides color scheme, matching the defaults in the Slides editor.

112

#

113

# Only the concrete colors of the first 12 ThemeColorTypes are editable. In addition, only

114

# the color scheme on `Master` pages can be updated. To update the field, a

115

# color scheme containing mappings from all the first 12 ThemeColorTypes to

116

# their concrete colors must be provided. Colors for the remaining

117

# ThemeColorTypes will be ignored.

118

"colors": [ # The ThemeColorType and corresponding concrete color pairs.

119

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

120

"type": "A String", # The type of the theme color.

121

"color": { # An RGB color. # The concrete color corresponding to the theme color type above.

122

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

123

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

124

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

],

},

"pageBackgroundFill": { # The page background fill. # The background fill of the page. If unset, the background fill is inherited

130

# from a parent page if it exists. If the page has no parent, then the

131

# background fill defaults to the corresponding fill in the Slides editor.

132

"stretchedPictureFill": { # The stretched picture fill. The page or page element is filled entirely with # Stretched picture fill.

133

# the specified picture. The picture is stretched to fit its container.

134

"size": { # A width and height. # The original size of the picture fill. This field is read-only.

135

"width": { # A magnitude in a single direction in the specified units. # The width of the object.

136

"unit": "A String", # The units for magnitude.

137

"magnitude": 3.14, # The magnitude.

138

},

139

"height": { # A magnitude in a single direction in the specified units. # The height of the object.

140

"unit": "A String", # The units for magnitude.

141

"magnitude": 3.14, # The magnitude.

142

},

143

},

144

"contentUrl": "A String", # Reading the content_url:

145

#

146

# An URL to a picture with a default lifetime of 30 minutes.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

147

# This URL is tagged with the account of the requester. Anyone with the URL

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

148

# effectively accesses the picture as the original requester. Access to the

149

# picture may be lost if the presentation's sharing settings change.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

150

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

151

# Writing the content_url:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

152

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

153

# The picture is fetched once at insertion time and a copy is stored for

154

# display inside the presentation. Pictures must be less than 50MB in size,

155

# cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF

156

# format.

157

#

158

# The provided URL can be at most 2 kB in length.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

159

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

160

"propertyState": "A String", # The background fill property state.

161

#

162

# Updating the fill on a page will implicitly update this field to

163

# `RENDERED`, unless another value is specified in the same request. To

164

# have no fill on a page, set this field to `NOT_RENDERED`. In this case,

165

# any other fill fields set in the same request will be ignored.

166

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

167

# specified color value.

168

#

169

# If any field is unset, its value may be inherited from a parent placeholder

170

# if it exists.

171

"color": { # A themeable solid color value. # The color value of the solid fill.

172

"themeColor": "A String", # An opaque theme color.

173

"rgbColor": { # An RGB color. # An opaque RGB color.

174

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

175

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

176

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

177

},

178

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

179

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

180

# That is, the final pixel color is defined by the equation:

181

#

182

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

183

#

184

# This means that a value of 1.0 corresponds to a solid color, whereas

185

# a value of 0.0 corresponds to a completely transparent color.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

186

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

187

},

188

},

189

"layoutProperties": { # The properties of Page are only # Layout specific properties. Only set if page_type = LAYOUT.

190

# relevant for pages with page_type LAYOUT.

191

"masterObjectId": "A String", # The object ID of the master that this layout is based on.

192

"displayName": "A String", # The human-readable name of the layout.

193

"name": "A String", # The name of the layout.

194

},

195

"pageType": "A String", # The type of the page.

196

"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.

197

# relevant for pages with page_type NOTES.

198

"speakerNotesObjectId": "A String", # The object ID of the shape on this notes page that contains the speaker

199

# notes for the corresponding slide.

200

# The actual shape may not always exist on the notes page. Inserting text

201

# using this object ID will automatically create the shape. In this case, the

202

# actual shape may have different object ID. The `GetPresentation` or

203

# `GetPage` action will always return the latest object ID.

204

},

205

"masterProperties": { # The properties of Page that are only # Master specific properties. Only set if page_type = MASTER.

206

# relevant for pages with page_type MASTER.

207

"displayName": "A String", # The human-readable name of the master.

208

},

209

"slideProperties": { # The properties of Page that are only # Slide specific properties. Only set if page_type = SLIDE.

210

# relevant for pages with page_type SLIDE.

211

"notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual

212

# appearance of a notes page when printing or exporting slides with speaker

213

# notes. A notes page inherits properties from the

214

# notes master.

215

# The placeholder shape with type BODY on the notes page contains the speaker

216

# notes for this slide. The ID of this shape is identified by the

217

# speakerNotesObjectId field.

218

# The notes page is read-only except for the text content and styles of the

219

# speaker notes shape. This property is read-only.

220

"masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is

221

# read-only.

222

"layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is

223

# read-only.

224

},

225

"pageElements": [ # The page elements rendered on the page.

226

{ # A visual element rendered on a page.

227

"wordArt": { # A PageElement kind representing # A word art page element.

228

# word art.

229

"renderedText": "A String", # The text rendered as word art.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

230

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

231

"title": "A String", # The title of the page element. Combined with description to display alt

232

# text.

233

"description": "A String", # The description of the page element. Combined with title to display alt

234

# text.

235

"table": { # A PageElement kind representing a # A table page element.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

236

# table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

237

"columns": 42, # Number of columns in the table.

238

"verticalBorderRows": [ # Properties of vertical cell borders.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

239

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

240

# A table's vertical cell borders are represented as a grid. The grid has the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

241

# same number of rows as the table and one more column than the number of

242

# columns in the table. For example, if the table is 3 x 3, its vertical

243

# borders will be represented as a grid with 3 rows and 4 columns.

244

{ # Contents of each border row in a table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

245

"tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

246

# merged, it is not included in the response.

247

{ # The properties of each border cell.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

248

"location": { # A location of a single table cell within a table. # The location of the border within the border table.

249

"rowIndex": 42, # The 0-based row index.

250

"columnIndex": 42, # The 0-based column index.

251

},

252

"tableBorderProperties": { # The border styling properties of the # The border properties.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

253

# TableBorderCell.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

254

"dashStyle": "A String", # The dash style of the border.

255

"tableBorderFill": { # The fill of the border. # The fill of the table border.

256

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid fill.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

257

# specified color value.

258

#

259

# If any field is unset, its value may be inherited from a parent placeholder

260

# if it exists.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

261

"color": { # A themeable solid color value. # The color value of the solid fill.

262

"themeColor": "A String", # An opaque theme color.

263

"rgbColor": { # An RGB color. # An opaque RGB color.

264

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

265

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

266

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

267

},

268

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

269

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

270

# That is, the final pixel color is defined by the equation:

271

#

272

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

273

#

274

# This means that a value of 1.0 corresponds to a solid color, whereas

275

# a value of 0.0 corresponds to a completely transparent color.

276

},

277

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

278

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the border.

279

"unit": "A String", # The units for magnitude.

280

"magnitude": 3.14, # The magnitude.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

281

},

282

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

287

"horizontalBorderRows": [ # Properties of horizontal cell borders.

288

#

289

# A table's horizontal cell borders are represented as a grid. The grid has

290

# one more row than the number of rows in the table and the same number of

291

# columns as the table. For example, if the table is 3 x 3, its horizontal

292

# borders will be represented as a grid with 4 rows and 3 columns.

293

{ # Contents of each border row in a table.

294

"tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are

295

# merged, it is not included in the response.

296

{ # The properties of each border cell.

297

"location": { # A location of a single table cell within a table. # The location of the border within the border table.

298

"rowIndex": 42, # The 0-based row index.

299

"columnIndex": 42, # The 0-based column index.

300

},

301

"tableBorderProperties": { # The border styling properties of the # The border properties.

302

# TableBorderCell.

303

"dashStyle": "A String", # The dash style of the border.

304

"tableBorderFill": { # The fill of the border. # The fill of the table border.

305

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid fill.

306

# specified color value.

307

#

308

# If any field is unset, its value may be inherited from a parent placeholder

309

# if it exists.

310

"color": { # A themeable solid color value. # The color value of the solid fill.

311

"themeColor": "A String", # An opaque theme color.

312

"rgbColor": { # An RGB color. # An opaque RGB color.

313

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

314

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

315

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

316

},

317

},

318

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

319

# That is, the final pixel color is defined by the equation:

320

#

321

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

322

#

323

# This means that a value of 1.0 corresponds to a solid color, whereas

324

# a value of 0.0 corresponds to a completely transparent color.

325

},

326

},

327

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the border.

328

"unit": "A String", # The units for magnitude.

329

"magnitude": 3.14, # The magnitude.

},

},

},

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

334

},

335

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

336

"rows": 42, # Number of rows in the table.

337

"tableRows": [ # Properties and contents of each row.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

338

#

339

# Cells that span multiple rows are contained in only one of these rows and

340

# have a row_span greater

341

# than 1.

342

{ # Properties and contents of each row in a table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

343

"rowHeight": { # A magnitude in a single direction in the specified units. # Height of a row.

344

"unit": "A String", # The units for magnitude.

345

"magnitude": 3.14, # The magnitude.

346

},

347

"tableRowProperties": { # Properties of each row in a table. # Properties of the row.

348

"minRowHeight": { # A magnitude in a single direction in the specified units. # Minimum height of the row. The row will be rendered in the Slides editor at

349

# a height equal to or greater than this value in order to show all the text

350

# in the row's cell(s).

351

"unit": "A String", # The units for magnitude.

352

"magnitude": 3.14, # The magnitude.

353

},

354

},

355

"tableCells": [ # Properties and contents of each cell.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

356

#

357

# Cells that span multiple columns are represented only once with a

358

# column_span greater

359

# than 1. As a result, the length of this collection does not always match

360

# the number of columns of the entire table.

361

{ # Properties and contents of each table cell.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

362

"location": { # A location of a single table cell within a table. # The location of the cell within the table.

363

"rowIndex": 42, # The 0-based row index.

364

"columnIndex": 42, # The 0-based column index.

365

},

366

"text": { # The general text content. The text must reside in a compatible shape (e.g. # The text content of the cell.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

367

# text box or rectangle) or a table cell in a page.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

368

"lists": { # The bulleted lists contained in this text, keyed by list ID.

369

"a_key": { # A List describes the look and feel of bullets belonging to paragraphs

370

# associated with a list. A paragraph that is part of a list has an implicit

371

# reference to that list's ID.

372

"listId": "A String", # The ID of the list.

373

"nestingLevel": { # A map of nesting levels to the properties of bullets at the associated

374

# level. A list has at most nine levels of nesting, so the possible values

375

# for the keys of this map are 0 through 8, inclusive.

376

"a_key": { # Contains properties describing the look and feel of a list bullet at a given

377

# level of nesting.

378

"bulletStyle": { # Represents the styling that can be applied to a TextRun. # The style of a bullet at this level of nesting.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

379

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

380

# If this text is contained in a shape with a parent placeholder, then these text styles may be

381

# inherited from the parent. Which text styles are inherited depend on the

382

# nesting level of lists:

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

383

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

384

# * A text run in a paragraph that is not in a list will inherit its text style

385

# from the the newline character in the paragraph at the 0 nesting level of

386

# the list inside the parent placeholder.

387

# * A text run in a paragraph that is in a list will inherit its text style

388

# from the newline character in the paragraph at its corresponding nesting

389

# level of the list inside the parent placeholder.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

390

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

391

# Inherited text styles are represented as unset fields in this message. If

392

# text is contained in a shape without a parent placeholder, unsetting these

393

# fields will revert the style to a value matching the defaults in the Slides

394

# editor.

395

"strikethrough": True or False, # Whether or not the text is struck through.

396

"fontFamily": "A String", # The font family of the text.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

397

#

398

# The font family can be any font from the Font menu in Slides or from

399

# [Google Fonts] (https://fonts.google.com/). If the font name is

400

# unrecognized, the text is rendered in `Arial`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

401

#

402

# Some fonts can affect the weight of the text. If an update request

403

# specifies values for both `font_family` and `bold`, the explicitly-set

404

# `bold` value is used.

405

"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or

406

# transparent, depending on if the `opaque_color` field in it is set.

407

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

408

# a transparent color.

409

"themeColor": "A String", # An opaque theme color.

410

"rgbColor": { # An RGB color. # An opaque RGB color.

411

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

412

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

413

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

414

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

415

},

416

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

417

"fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in

418

# points.

419

"unit": "A String", # The units for magnitude.

420

"magnitude": 3.14, # The magnitude.

421

},

422

"baselineOffset": "A String", # The text's vertical offset from its normal position.

423

#

424

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

425

# rendered in a smaller font size, computed based on the `font_size` field.

426

# The `font_size` itself is not affected by changes in this field.

427

"foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or

428

# transparent, depending on if the `opaque_color` field in it is set.

429

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

430

# a transparent color.

431

"themeColor": "A String", # An opaque theme color.

432

"rgbColor": { # An RGB color. # An opaque RGB color.

433

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

434

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

435

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"bold": True or False, # Whether or not the text is rendered as bold.

440

"italic": True or False, # Whether or not the text is italicized.

441

"smallCaps": True or False, # Whether or not the text is in small capital letters.

442

"weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text.

443

#

444

# This field is an extension of `font_family` meant to support explicit font

445

# weights without breaking backwards compatibility. As such, when reading the

446

# style of a range of text, the value of `weighted_font_family#font_family`

447

# will always be equal to that of `font_family`. However, when writing, if

448

# both fields are included in the field mask (either explicitly or through

449

# the wildcard `"*"`), their values are reconciled as follows:

450

#

451

# * If `font_family` is set and `weighted_font_family` is not, the value of

452

# `font_family` is applied with weight `400` ("normal").

453

# * If both fields are set, the value of `font_family` must match that of

454

# `weighted_font_family#font_family`. If so, the font family and weight of

455

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

456

# returned.

457

# * If `weighted_font_family` is set and `font_family` is not, the font

458

# family and weight of `weighted_font_family` is applied.

459

# * If neither field is set, the font family and weight of the text inherit

460

# from the parent. Note that these properties cannot inherit separately

461

# from each other.

462

#

463

# If an update request specifies values for both `weighted_font_family` and

464

# `bold`, the `weighted_font_family` is applied first, then `bold`.

465

#

466

# If `weighted_font_family#weight` is not set, it defaults to `400`.

467

#

468

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

469

# must also be set with a non-empty value. Otherwise, a 400 bad request error

470

# is returned.

471

"fontFamily": "A String", # The font family of the text.

472

#

473

# The font family can be any font from the Font menu in Slides or from

474

# [Google Fonts] (https://fonts.google.com/). If the font name is

475

# unrecognized, the text is rendered in `Arial`.

476

"weight": 42, # The rendered weight of the text. This field can have any value that is a

477

# multiple of `100` between `100` and `900`, inclusive. This range

478

# corresponds to the numerical values described in the CSS 2.1

479

# Specification,

480

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

481

# with non-numerical values disallowed. Weights greater than or equal to

482

# `700` are considered bold, and weights less than `700`are not bold. The

483

# default value is `400` ("normal").

484

},

485

"underline": True or False, # Whether or not the text is underlined.

486

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

487

# are not inherited from parent text.

488

#

489

# Changing the link in an update request causes some other changes to the

490

# text style of the range:

491

#

492

# * When setting a link, the text foreground color will be set to

493

# ThemeColorType.HYPERLINK and the text will

494

# be underlined. If these fields are modified in the same

495

# request, those values will be used instead of the link defaults.

496

# * Setting a link on a text range that overlaps with an existing link will

497

# also update the existing link to point to the new URL.

498

# * Links are not settable on newline characters. As a result, setting a link

499

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

500

# will separate the newline character(s) into their own text runs. The

501

# link will be applied separately to the runs before and after the newline.

502

# * Removing a link will update the text style of the range to match the

503

# style of the preceding text (or the default text styles if the preceding

504

# text is another link) unless different styles are being set in the same

505

# request.

506

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

507

# presentation with this ID. A page with this ID may not exist.

508

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

509

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

510

# addressed by its position.

511

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

512

# in the presentation. There may not be a slide at this index.

513

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

514

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

515

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

516

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

517

},

518

},

519

"textElements": [ # The text contents broken down into its component parts, including styling

520

# information. This property is read-only.

521

{ # A TextElement describes the content of a range of indices in the text content

522

# of a Shape or TableCell.

523

"paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

524

#

525

# The `start_index` and `end_index` of this TextElement represent the

526

# range of the paragraph. Other TextElements with an index range contained

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

527

# inside this paragraph's range are considered to be part of this

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

528

# paragraph. The range of indices of two separate paragraphs will never

529

# overlap.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

530

"bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not

531

# belong to a list.

532

"listId": "A String", # The ID of the list this paragraph belongs to.

533

"glyph": "A String", # The rendered bullet glyph for this paragraph.

534

"nestingLevel": 42, # The nesting level of this paragraph in the list.

535

"bulletStyle": { # Represents the styling that can be applied to a TextRun. # The paragraph specific text style applied to this bullet.

536

#

537

# If this text is contained in a shape with a parent placeholder, then these text styles may be

538

# inherited from the parent. Which text styles are inherited depend on the

539

# nesting level of lists:

540

#

541

# * A text run in a paragraph that is not in a list will inherit its text style

542

# from the the newline character in the paragraph at the 0 nesting level of

543

# the list inside the parent placeholder.

544

# * A text run in a paragraph that is in a list will inherit its text style

545

# from the newline character in the paragraph at its corresponding nesting

546

# level of the list inside the parent placeholder.

547

#

548

# Inherited text styles are represented as unset fields in this message. If

549

# text is contained in a shape without a parent placeholder, unsetting these

550

# fields will revert the style to a value matching the defaults in the Slides

551

# editor.

552

"strikethrough": True or False, # Whether or not the text is struck through.

553

"fontFamily": "A String", # The font family of the text.

554

#

555

# The font family can be any font from the Font menu in Slides or from

556

# [Google Fonts] (https://fonts.google.com/). If the font name is

557

# unrecognized, the text is rendered in `Arial`.

558

#

559

# Some fonts can affect the weight of the text. If an update request

560

# specifies values for both `font_family` and `bold`, the explicitly-set

561

# `bold` value is used.

562

"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or

563

# transparent, depending on if the `opaque_color` field in it is set.

564

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

565

# a transparent color.

566

"themeColor": "A String", # An opaque theme color.

567

"rgbColor": { # An RGB color. # An opaque RGB color.

568

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

569

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

570

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in

575

# points.

576

"unit": "A String", # The units for magnitude.

577

"magnitude": 3.14, # The magnitude.

578

},

579

"baselineOffset": "A String", # The text's vertical offset from its normal position.

580

#

581

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

582

# rendered in a smaller font size, computed based on the `font_size` field.

583

# The `font_size` itself is not affected by changes in this field.

584

"foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or

585

# transparent, depending on if the `opaque_color` field in it is set.

586

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

587

# a transparent color.

588

"themeColor": "A String", # An opaque theme color.

589

"rgbColor": { # An RGB color. # An opaque RGB color.

590

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

591

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

592

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"bold": True or False, # Whether or not the text is rendered as bold.

597

"italic": True or False, # Whether or not the text is italicized.

598

"smallCaps": True or False, # Whether or not the text is in small capital letters.

599

"weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text.

600

#

601

# This field is an extension of `font_family` meant to support explicit font

602

# weights without breaking backwards compatibility. As such, when reading the

603

# style of a range of text, the value of `weighted_font_family#font_family`

604

# will always be equal to that of `font_family`. However, when writing, if

605

# both fields are included in the field mask (either explicitly or through

606

# the wildcard `"*"`), their values are reconciled as follows:

607

#

608

# * If `font_family` is set and `weighted_font_family` is not, the value of

609

# `font_family` is applied with weight `400` ("normal").

610

# * If both fields are set, the value of `font_family` must match that of

611

# `weighted_font_family#font_family`. If so, the font family and weight of

612

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

613

# returned.

614

# * If `weighted_font_family` is set and `font_family` is not, the font

615

# family and weight of `weighted_font_family` is applied.

616

# * If neither field is set, the font family and weight of the text inherit

617

# from the parent. Note that these properties cannot inherit separately

618

# from each other.

619

#

620

# If an update request specifies values for both `weighted_font_family` and

621

# `bold`, the `weighted_font_family` is applied first, then `bold`.

622

#

623

# If `weighted_font_family#weight` is not set, it defaults to `400`.

624

#

625

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

626

# must also be set with a non-empty value. Otherwise, a 400 bad request error

627

# is returned.

628

"fontFamily": "A String", # The font family of the text.

629

#

630

# The font family can be any font from the Font menu in Slides or from

631

# [Google Fonts] (https://fonts.google.com/). If the font name is

632

# unrecognized, the text is rendered in `Arial`.

633

"weight": 42, # The rendered weight of the text. This field can have any value that is a

634

# multiple of `100` between `100` and `900`, inclusive. This range

635

# corresponds to the numerical values described in the CSS 2.1

636

# Specification,

637

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

638

# with non-numerical values disallowed. Weights greater than or equal to

639

# `700` are considered bold, and weights less than `700`are not bold. The

640

# default value is `400` ("normal").

641

},

642

"underline": True or False, # Whether or not the text is underlined.

643

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

644

# are not inherited from parent text.

645

#

646

# Changing the link in an update request causes some other changes to the

647

# text style of the range:

648

#

649

# * When setting a link, the text foreground color will be set to

650

# ThemeColorType.HYPERLINK and the text will

651

# be underlined. If these fields are modified in the same

652

# request, those values will be used instead of the link defaults.

653

# * Setting a link on a text range that overlaps with an existing link will

654

# also update the existing link to point to the new URL.

655

# * Links are not settable on newline characters. As a result, setting a link

656

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

657

# will separate the newline character(s) into their own text runs. The

658

# link will be applied separately to the runs before and after the newline.

659

# * Removing a link will update the text style of the range to match the

660

# style of the preceding text (or the default text styles if the preceding

661

# text is another link) unless different styles are being set in the same

662

# request.

663

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

664

# presentation with this ID. A page with this ID may not exist.

665

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

666

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

667

# addressed by its position.

668

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

669

# in the presentation. There may not be a slide at this index.

},

},

},

"style": { # Styles that apply to a whole paragraph. # The paragraph's style

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

674

#

675

# If this text is contained in a shape with a parent placeholder, then these paragraph styles may be

676

# inherited from the parent. Which paragraph styles are inherited depend on the

677

# nesting level of lists:

678

#

679

# * A paragraph not in a list will inherit its paragraph style from the

680

# paragraph at the 0 nesting level of the list inside the parent placeholder.

681

# * A paragraph in a list will inherit its paragraph style from the paragraph

682

# at its corresponding nesting level of the list inside the parent

683

# placeholder.

684

#

685

# Inherited paragraph styles are represented as unset fields in this message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

686

"indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

687

# the start of the text, based on the current text direction. If unset, the

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

688

# value is inherited from the parent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

689

"unit": "A String", # The units for magnitude.

690

"magnitude": 3.14, # The magnitude.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

691

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

692

"indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

693

# the end of the text, based on the current text direction. If unset, the

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

694

# value is inherited from the parent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

695

"unit": "A String", # The units for magnitude.

696

"magnitude": 3.14, # The magnitude.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

697

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

698

"spacingMode": "A String", # The spacing mode for the paragraph.

699

"spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is

700

# inherited from the parent.

701

"unit": "A String", # The units for magnitude.

702

"magnitude": 3.14, # The magnitude.

703

},

704

"indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

705

# If unset, the value is inherited from the parent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

706

"unit": "A String", # The units for magnitude.

707

"magnitude": 3.14, # The magnitude.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

708

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

709

"alignment": "A String", # The text alignment for this paragraph.

710

"spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is

711

# inherited from the parent.

712

"unit": "A String", # The units for magnitude.

713

"magnitude": 3.14, # The magnitude.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

714

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

715

"direction": "A String", # The text direction of this paragraph. If unset, the value defaults to

716

# LEFT_TO_RIGHT since

717

# text direction is not inherited.

718

"lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal

719

# is represented as 100.0. If unset, the value is inherited from the parent.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

720

},

721

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

722

"autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically

723

# replaced with content that can change over time.

724

"type": "A String", # The type of this auto text.

725

"content": "A String", # The rendered content of this auto text, if available.

726

"style": { # Represents the styling that can be applied to a TextRun. # The styling applied to this auto text.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

727

#

728

# If this text is contained in a shape with a parent placeholder, then these text styles may be

729

# inherited from the parent. Which text styles are inherited depend on the

730

# nesting level of lists:

731

#

732

# * A text run in a paragraph that is not in a list will inherit its text style

733

# from the the newline character in the paragraph at the 0 nesting level of

734

# the list inside the parent placeholder.

735

# * A text run in a paragraph that is in a list will inherit its text style

736

# from the newline character in the paragraph at its corresponding nesting

737

# level of the list inside the parent placeholder.

738

#

739

# Inherited text styles are represented as unset fields in this message. If

740

# text is contained in a shape without a parent placeholder, unsetting these

741

# fields will revert the style to a value matching the defaults in the Slides

742

# editor.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

743

"strikethrough": True or False, # Whether or not the text is struck through.

744

"fontFamily": "A String", # The font family of the text.

745

#

746

# The font family can be any font from the Font menu in Slides or from

747

# [Google Fonts] (https://fonts.google.com/). If the font name is

748

# unrecognized, the text is rendered in `Arial`.

749

#

750

# Some fonts can affect the weight of the text. If an update request

751

# specifies values for both `font_family` and `bold`, the explicitly-set

752

# `bold` value is used.

753

"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

754

# transparent, depending on if the `opaque_color` field in it is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

755

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

756

# a transparent color.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

757

"themeColor": "A String", # An opaque theme color.

758

"rgbColor": { # An RGB color. # An opaque RGB color.

759

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

760

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

761

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

762

},

763

},

764

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

765

"fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in

766

# points.

767

"unit": "A String", # The units for magnitude.

768

"magnitude": 3.14, # The magnitude.

769

},

770

"baselineOffset": "A String", # The text's vertical offset from its normal position.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

771

#

772

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

773

# rendered in a smaller font size, computed based on the `font_size` field.

774

# The `font_size` itself is not affected by changes in this field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

775

"foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or

776

# transparent, depending on if the `opaque_color` field in it is set.

777

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

778

# a transparent color.

779

"themeColor": "A String", # An opaque theme color.

780

"rgbColor": { # An RGB color. # An opaque RGB color.

781

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

782

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

783

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"bold": True or False, # Whether or not the text is rendered as bold.

788

"italic": True or False, # Whether or not the text is italicized.

789

"smallCaps": True or False, # Whether or not the text is in small capital letters.

790

"weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

791

#

792

# This field is an extension of `font_family` meant to support explicit font

793

# weights without breaking backwards compatibility. As such, when reading the

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

794

# style of a range of text, the value of `weighted_font_family#font_family`

795

# will always be equal to that of `font_family`. However, when writing, if

796

# both fields are included in the field mask (either explicitly or through

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

797

# the wildcard `"*"`), their values are reconciled as follows:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

798

#

799

# * If `font_family` is set and `weighted_font_family` is not, the value of

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

800

# `font_family` is applied with weight `400` ("normal").

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

801

# * If both fields are set, the value of `font_family` must match that of

802

# `weighted_font_family#font_family`. If so, the font family and weight of

803

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

804

# returned.

805

# * If `weighted_font_family` is set and `font_family` is not, the font

806

# family and weight of `weighted_font_family` is applied.

807

# * If neither field is set, the font family and weight of the text inherit

808

# from the parent. Note that these properties cannot inherit separately

809

# from each other.

810

#

811

# If an update request specifies values for both `weighted_font_family` and

812

# `bold`, the `weighted_font_family` is applied first, then `bold`.

813

#

814

# If `weighted_font_family#weight` is not set, it defaults to `400`.

815

#

816

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

817

# must also be set with a non-empty value. Otherwise, a 400 bad request error

818

# is returned.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

819

"fontFamily": "A String", # The font family of the text.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

820

#

821

# The font family can be any font from the Font menu in Slides or from

822

# [Google Fonts] (https://fonts.google.com/). If the font name is

823

# unrecognized, the text is rendered in `Arial`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

824

"weight": 42, # The rendered weight of the text. This field can have any value that is a

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

825

# multiple of `100` between `100` and `900`, inclusive. This range

826

# corresponds to the numerical values described in the CSS 2.1

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

827

# Specification,

828

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

829

# with non-numerical values disallowed. Weights greater than or equal to

830

# `700` are considered bold, and weights less than `700`are not bold. The

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

831

# default value is `400` ("normal").

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

832

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

833

"underline": True or False, # Whether or not the text is underlined.

834

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

835

# are not inherited from parent text.

836

#

837

# Changing the link in an update request causes some other changes to the

838

# text style of the range:

839

#

840

# * When setting a link, the text foreground color will be set to

841

# ThemeColorType.HYPERLINK and the text will

842

# be underlined. If these fields are modified in the same

843

# request, those values will be used instead of the link defaults.

844

# * Setting a link on a text range that overlaps with an existing link will

845

# also update the existing link to point to the new URL.

846

# * Links are not settable on newline characters. As a result, setting a link

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

847

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

848

# will separate the newline character(s) into their own text runs. The

849

# link will be applied separately to the runs before and after the newline.

850

# * Removing a link will update the text style of the range to match the

851

# style of the preceding text (or the default text styles if the preceding

852

# text is another link) unless different styles are being set in the same

853

# request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

854

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

855

# presentation with this ID. A page with this ID may not exist.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

856

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

857

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

858

# addressed by its position.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

859

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

860

# in the presentation. There may not be a slide at this index.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

861

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

862

},

863

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

864

"textRun": { # A TextElement kind that represents a run of text that all has the same # A TextElement representing a run of text where all of the characters

865

# in the run have the same TextStyle.

866

#

867

# The `start_index` and `end_index` of TextRuns will always be fully

868

# contained in the index range of a single `paragraph_marker` TextElement.

869

# In other words, a TextRun will never span multiple paragraphs.

870

# styling.

871

"content": "A String", # The text of this run.

872

"style": { # Represents the styling that can be applied to a TextRun. # The styling applied to this run.

873

#

874

# If this text is contained in a shape with a parent placeholder, then these text styles may be

875

# inherited from the parent. Which text styles are inherited depend on the

876

# nesting level of lists:

877

#

878

# * A text run in a paragraph that is not in a list will inherit its text style

879

# from the the newline character in the paragraph at the 0 nesting level of

880

# the list inside the parent placeholder.

881

# * A text run in a paragraph that is in a list will inherit its text style

882

# from the newline character in the paragraph at its corresponding nesting

883

# level of the list inside the parent placeholder.

884

#

885

# Inherited text styles are represented as unset fields in this message. If

886

# text is contained in a shape without a parent placeholder, unsetting these

887

# fields will revert the style to a value matching the defaults in the Slides

888

# editor.

889

"strikethrough": True or False, # Whether or not the text is struck through.

890

"fontFamily": "A String", # The font family of the text.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

891

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

892

# The font family can be any font from the Font menu in Slides or from

893

# [Google Fonts] (https://fonts.google.com/). If the font name is

894

# unrecognized, the text is rendered in `Arial`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

895

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

896

# Some fonts can affect the weight of the text. If an update request

897

# specifies values for both `font_family` and `bold`, the explicitly-set

898

# `bold` value is used.

899

"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or

900

# transparent, depending on if the `opaque_color` field in it is set.

901

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

902

# a transparent color.

903

"themeColor": "A String", # An opaque theme color.

904

"rgbColor": { # An RGB color. # An opaque RGB color.

905

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

906

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

907

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

908

},

909

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

910

},

911

"fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in

912

# points.

913

"unit": "A String", # The units for magnitude.

914

"magnitude": 3.14, # The magnitude.

915

},

916

"baselineOffset": "A String", # The text's vertical offset from its normal position.

917

#

918

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

919

# rendered in a smaller font size, computed based on the `font_size` field.

920

# The `font_size` itself is not affected by changes in this field.

921

"foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or

922

# transparent, depending on if the `opaque_color` field in it is set.

923

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

924

# a transparent color.

925

"themeColor": "A String", # An opaque theme color.

926

"rgbColor": { # An RGB color. # An opaque RGB color.

927

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

928

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

929

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

930

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

931

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

932

},

933

"bold": True or False, # Whether or not the text is rendered as bold.

934

"italic": True or False, # Whether or not the text is italicized.

935

"smallCaps": True or False, # Whether or not the text is in small capital letters.

936

"weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text.

937

#

938

# This field is an extension of `font_family` meant to support explicit font

939

# weights without breaking backwards compatibility. As such, when reading the

940

# style of a range of text, the value of `weighted_font_family#font_family`

941

# will always be equal to that of `font_family`. However, when writing, if

942

# both fields are included in the field mask (either explicitly or through

943

# the wildcard `"*"`), their values are reconciled as follows:

944

#

945

# * If `font_family` is set and `weighted_font_family` is not, the value of

946

# `font_family` is applied with weight `400` ("normal").

947

# * If both fields are set, the value of `font_family` must match that of

948

# `weighted_font_family#font_family`. If so, the font family and weight of

949

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

950

# returned.

951

# * If `weighted_font_family` is set and `font_family` is not, the font

952

# family and weight of `weighted_font_family` is applied.

953

# * If neither field is set, the font family and weight of the text inherit

954

# from the parent. Note that these properties cannot inherit separately

955

# from each other.

956

#

957

# If an update request specifies values for both `weighted_font_family` and

958

# `bold`, the `weighted_font_family` is applied first, then `bold`.

959

#

960

# If `weighted_font_family#weight` is not set, it defaults to `400`.

961

#

962

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

963

# must also be set with a non-empty value. Otherwise, a 400 bad request error

964

# is returned.

965

"fontFamily": "A String", # The font family of the text.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

966

#

967

# The font family can be any font from the Font menu in Slides or from

968

# [Google Fonts] (https://fonts.google.com/). If the font name is

969

# unrecognized, the text is rendered in `Arial`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

970

"weight": 42, # The rendered weight of the text. This field can have any value that is a

971

# multiple of `100` between `100` and `900`, inclusive. This range

972

# corresponds to the numerical values described in the CSS 2.1

973

# Specification,

974

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

975

# with non-numerical values disallowed. Weights greater than or equal to

976

# `700` are considered bold, and weights less than `700`are not bold. The

977

# default value is `400` ("normal").

978

},

979

"underline": True or False, # Whether or not the text is underlined.

980

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

981

# are not inherited from parent text.

982

#

983

# Changing the link in an update request causes some other changes to the

984

# text style of the range:

985

#

986

# * When setting a link, the text foreground color will be set to

987

# ThemeColorType.HYPERLINK and the text will

988

# be underlined. If these fields are modified in the same

989

# request, those values will be used instead of the link defaults.

990

# * Setting a link on a text range that overlaps with an existing link will

991

# also update the existing link to point to the new URL.

992

# * Links are not settable on newline characters. As a result, setting a link

993

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

994

# will separate the newline character(s) into their own text runs. The

995

# link will be applied separately to the runs before and after the newline.

996

# * Removing a link will update the text style of the range to match the

997

# style of the preceding text (or the default text styles if the preceding

998

# text is another link) unless different styles are being set in the same

999

# request.

1000

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

1001

# presentation with this ID. A page with this ID may not exist.

1002

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

1003

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

1004

# addressed by its position.

1005

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

1006

# in the presentation. There may not be a slide at this index.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1007

},

1008

},

1009

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1010

"endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code

1011

# units.

1012

"startIndex": 42, # The zero-based start index of this text element, in Unicode code units.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1013

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1014

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1015

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1016

"columnSpan": 42, # Column span of the cell.

1017

"tableCellProperties": { # The properties of the TableCell. # The properties of the table cell.

1018

"tableCellBackgroundFill": { # The table cell background fill. # The background fill of the table cell. The default fill matches the fill

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1019

# for newly created table cells in the Slides editor.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1020

"propertyState": "A String", # The background fill property state.

1021

#

1022

# Updating the fill on a table cell will implicitly update this field

1023

# to `RENDERED`, unless another value is specified in the same request. To

1024

# have no fill on a table cell, set this field to `NOT_RENDERED`. In this

1025

# case, any other fill fields set in the same request will be ignored.

1026

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1027

# specified color value.

1028

#

1029

# If any field is unset, its value may be inherited from a parent placeholder

1030

# if it exists.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1031

"color": { # A themeable solid color value. # The color value of the solid fill.

1032

"themeColor": "A String", # An opaque theme color.

1033

"rgbColor": { # An RGB color. # An opaque RGB color.

1034

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1035

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1036

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1037

},

1038

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1039

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1040

# That is, the final pixel color is defined by the equation:

1041

#

1042

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

1043

#

1044

# This means that a value of 1.0 corresponds to a solid color, whereas

1045

# a value of 0.0 corresponds to a completely transparent color.

1046

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1047

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1048

"contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1049

# matches the alignment for newly created table cells in the Slides editor.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1050

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1051

"rowSpan": 42, # Row span of the cell.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1052

},

1053

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1054

},

1055

],

1056

"tableColumns": [ # Properties of each column.

1057

{ # Properties of each column in a table.

1058

"columnWidth": { # A magnitude in a single direction in the specified units. # Width of a column.

1059

"unit": "A String", # The units for magnitude.

1060

"magnitude": 3.14, # The magnitude.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1061

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1062

},

1063

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1064

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1065

"transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # The transform of the page element.

1066

#

1067

# The visual appearance of the page element is determined by its absolute

1068

# transform. To compute the absolute transform, preconcatenate a page

1069

# element's transform with the transforms of all of its parent groups. If the

1070

# page element is not in a group, its absolute transform is the same as the

1071

# value in this field.

1072

#

1073

# The initial transform for the newly created Group is always the identity transform.

1074

# to transform source coordinates (x,y) into destination coordinates (x', y')

1075

# according to:

1076

#

1077

# x' x = shear_y scale_y translate_y

1078

# 1 [ 1 ]

1079

#

1080

# After transformation,

1081

#

1082

# x' = scale_x * x + shear_x * y + translate_x;

1083

# y' = scale_y * y + shear_y * x + translate_y;

1084

#

1085

# This message is therefore composed of these six matrix elements.

1086

"shearY": 3.14, # The Y coordinate shearing element.

1087

"scaleY": 3.14, # The Y coordinate scaling element.

1088

"translateX": 3.14, # The X coordinate translation element.

1089

"translateY": 3.14, # The Y coordinate translation element.

1090

"scaleX": 3.14, # The X coordinate scaling element.

1091

"unit": "A String", # The units for translate elements.

1092

"shearX": 3.14, # The X coordinate shearing element.

1093

},

1094

"objectId": "A String", # The object ID for this page element. Object IDs used by

1095

# google.apps.slides.v1.Page and

1096

# google.apps.slides.v1.PageElement share the same namespace.

1097

"image": { # A PageElement kind representing an # An image page element.

1098

# image.

1099

"contentUrl": "A String", # An URL to an image with a default lifetime of 30 minutes.

1100

# This URL is tagged with the account of the requester. Anyone with the URL

1101

# effectively accesses the image as the original requester. Access to the

1102

# image may be lost if the presentation's sharing settings change.

1103

"sourceUrl": "A String", # The source URL is the URL used to insert the image. The source URL can be

1104

# empty.

1105

"imageProperties": { # The properties of the Image. # The properties of the image.

1106

"outline": { # The outline of a PageElement. # The outline of the image. If not set, the image has no outline.

1107

#

1108

# If these fields are unset, they may be inherited from a parent placeholder

1109

# if it exists. If there is no parent, the fields will default to the value

1110

# used for new page elements created in the Slides editor, which may depend on

1111

# the page element kind.

1112

"outlineFill": { # The fill of the outline. # The fill of the outline.

1113

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

1114

# specified color value.

1115

#

1116

# If any field is unset, its value may be inherited from a parent placeholder

1117

# if it exists.

1118

"color": { # A themeable solid color value. # The color value of the solid fill.

1119

"themeColor": "A String", # An opaque theme color.

1120

"rgbColor": { # An RGB color. # An opaque RGB color.

1121

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1122

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1123

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1124

},

1125

},

1126

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

1127

# That is, the final pixel color is defined by the equation:

1128

#

1129

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

1130

#

1131

# This means that a value of 1.0 corresponds to a solid color, whereas

1132

# a value of 0.0 corresponds to a completely transparent color.

1133

},

1134

},

1135

"dashStyle": "A String", # The dash style of the outline.

1136

"propertyState": "A String", # The outline property state.

1137

#

1138

# Updating the outline on a page element will implicitly update this field

1139

# to `RENDERED`, unless another value is specified in the same request. To

1140

# have no outline on a page element, set this field to `NOT_RENDERED`. In

1141

# this case, any other outline fields set in the same request will be

1142

# ignored.

1143

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline.

1144

"unit": "A String", # The units for magnitude.

1145

"magnitude": 3.14, # The magnitude.

1146

},

1147

},

1148

"recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored.

1149

# This property is read-only.

1150

"recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color

1151

# stops.

1152

#

1153

# The colors in the gradient will replace the corresponding colors at

1154

# the same position in the color palette and apply to the image. This

1155

# property is read-only.

1156

{ # A color and position in a gradient band.

1157

"alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0,

1158

# fully opaque.

1159

"position": 3.14, # The relative position of the color stop in the gradient band measured

1160

# in percentage. The value should be in the interval [0.0, 1.0].

1161

"color": { # A themeable solid color value. # The color of the gradient stop.

1162

"themeColor": "A String", # An opaque theme color.

1163

"rgbColor": { # An RGB color. # An opaque RGB color.

1164

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1165

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1166

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

],

"name": "A String", # The name of the recolor effect.

1172

#

1173

# The name is determined from the `recolor_stops` by matching the gradient

1174

# against the colors in the page's current color scheme. This property is

1175

# read-only.

1176

},

1177

"transparency": 3.14, # The transparency effect of the image. The value should be in the interval

1178

# [0.0, 1.0], where 0 means no effect and 1 means completely transparent.

1179

# This property is read-only.

1180

"contrast": 3.14, # The contrast effect of the image. The value should be in the interval

1181

# [-1.0, 1.0], where 0 means no effect. This property is read-only.

1182

"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property

1183

# is read-only.

1184

#

1185

# If these fields are unset, they may be inherited from a parent placeholder

1186

# if it exists. If there is no parent, the fields will default to the value

1187

# used for new page elements created in the Slides editor, which may depend on

1188

# the page element kind.

1189

"alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0.

1190

"transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # Transform that encodes the translate, scale, and skew of the shadow,

1191

# relative to the alignment position.

1192

# to transform source coordinates (x,y) into destination coordinates (x', y')

1193

# according to:

1194

#

1195

# x' x = shear_y scale_y translate_y

1196

# 1 [ 1 ]

1197

#

1198

# After transformation,

1199

#

1200

# x' = scale_x * x + shear_x * y + translate_x;

1201

# y' = scale_y * y + shear_y * x + translate_y;

1202

#

1203

# This message is therefore composed of these six matrix elements.

1204

"shearY": 3.14, # The Y coordinate shearing element.

1205

"scaleY": 3.14, # The Y coordinate scaling element.

1206

"translateX": 3.14, # The X coordinate translation element.

1207

"translateY": 3.14, # The Y coordinate translation element.

1208

"scaleX": 3.14, # The X coordinate scaling element.

1209

"unit": "A String", # The units for translate elements.

1210

"shearX": 3.14, # The X coordinate shearing element.

1211

},

1212

"color": { # A themeable solid color value. # The shadow color value.

1213

"themeColor": "A String", # An opaque theme color.

1214

"rgbColor": { # An RGB color. # An opaque RGB color.

1215

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1216

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1217

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1218

},

1219

},

1220

"alignment": "A String", # The alignment point of the shadow, that sets the origin for translate,

1221

# scale and skew of the shadow. This property is read-only.

1222

"type": "A String", # The type of the shadow. This property is read-only.

1223

"propertyState": "A String", # The shadow property state.

1224

#

1225

# Updating the shadow on a page element will implicitly update this field to

1226

# `RENDERED`, unless another value is specified in the same request. To have

1227

# no shadow on a page element, set this field to `NOT_RENDERED`. In this

1228

# case, any other shadow fields set in the same request will be ignored.

1229

"rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is

1230

# read-only.

1231

"blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the

1232

# shadow becomes.

1233

"unit": "A String", # The units for magnitude.

1234

"magnitude": 3.14, # The magnitude.

1235

},

1236

},

1237

"cropProperties": { # The crop properties of an object enclosed in a container. For example, an # The crop properties of the image. If not set, the image is not cropped.

1238

# This property is read-only.

1239

# Image.

1240

#

1241

# The crop properties is represented by the offsets of four edges which define

1242

# a crop rectangle. The offsets are measured in percentage from the

1243

# corresponding edges of the object's original bounding rectangle towards

1244

# inside, relative to the object's original dimensions.

1245

#

1246

# - If the offset is in the interval (0, 1), the corresponding edge of crop

1247

# rectangle is positioned inside of the object's original bounding rectangle.

1248

# - If the offset is negative or greater than 1, the corresponding edge of crop

1249

# rectangle is positioned outside of the object's original bounding rectangle.

1250

# - If the left edge of the crop rectangle is on the right side of its right

1251

# edge, the object will be flipped horizontally.

1252

# - If the top edge of the crop rectangle is below its bottom edge, the object

1253

# will be flipped vertically.

1254

# - If all offsets and rotation angle is 0, the object is not cropped.

1255

#

1256

# After cropping, the content in the crop rectangle will be stretched to fit

1257

# its container.

1258

"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to

1259

# the right of the original bounding rectangle left edge, relative to the

1260

# object's original width.

1261

"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located

1262

# above the original bounding rectangle bottom edge, relative to the object's

1263

# original height.

1264

"topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located

1265

# below the original bounding rectangle top edge, relative to the object's

1266

# original height.

1267

"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located

1268

# to the left of the original bounding rectangle right edge, relative to the

1269

# object's original width.

1270

"angle": 3.14, # The rotation angle of the crop window around its center, in radians.

1271

# Rotation angle is applied after the offset.

1272

},

1273

"link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link.

1274

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

1275

# presentation with this ID. A page with this ID may not exist.

1276

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

1277

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

1278

# addressed by its position.

1279

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

1280

# in the presentation. There may not be a slide at this index.

1281

},

1282

"brightness": 3.14, # The brightness effect of the image. The value should be in the interval

1283

# [-1.0, 1.0], where 0 means no effect. This property is read-only.

1284

},

1285

},

1286

"video": { # A PageElement kind representing a # A video page element.

1287

# video.

1288

"id": "A String", # The video source's unique identifier for this video.

1289

"source": "A String", # The video source.

1290

"url": "A String", # An URL to a video. The URL is valid as long as the source video exists and

1291

# sharing settings do not change.

1292

"videoProperties": { # The properties of the Video. # The properties of the video.

1293

"start": 42, # The time at which to start playback, measured in seconds from the beginning

1294

# of the video.

1295

# If set, the start time should be before the end time.

1296

# If you set this to a value that exceeds the video's length in seconds, the

1297

# video will be played from the last second.

1298

# If not set, the video will be played from the beginning.

1299

"mute": True or False, # Whether to mute the audio during video playback. Defaults to false.

1300

"end": 42, # The time at which to end playback, measured in seconds from the beginning

1301

# of the video.

1302

# If set, the end time should be after the start time.

1303

# If not set or if you set this to a value that exceeds the video's length,

1304

# the video will be played until its end.

1305

"autoPlay": True or False, # Whether to enable video autoplay when the page is displayed in present

1306

# mode. Defaults to false.

1307

"outline": { # The outline of a PageElement. # The outline of the video. The default outline matches the defaults for new

1308

# videos created in the Slides editor.

1309

#

1310

# If these fields are unset, they may be inherited from a parent placeholder

1311

# if it exists. If there is no parent, the fields will default to the value

1312

# used for new page elements created in the Slides editor, which may depend on

1313

# the page element kind.

1314

"outlineFill": { # The fill of the outline. # The fill of the outline.

1315

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

1316

# specified color value.

1317

#

1318

# If any field is unset, its value may be inherited from a parent placeholder

1319

# if it exists.

1320

"color": { # A themeable solid color value. # The color value of the solid fill.

1321

"themeColor": "A String", # An opaque theme color.

1322

"rgbColor": { # An RGB color. # An opaque RGB color.

1323

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1324

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1325

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1326

},

1327

},

1328

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

1329

# That is, the final pixel color is defined by the equation:

1330

#

1331

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

1332

#

1333

# This means that a value of 1.0 corresponds to a solid color, whereas

1334

# a value of 0.0 corresponds to a completely transparent color.

1335

},

1336

},

1337

"dashStyle": "A String", # The dash style of the outline.

1338

"propertyState": "A String", # The outline property state.

1339

#

1340

# Updating the outline on a page element will implicitly update this field

1341

# to `RENDERED`, unless another value is specified in the same request. To

1342

# have no outline on a page element, set this field to `NOT_RENDERED`. In

1343

# this case, any other outline fields set in the same request will be

1344

# ignored.

1345

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline.

1346

"unit": "A String", # The units for magnitude.

1347

"magnitude": 3.14, # The magnitude.

},

},

},

},

"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are

1353

# represented as images.

1354

# a linked chart embedded from Google Sheets.

1355

"spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.

1356

"chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is

1357

# embedded.

1358

"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30

1359

# minutes. This URL is tagged with the account of the requester. Anyone with

1360

# the URL effectively accesses the image as the original requester. Access to

1361

# the image may be lost if the presentation's sharing settings change.

1362

"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.

1363

"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.

1364

"outline": { # The outline of a PageElement. # The outline of the image. If not set, the image has no outline.

1365

#

1366

# If these fields are unset, they may be inherited from a parent placeholder

1367

# if it exists. If there is no parent, the fields will default to the value

1368

# used for new page elements created in the Slides editor, which may depend on

1369

# the page element kind.

1370

"outlineFill": { # The fill of the outline. # The fill of the outline.

1371

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

1372

# specified color value.

1373

#

1374

# If any field is unset, its value may be inherited from a parent placeholder

1375

# if it exists.

1376

"color": { # A themeable solid color value. # The color value of the solid fill.

1377

"themeColor": "A String", # An opaque theme color.

1378

"rgbColor": { # An RGB color. # An opaque RGB color.

1379

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1380

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1381

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1382

},

1383

},

1384

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

1385

# That is, the final pixel color is defined by the equation:

1386

#

1387

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

1388

#

1389

# This means that a value of 1.0 corresponds to a solid color, whereas

1390

# a value of 0.0 corresponds to a completely transparent color.

1391

},

1392

},

1393

"dashStyle": "A String", # The dash style of the outline.

1394

"propertyState": "A String", # The outline property state.

1395

#

1396

# Updating the outline on a page element will implicitly update this field

1397

# to `RENDERED`, unless another value is specified in the same request. To

1398

# have no outline on a page element, set this field to `NOT_RENDERED`. In

1399

# this case, any other outline fields set in the same request will be

1400

# ignored.

1401

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline.

1402

"unit": "A String", # The units for magnitude.

1403

"magnitude": 3.14, # The magnitude.

1404

},

1405

},

1406

"recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored.

1407

# This property is read-only.

1408

"recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color

1409

# stops.

1410

#

1411

# The colors in the gradient will replace the corresponding colors at

1412

# the same position in the color palette and apply to the image. This

1413

# property is read-only.

1414

{ # A color and position in a gradient band.

1415

"alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0,

1416

# fully opaque.

1417

"position": 3.14, # The relative position of the color stop in the gradient band measured

1418

# in percentage. The value should be in the interval [0.0, 1.0].

1419

"color": { # A themeable solid color value. # The color of the gradient stop.

1420

"themeColor": "A String", # An opaque theme color.

1421

"rgbColor": { # An RGB color. # An opaque RGB color.

1422

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1423

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1424

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

],

"name": "A String", # The name of the recolor effect.

1430

#

1431

# The name is determined from the `recolor_stops` by matching the gradient

1432

# against the colors in the page's current color scheme. This property is

1433

# read-only.

1434

},

1435

"transparency": 3.14, # The transparency effect of the image. The value should be in the interval

1436

# [0.0, 1.0], where 0 means no effect and 1 means completely transparent.

1437

# This property is read-only.

1438

"contrast": 3.14, # The contrast effect of the image. The value should be in the interval

1439

# [-1.0, 1.0], where 0 means no effect. This property is read-only.

1440

"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property

1441

# is read-only.

1442

#

1443

# If these fields are unset, they may be inherited from a parent placeholder

1444

# if it exists. If there is no parent, the fields will default to the value

1445

# used for new page elements created in the Slides editor, which may depend on

1446

# the page element kind.

1447

"alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0.

1448

"transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # Transform that encodes the translate, scale, and skew of the shadow,

1449

# relative to the alignment position.

1450

# to transform source coordinates (x,y) into destination coordinates (x', y')

1451

# according to:

1452

#

1453

# x' x = shear_y scale_y translate_y

1454

# 1 [ 1 ]

1455

#

1456

# After transformation,

1457

#

1458

# x' = scale_x * x + shear_x * y + translate_x;

1459

# y' = scale_y * y + shear_y * x + translate_y;

1460

#

1461

# This message is therefore composed of these six matrix elements.

1462

"shearY": 3.14, # The Y coordinate shearing element.

1463

"scaleY": 3.14, # The Y coordinate scaling element.

1464

"translateX": 3.14, # The X coordinate translation element.

1465

"translateY": 3.14, # The Y coordinate translation element.

1466

"scaleX": 3.14, # The X coordinate scaling element.

1467

"unit": "A String", # The units for translate elements.

1468

"shearX": 3.14, # The X coordinate shearing element.

1469

},

1470

"color": { # A themeable solid color value. # The shadow color value.

1471

"themeColor": "A String", # An opaque theme color.

1472

"rgbColor": { # An RGB color. # An opaque RGB color.

1473

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1474

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1475

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1476

},

1477

},

1478

"alignment": "A String", # The alignment point of the shadow, that sets the origin for translate,

1479

# scale and skew of the shadow. This property is read-only.

1480

"type": "A String", # The type of the shadow. This property is read-only.

1481

"propertyState": "A String", # The shadow property state.

1482

#

1483

# Updating the shadow on a page element will implicitly update this field to

1484

# `RENDERED`, unless another value is specified in the same request. To have

1485

# no shadow on a page element, set this field to `NOT_RENDERED`. In this

1486

# case, any other shadow fields set in the same request will be ignored.

1487

"rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is

1488

# read-only.

1489

"blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the

1490

# shadow becomes.

1491

"unit": "A String", # The units for magnitude.

1492

"magnitude": 3.14, # The magnitude.

1493

},

1494

},

1495

"cropProperties": { # The crop properties of an object enclosed in a container. For example, an # The crop properties of the image. If not set, the image is not cropped.

1496

# This property is read-only.

1497

# Image.

1498

#

1499

# The crop properties is represented by the offsets of four edges which define

1500

# a crop rectangle. The offsets are measured in percentage from the

1501

# corresponding edges of the object's original bounding rectangle towards

1502

# inside, relative to the object's original dimensions.

1503

#

1504

# - If the offset is in the interval (0, 1), the corresponding edge of crop

1505

# rectangle is positioned inside of the object's original bounding rectangle.

1506

# - If the offset is negative or greater than 1, the corresponding edge of crop

1507

# rectangle is positioned outside of the object's original bounding rectangle.

1508

# - If the left edge of the crop rectangle is on the right side of its right

1509

# edge, the object will be flipped horizontally.

1510

# - If the top edge of the crop rectangle is below its bottom edge, the object

1511

# will be flipped vertically.

1512

# - If all offsets and rotation angle is 0, the object is not cropped.

1513

#

1514

# After cropping, the content in the crop rectangle will be stretched to fit

1515

# its container.

1516

"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to

1517

# the right of the original bounding rectangle left edge, relative to the

1518

# object's original width.

1519

"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located

1520

# above the original bounding rectangle bottom edge, relative to the object's

1521

# original height.

1522

"topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located

1523

# below the original bounding rectangle top edge, relative to the object's

1524

# original height.

1525

"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located

1526

# to the left of the original bounding rectangle right edge, relative to the

1527

# object's original width.

1528

"angle": 3.14, # The rotation angle of the crop window around its center, in radians.

1529

# Rotation angle is applied after the offset.

1530

},

1531

"link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link.

1532

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

1533

# presentation with this ID. A page with this ID may not exist.

1534

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

1535

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

1536

# addressed by its position.

1537

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

1538

# in the presentation. There may not be a slide at this index.

1539

},

1540

"brightness": 3.14, # The brightness effect of the image. The value should be in the interval

1541

# [-1.0, 1.0], where 0 means no effect. This property is read-only.

},

},

},

"line": { # A PageElement kind representing a # A line page element.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1546

# non-connector line, straight connector, curved connector, or bent connector.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1547

"lineCategory": "A String", # The category of the line.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1548

#

1549

# It matches the `category` specified in CreateLineRequest, and can be updated with

1550

# UpdateLineCategoryRequest.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1551

"lineType": "A String", # The type of the line.

1552

"lineProperties": { # The properties of the Line. # The properties of the line.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1553

#

1554

# When unset, these fields default to values that match the appearance of

1555

# new lines created in the Slides editor.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1556

"dashStyle": "A String", # The dash style of the line.

1557

"endConnection": { # The properties for one end of a Line # The connection at the end of the line. If unset, there is no connection.

1558

#

1559

# Only lines with a Type indicating it is

1560

# a "connector" can have an `end_connection`.

1561

# connection.

1562

"connectionSiteIndex": 42, # The index of the connection site on the connected page element.

1563

#

1564

# In most cases, it corresponds to the predefined connection site index from

1565

# the ECMA-376 standard. More information on those connection sites can be

1566

# found in the description of the "cnx" attribute in section 20.1.9.9 and

1567

# Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open

1568

# XML File Formats-Fundamentals and Markup Language Reference", part 1 of

1569

# [ECMA-376 5th edition]

1570

# (http://www.ecma-international.org/publications/standards/Ecma-376.htm).

1571

#

1572

# The position of each connection site can also be viewed from Slides editor.

1573

"connectedObjectId": "A String", # The object ID of the connected page element.

1574

#

1575

# Some page elements, such as groups, tables, and lines

1576

# do not have connection sites and therefore cannot be connected to a

1577

# connector line.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1578

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1579

"link": { # A hypertext link. # The hyperlink destination of the line. If unset, there is no link.

1580

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1581

# presentation with this ID. A page with this ID may not exist.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1582

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

1583

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1584

# addressed by its position.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1585

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

1586

# in the presentation. There may not be a slide at this index.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1587

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1588

"startConnection": { # The properties for one end of a Line # The connection at the beginning of the line. If unset, there is no

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1589

# connection.

1590

#

1591

# Only lines with a Type indicating it is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1592

# a "connector" can have a `start_connection`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1593

# connection.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1594

"connectionSiteIndex": 42, # The index of the connection site on the connected page element.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1595

#

1596

# In most cases, it corresponds to the predefined connection site index from

1597

# the ECMA-376 standard. More information on those connection sites can be

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1598

# found in the description of the "cnx" attribute in section 20.1.9.9 and

1599

# Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open

1600

# XML File Formats-Fundamentals and Markup Language Reference", part 1 of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1601

# [ECMA-376 5th edition]

1602

# (http://www.ecma-international.org/publications/standards/Ecma-376.htm).

1603

#

1604

# The position of each connection site can also be viewed from Slides editor.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1605

"connectedObjectId": "A String", # The object ID of the connected page element.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1606

#

1607

# Some page elements, such as groups, tables, and lines

1608

# do not have connection sites and therefore cannot be connected to a

1609

# connector line.

1610

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1611

"startArrow": "A String", # The style of the arrow at the beginning of the line.

1612

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the line.

1613

"unit": "A String", # The units for magnitude.

1614

"magnitude": 3.14, # The magnitude.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1615

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1616

"endArrow": "A String", # The style of the arrow at the end of the line.

1617

"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1618

# lines created in the Slides editor.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1619

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1620

# specified color value.

1621

#

1622

# If any field is unset, its value may be inherited from a parent placeholder

1623

# if it exists.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1624

"color": { # A themeable solid color value. # The color value of the solid fill.

1625

"themeColor": "A String", # An opaque theme color.

1626

"rgbColor": { # An RGB color. # An opaque RGB color.

1627

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1628

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1629

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1630

},

1631

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1632

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1633

# That is, the final pixel color is defined by the equation:

1634

#

1635

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

1636

#

1637

# This means that a value of 1.0 corresponds to a solid color, whereas

1638

# a value of 0.0 corresponds to a completely transparent color.

1639

},

1640

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1641

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1642

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1643

"size": { # A width and height. # The size of the page element.

1644

"width": { # A magnitude in a single direction in the specified units. # The width of the object.

1645

"unit": "A String", # The units for magnitude.

1646

"magnitude": 3.14, # The magnitude.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1647

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1648

"height": { # A magnitude in a single direction in the specified units. # The height of the object.

1649

"unit": "A String", # The units for magnitude.

1650

"magnitude": 3.14, # The magnitude.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1651

},

1652

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1653

"elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1654

# joined collection of PageElements.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1655

"children": [ # The collection of elements in the group. The minimum size of a group is 2.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1656

# Object with schema name: PageElement

1657

],

1658

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1659

"shape": { # A PageElement kind representing a # A generic shape.

1660

# generic shape that does not have a more specific classification.

1661

"placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are shapes that are inherit from corresponding placeholders on

1662

# layouts and masters.

1663

#

1664

# If set, the shape is a placeholder shape and any inherited properties

1665

# can be resolved by looking at the parent placeholder identified by the

1666

# Placeholder.parent_object_id field.

1667

"index": 42, # The index of the placeholder. If the same placeholder types are present in

1668

# the same page, they would have different index values.

1669

"type": "A String", # The type of the placeholder.

1670

"parentObjectId": "A String", # The object ID of this shape's parent placeholder.

1671

# If unset, the parent placeholder shape does not exist, so the shape does

1672

# not inherit properties from any other shape.

1673

},

1674

"shapeProperties": { # The properties of a Shape. # The properties of the shape.

1675

#

1676

# If the shape is a placeholder shape as determined by the

1677

# placeholder field, then these

1678

# properties may be inherited from a parent placeholder shape.

1679

# Determining the rendered value of the property depends on the corresponding

1680

# property_state field value.

1681

"link": { # A hypertext link. # The hyperlink destination of the shape. If unset, there is no link. Links

1682

# are not inherited from parent placeholders.

1683

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

1684

# presentation with this ID. A page with this ID may not exist.

1685

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

1686

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

1687

# addressed by its position.

1688

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

1689

# in the presentation. There may not be a slide at this index.

1690

},

1691

"shapeBackgroundFill": { # The shape background fill. # The background fill of the shape. If unset, the background fill is

1692

# inherited from a parent placeholder if it exists. If the shape has no

1693

# parent, then the default background fill depends on the shape type,

1694

# matching the defaults for new shapes created in the Slides editor.

1695

"propertyState": "A String", # The background fill property state.

1696

#

1697

# Updating the fill on a shape will implicitly update this field to

1698

# `RENDERED`, unless another value is specified in the same request. To

1699

# have no fill on a shape, set this field to `NOT_RENDERED`. In this case,

1700

# any other fill fields set in the same request will be ignored.

1701

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

1702

# specified color value.

1703

#

1704

# If any field is unset, its value may be inherited from a parent placeholder

1705

# if it exists.

1706

"color": { # A themeable solid color value. # The color value of the solid fill.

1707

"themeColor": "A String", # An opaque theme color.

1708

"rgbColor": { # An RGB color. # An opaque RGB color.

1709

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1710

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1711

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1712

},

1713

},

1714

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

1715

# That is, the final pixel color is defined by the equation:

1716

#

1717

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

1718

#

1719

# This means that a value of 1.0 corresponds to a solid color, whereas

1720

# a value of 0.0 corresponds to a completely transparent color.

1721

},

1722

},

1723

"outline": { # The outline of a PageElement. # The outline of the shape. If unset, the outline is inherited from a

1724

# parent placeholder if it exists. If the shape has no parent, then the

1725

# default outline depends on the shape type, matching the defaults for

1726

# new shapes created in the Slides editor.

1727

#

1728

# If these fields are unset, they may be inherited from a parent placeholder

1729

# if it exists. If there is no parent, the fields will default to the value

1730

# used for new page elements created in the Slides editor, which may depend on

1731

# the page element kind.

1732

"outlineFill": { # The fill of the outline. # The fill of the outline.

1733

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

1734

# specified color value.

1735

#

1736

# If any field is unset, its value may be inherited from a parent placeholder

1737

# if it exists.

1738

"color": { # A themeable solid color value. # The color value of the solid fill.

1739

"themeColor": "A String", # An opaque theme color.

1740

"rgbColor": { # An RGB color. # An opaque RGB color.

1741

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1742

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1743

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1744

},

1745

},

1746

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

1747

# That is, the final pixel color is defined by the equation:

1748

#

1749

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

1750

#

1751

# This means that a value of 1.0 corresponds to a solid color, whereas

1752

# a value of 0.0 corresponds to a completely transparent color.

1753

},

1754

},

1755

"dashStyle": "A String", # The dash style of the outline.

1756

"propertyState": "A String", # The outline property state.

1757

#

1758

# Updating the outline on a page element will implicitly update this field

1759

# to `RENDERED`, unless another value is specified in the same request. To

1760

# have no outline on a page element, set this field to `NOT_RENDERED`. In

1761

# this case, any other outline fields set in the same request will be

1762

# ignored.

1763

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline.

1764

"unit": "A String", # The units for magnitude.

1765

"magnitude": 3.14, # The magnitude.

1766

},

1767

},

1768

"shadow": { # The shadow properties of a page element. # The shadow properties of the shape. If unset, the shadow is inherited from

1769

# a parent placeholder if it exists. If the shape has no parent, then the

1770

# default shadow matches the defaults for new shapes created in the Slides

1771

# editor. This property is read-only.

1772

#

1773

# If these fields are unset, they may be inherited from a parent placeholder

1774

# if it exists. If there is no parent, the fields will default to the value

1775

# used for new page elements created in the Slides editor, which may depend on

1776

# the page element kind.

1777

"alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0.

1778

"transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # Transform that encodes the translate, scale, and skew of the shadow,

1779

# relative to the alignment position.

1780

# to transform source coordinates (x,y) into destination coordinates (x', y')

1781

# according to:

1782

#

1783

# x' x = shear_y scale_y translate_y

1784

# 1 [ 1 ]

1785

#

1786

# After transformation,

1787

#

1788

# x' = scale_x * x + shear_x * y + translate_x;

1789

# y' = scale_y * y + shear_y * x + translate_y;

1790

#

1791

# This message is therefore composed of these six matrix elements.

1792

"shearY": 3.14, # The Y coordinate shearing element.

1793

"scaleY": 3.14, # The Y coordinate scaling element.

1794

"translateX": 3.14, # The X coordinate translation element.

1795

"translateY": 3.14, # The Y coordinate translation element.

1796

"scaleX": 3.14, # The X coordinate scaling element.

1797

"unit": "A String", # The units for translate elements.

1798

"shearX": 3.14, # The X coordinate shearing element.

1799

},

1800

"color": { # A themeable solid color value. # The shadow color value.

1801

"themeColor": "A String", # An opaque theme color.

1802

"rgbColor": { # An RGB color. # An opaque RGB color.

1803

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1804

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1805

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1806

},

1807

},

1808

"alignment": "A String", # The alignment point of the shadow, that sets the origin for translate,

1809

# scale and skew of the shadow. This property is read-only.

1810

"type": "A String", # The type of the shadow. This property is read-only.

1811

"propertyState": "A String", # The shadow property state.

1812

#

1813

# Updating the shadow on a page element will implicitly update this field to

1814

# `RENDERED`, unless another value is specified in the same request. To have

1815

# no shadow on a page element, set this field to `NOT_RENDERED`. In this

1816

# case, any other shadow fields set in the same request will be ignored.

1817

"rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is

1818

# read-only.

1819

"blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the

1820

# shadow becomes.

1821

"unit": "A String", # The units for magnitude.

1822

"magnitude": 3.14, # The magnitude.

1823

},

1824

},

1825

"contentAlignment": "A String", # The alignment of the content in the shape. If unspecified,

1826

# the alignment is inherited from a parent placeholder if it exists. If the

1827

# shape has no parent, the default alignment matches the alignment for new

1828

# shapes created in the Slides editor.

1829

},

1830

"text": { # The general text content. The text must reside in a compatible shape (e.g. # The text content of the shape.

1831

# text box or rectangle) or a table cell in a page.

1832

"lists": { # The bulleted lists contained in this text, keyed by list ID.

1833

"a_key": { # A List describes the look and feel of bullets belonging to paragraphs

1834

# associated with a list. A paragraph that is part of a list has an implicit

1835

# reference to that list's ID.

1836

"listId": "A String", # The ID of the list.

1837

"nestingLevel": { # A map of nesting levels to the properties of bullets at the associated

1838

# level. A list has at most nine levels of nesting, so the possible values

1839

# for the keys of this map are 0 through 8, inclusive.

1840

"a_key": { # Contains properties describing the look and feel of a list bullet at a given

1841

# level of nesting.

1842

"bulletStyle": { # Represents the styling that can be applied to a TextRun. # The style of a bullet at this level of nesting.

1843

#

1844

# If this text is contained in a shape with a parent placeholder, then these text styles may be

1845

# inherited from the parent. Which text styles are inherited depend on the

1846

# nesting level of lists:

1847

#

1848

# * A text run in a paragraph that is not in a list will inherit its text style

1849

# from the the newline character in the paragraph at the 0 nesting level of

1850

# the list inside the parent placeholder.

1851

# * A text run in a paragraph that is in a list will inherit its text style

1852

# from the newline character in the paragraph at its corresponding nesting

1853

# level of the list inside the parent placeholder.

1854

#

1855

# Inherited text styles are represented as unset fields in this message. If

1856

# text is contained in a shape without a parent placeholder, unsetting these

1857

# fields will revert the style to a value matching the defaults in the Slides

1858

# editor.

1859

"strikethrough": True or False, # Whether or not the text is struck through.

1860

"fontFamily": "A String", # The font family of the text.

1861

#

1862

# The font family can be any font from the Font menu in Slides or from

1863

# [Google Fonts] (https://fonts.google.com/). If the font name is

1864

# unrecognized, the text is rendered in `Arial`.

1865

#

1866

# Some fonts can affect the weight of the text. If an update request

1867

# specifies values for both `font_family` and `bold`, the explicitly-set

1868

# `bold` value is used.

1869

"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or

1870

# transparent, depending on if the `opaque_color` field in it is set.

1871

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

1872

# a transparent color.

1873

"themeColor": "A String", # An opaque theme color.

1874

"rgbColor": { # An RGB color. # An opaque RGB color.

1875

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1876

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1877

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in

1882

# points.

1883

"unit": "A String", # The units for magnitude.

1884

"magnitude": 3.14, # The magnitude.

1885

},

1886

"baselineOffset": "A String", # The text's vertical offset from its normal position.

1887

#

1888

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

1889

# rendered in a smaller font size, computed based on the `font_size` field.

1890

# The `font_size` itself is not affected by changes in this field.

1891

"foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or

1892

# transparent, depending on if the `opaque_color` field in it is set.

1893

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

1894

# a transparent color.

1895

"themeColor": "A String", # An opaque theme color.

1896

"rgbColor": { # An RGB color. # An opaque RGB color.

1897

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1898

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1899

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"bold": True or False, # Whether or not the text is rendered as bold.

1904

"italic": True or False, # Whether or not the text is italicized.

1905

"smallCaps": True or False, # Whether or not the text is in small capital letters.

1906

"weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text.

1907

#

1908

# This field is an extension of `font_family` meant to support explicit font

1909

# weights without breaking backwards compatibility. As such, when reading the

1910

# style of a range of text, the value of `weighted_font_family#font_family`

1911

# will always be equal to that of `font_family`. However, when writing, if

1912

# both fields are included in the field mask (either explicitly or through

1913

# the wildcard `"*"`), their values are reconciled as follows:

1914

#

1915

# * If `font_family` is set and `weighted_font_family` is not, the value of

1916

# `font_family` is applied with weight `400` ("normal").

1917

# * If both fields are set, the value of `font_family` must match that of

1918

# `weighted_font_family#font_family`. If so, the font family and weight of

1919

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

1920

# returned.

1921

# * If `weighted_font_family` is set and `font_family` is not, the font

1922

# family and weight of `weighted_font_family` is applied.

1923

# * If neither field is set, the font family and weight of the text inherit

1924

# from the parent. Note that these properties cannot inherit separately

1925

# from each other.

1926

#

1927

# If an update request specifies values for both `weighted_font_family` and

1928

# `bold`, the `weighted_font_family` is applied first, then `bold`.

1929

#

1930

# If `weighted_font_family#weight` is not set, it defaults to `400`.

1931

#

1932

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

1933

# must also be set with a non-empty value. Otherwise, a 400 bad request error

1934

# is returned.

1935

"fontFamily": "A String", # The font family of the text.

1936

#

1937

# The font family can be any font from the Font menu in Slides or from

1938

# [Google Fonts] (https://fonts.google.com/). If the font name is

1939

# unrecognized, the text is rendered in `Arial`.

1940

"weight": 42, # The rendered weight of the text. This field can have any value that is a

1941

# multiple of `100` between `100` and `900`, inclusive. This range

1942

# corresponds to the numerical values described in the CSS 2.1

1943

# Specification,

1944

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

1945

# with non-numerical values disallowed. Weights greater than or equal to

1946

# `700` are considered bold, and weights less than `700`are not bold. The

1947

# default value is `400` ("normal").

1948

},

1949

"underline": True or False, # Whether or not the text is underlined.

1950

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

1951

# are not inherited from parent text.

1952

#

1953

# Changing the link in an update request causes some other changes to the

1954

# text style of the range:

1955

#

1956

# * When setting a link, the text foreground color will be set to

1957

# ThemeColorType.HYPERLINK and the text will

1958

# be underlined. If these fields are modified in the same

1959

# request, those values will be used instead of the link defaults.

1960

# * Setting a link on a text range that overlaps with an existing link will

1961

# also update the existing link to point to the new URL.

1962

# * Links are not settable on newline characters. As a result, setting a link

1963

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

1964

# will separate the newline character(s) into their own text runs. The

1965

# link will be applied separately to the runs before and after the newline.

1966

# * Removing a link will update the text style of the range to match the

1967

# style of the preceding text (or the default text styles if the preceding

1968

# text is another link) unless different styles are being set in the same

1969

# request.

1970

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

1971

# presentation with this ID. A page with this ID may not exist.

1972

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

1973

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

1974

# addressed by its position.

1975

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

1976

# in the presentation. There may not be a slide at this index.

},

},

},

},

},

},

"textElements": [ # The text contents broken down into its component parts, including styling

1984

# information. This property is read-only.

1985

{ # A TextElement describes the content of a range of indices in the text content

1986

# of a Shape or TableCell.

1987

"paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph.

1988

#

1989

# The `start_index` and `end_index` of this TextElement represent the

1990

# range of the paragraph. Other TextElements with an index range contained

1991

# inside this paragraph's range are considered to be part of this

1992

# paragraph. The range of indices of two separate paragraphs will never

1993

# overlap.

1994

"bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not

1995

# belong to a list.

1996

"listId": "A String", # The ID of the list this paragraph belongs to.

1997

"glyph": "A String", # The rendered bullet glyph for this paragraph.

1998

"nestingLevel": 42, # The nesting level of this paragraph in the list.

1999

"bulletStyle": { # Represents the styling that can be applied to a TextRun. # The paragraph specific text style applied to this bullet.

2000

#

2001

# If this text is contained in a shape with a parent placeholder, then these text styles may be

2002

# inherited from the parent. Which text styles are inherited depend on the

2003

# nesting level of lists:

2004

#

2005

# * A text run in a paragraph that is not in a list will inherit its text style

2006

# from the the newline character in the paragraph at the 0 nesting level of

2007

# the list inside the parent placeholder.

2008

# * A text run in a paragraph that is in a list will inherit its text style

2009

# from the newline character in the paragraph at its corresponding nesting

2010

# level of the list inside the parent placeholder.

2011

#

2012

# Inherited text styles are represented as unset fields in this message. If

2013

# text is contained in a shape without a parent placeholder, unsetting these

2014

# fields will revert the style to a value matching the defaults in the Slides

2015

# editor.

2016

"strikethrough": True or False, # Whether or not the text is struck through.

2017

"fontFamily": "A String", # The font family of the text.

2018

#

2019

# The font family can be any font from the Font menu in Slides or from

2020

# [Google Fonts] (https://fonts.google.com/). If the font name is

2021

# unrecognized, the text is rendered in `Arial`.

2022

#

2023

# Some fonts can affect the weight of the text. If an update request

2024

# specifies values for both `font_family` and `bold`, the explicitly-set

2025

# `bold` value is used.

2026

"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or

2027

# transparent, depending on if the `opaque_color` field in it is set.

2028

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

2029

# a transparent color.

2030

"themeColor": "A String", # An opaque theme color.

2031

"rgbColor": { # An RGB color. # An opaque RGB color.

2032

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2033

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2034

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in

2039

# points.

2040

"unit": "A String", # The units for magnitude.

2041

"magnitude": 3.14, # The magnitude.

2042

},

2043

"baselineOffset": "A String", # The text's vertical offset from its normal position.

2044

#

2045

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

2046

# rendered in a smaller font size, computed based on the `font_size` field.

2047

# The `font_size` itself is not affected by changes in this field.

2048

"foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or

2049

# transparent, depending on if the `opaque_color` field in it is set.

2050

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

2051

# a transparent color.

2052

"themeColor": "A String", # An opaque theme color.

2053

"rgbColor": { # An RGB color. # An opaque RGB color.

2054

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2055

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2056

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"bold": True or False, # Whether or not the text is rendered as bold.

2061

"italic": True or False, # Whether or not the text is italicized.

2062

"smallCaps": True or False, # Whether or not the text is in small capital letters.

2063

"weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text.

2064

#

2065

# This field is an extension of `font_family` meant to support explicit font

2066

# weights without breaking backwards compatibility. As such, when reading the

2067

# style of a range of text, the value of `weighted_font_family#font_family`

2068

# will always be equal to that of `font_family`. However, when writing, if

2069

# both fields are included in the field mask (either explicitly or through

2070

# the wildcard `"*"`), their values are reconciled as follows:

2071

#

2072

# * If `font_family` is set and `weighted_font_family` is not, the value of

2073

# `font_family` is applied with weight `400` ("normal").

2074

# * If both fields are set, the value of `font_family` must match that of

2075

# `weighted_font_family#font_family`. If so, the font family and weight of

2076

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

2077

# returned.

2078

# * If `weighted_font_family` is set and `font_family` is not, the font

2079

# family and weight of `weighted_font_family` is applied.

2080

# * If neither field is set, the font family and weight of the text inherit

2081

# from the parent. Note that these properties cannot inherit separately

2082

# from each other.

2083

#

2084

# If an update request specifies values for both `weighted_font_family` and

2085

# `bold`, the `weighted_font_family` is applied first, then `bold`.

2086

#

2087

# If `weighted_font_family#weight` is not set, it defaults to `400`.

2088

#

2089

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

2090

# must also be set with a non-empty value. Otherwise, a 400 bad request error

2091

# is returned.

2092

"fontFamily": "A String", # The font family of the text.

2093

#

2094

# The font family can be any font from the Font menu in Slides or from

2095

# [Google Fonts] (https://fonts.google.com/). If the font name is

2096

# unrecognized, the text is rendered in `Arial`.

2097

"weight": 42, # The rendered weight of the text. This field can have any value that is a

2098

# multiple of `100` between `100` and `900`, inclusive. This range

2099

# corresponds to the numerical values described in the CSS 2.1

2100

# Specification,

2101

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

2102

# with non-numerical values disallowed. Weights greater than or equal to

2103

# `700` are considered bold, and weights less than `700`are not bold. The

2104

# default value is `400` ("normal").

2105

},

2106

"underline": True or False, # Whether or not the text is underlined.

2107

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

2108

# are not inherited from parent text.

2109

#

2110

# Changing the link in an update request causes some other changes to the

2111

# text style of the range:

2112

#

2113

# * When setting a link, the text foreground color will be set to

2114

# ThemeColorType.HYPERLINK and the text will

2115

# be underlined. If these fields are modified in the same

2116

# request, those values will be used instead of the link defaults.

2117

# * Setting a link on a text range that overlaps with an existing link will

2118

# also update the existing link to point to the new URL.

2119

# * Links are not settable on newline characters. As a result, setting a link

2120

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

2121

# will separate the newline character(s) into their own text runs. The

2122

# link will be applied separately to the runs before and after the newline.

2123

# * Removing a link will update the text style of the range to match the

2124

# style of the preceding text (or the default text styles if the preceding

2125

# text is another link) unless different styles are being set in the same

2126

# request.

2127

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

2128

# presentation with this ID. A page with this ID may not exist.

2129

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

2130

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

2131

# addressed by its position.

2132

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

2133

# in the presentation. There may not be a slide at this index.

},

},

},

"style": { # Styles that apply to a whole paragraph. # The paragraph's style

2138

#

2139

# If this text is contained in a shape with a parent placeholder, then these paragraph styles may be

2140

# inherited from the parent. Which paragraph styles are inherited depend on the

2141

# nesting level of lists:

2142

#

2143

# * A paragraph not in a list will inherit its paragraph style from the

2144

# paragraph at the 0 nesting level of the list inside the parent placeholder.

2145

# * A paragraph in a list will inherit its paragraph style from the paragraph

2146

# at its corresponding nesting level of the list inside the parent

2147

# placeholder.

2148

#

2149

# Inherited paragraph styles are represented as unset fields in this message.

2150

"indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to

2151

# the start of the text, based on the current text direction. If unset, the

2152

# value is inherited from the parent.

2153

"unit": "A String", # The units for magnitude.

2154

"magnitude": 3.14, # The magnitude.

2155

},

2156

"indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to

2157

# the end of the text, based on the current text direction. If unset, the

2158

# value is inherited from the parent.

2159

"unit": "A String", # The units for magnitude.

2160

"magnitude": 3.14, # The magnitude.

2161

},

2162

"spacingMode": "A String", # The spacing mode for the paragraph.

2163

"spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is

2164

# inherited from the parent.

2165

"unit": "A String", # The units for magnitude.

2166

"magnitude": 3.14, # The magnitude.

2167

},

2168

"indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph.

2169

# If unset, the value is inherited from the parent.

2170

"unit": "A String", # The units for magnitude.

2171

"magnitude": 3.14, # The magnitude.

2172

},

2173

"alignment": "A String", # The text alignment for this paragraph.

2174

"spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is

2175

# inherited from the parent.

2176

"unit": "A String", # The units for magnitude.

2177

"magnitude": 3.14, # The magnitude.

2178

},

2179

"direction": "A String", # The text direction of this paragraph. If unset, the value defaults to

2180

# LEFT_TO_RIGHT since

2181

# text direction is not inherited.

2182

"lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal

2183

# is represented as 100.0. If unset, the value is inherited from the parent.

2184

},

2185

},

2186

"autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically

2187

# replaced with content that can change over time.

2188

"type": "A String", # The type of this auto text.

2189

"content": "A String", # The rendered content of this auto text, if available.

2190

"style": { # Represents the styling that can be applied to a TextRun. # The styling applied to this auto text.

2191

#

2192

# If this text is contained in a shape with a parent placeholder, then these text styles may be

2193

# inherited from the parent. Which text styles are inherited depend on the

2194

# nesting level of lists:

2195

#

2196

# * A text run in a paragraph that is not in a list will inherit its text style

2197

# from the the newline character in the paragraph at the 0 nesting level of

2198

# the list inside the parent placeholder.

2199

# * A text run in a paragraph that is in a list will inherit its text style

2200

# from the newline character in the paragraph at its corresponding nesting

2201

# level of the list inside the parent placeholder.

2202

#

2203

# Inherited text styles are represented as unset fields in this message. If

2204

# text is contained in a shape without a parent placeholder, unsetting these

2205

# fields will revert the style to a value matching the defaults in the Slides

2206

# editor.

2207

"strikethrough": True or False, # Whether or not the text is struck through.

2208

"fontFamily": "A String", # The font family of the text.

2209

#

2210

# The font family can be any font from the Font menu in Slides or from

2211

# [Google Fonts] (https://fonts.google.com/). If the font name is

2212

# unrecognized, the text is rendered in `Arial`.

2213

#

2214

# Some fonts can affect the weight of the text. If an update request

2215

# specifies values for both `font_family` and `bold`, the explicitly-set

2216

# `bold` value is used.

2217

"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or

2218

# transparent, depending on if the `opaque_color` field in it is set.

2219

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

2220

# a transparent color.

2221

"themeColor": "A String", # An opaque theme color.

2222

"rgbColor": { # An RGB color. # An opaque RGB color.

2223

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2224

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2225

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in

2230

# points.

2231

"unit": "A String", # The units for magnitude.

2232

"magnitude": 3.14, # The magnitude.

2233

},

2234

"baselineOffset": "A String", # The text's vertical offset from its normal position.

2235

#

2236

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

2237

# rendered in a smaller font size, computed based on the `font_size` field.

2238

# The `font_size` itself is not affected by changes in this field.

2239

"foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or

2240

# transparent, depending on if the `opaque_color` field in it is set.

2241

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

2242

# a transparent color.

2243

"themeColor": "A String", # An opaque theme color.

2244

"rgbColor": { # An RGB color. # An opaque RGB color.

2245

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2246

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2247

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"bold": True or False, # Whether or not the text is rendered as bold.

2252

"italic": True or False, # Whether or not the text is italicized.

2253

"smallCaps": True or False, # Whether or not the text is in small capital letters.

2254

"weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text.

2255

#

2256

# This field is an extension of `font_family` meant to support explicit font

2257

# weights without breaking backwards compatibility. As such, when reading the

2258

# style of a range of text, the value of `weighted_font_family#font_family`

2259

# will always be equal to that of `font_family`. However, when writing, if

2260

# both fields are included in the field mask (either explicitly or through

2261

# the wildcard `"*"`), their values are reconciled as follows:

2262

#

2263

# * If `font_family` is set and `weighted_font_family` is not, the value of

2264

# `font_family` is applied with weight `400` ("normal").

2265

# * If both fields are set, the value of `font_family` must match that of

2266

# `weighted_font_family#font_family`. If so, the font family and weight of

2267

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

2268

# returned.

2269

# * If `weighted_font_family` is set and `font_family` is not, the font

2270

# family and weight of `weighted_font_family` is applied.

2271

# * If neither field is set, the font family and weight of the text inherit

2272

# from the parent. Note that these properties cannot inherit separately

2273

# from each other.

2274

#

2275

# If an update request specifies values for both `weighted_font_family` and

2276

# `bold`, the `weighted_font_family` is applied first, then `bold`.

2277

#

2278

# If `weighted_font_family#weight` is not set, it defaults to `400`.

2279

#

2280

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

2281

# must also be set with a non-empty value. Otherwise, a 400 bad request error

2282

# is returned.

2283

"fontFamily": "A String", # The font family of the text.

2284

#

2285

# The font family can be any font from the Font menu in Slides or from

2286

# [Google Fonts] (https://fonts.google.com/). If the font name is

2287

# unrecognized, the text is rendered in `Arial`.

2288

"weight": 42, # The rendered weight of the text. This field can have any value that is a

2289

# multiple of `100` between `100` and `900`, inclusive. This range

2290

# corresponds to the numerical values described in the CSS 2.1

2291

# Specification,

2292

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

2293

# with non-numerical values disallowed. Weights greater than or equal to

2294

# `700` are considered bold, and weights less than `700`are not bold. The

2295

# default value is `400` ("normal").

2296

},

2297

"underline": True or False, # Whether or not the text is underlined.

2298

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

2299

# are not inherited from parent text.

2300

#

2301

# Changing the link in an update request causes some other changes to the

2302

# text style of the range:

2303

#

2304

# * When setting a link, the text foreground color will be set to

2305

# ThemeColorType.HYPERLINK and the text will

2306

# be underlined. If these fields are modified in the same

2307

# request, those values will be used instead of the link defaults.

2308

# * Setting a link on a text range that overlaps with an existing link will

2309

# also update the existing link to point to the new URL.

2310

# * Links are not settable on newline characters. As a result, setting a link

2311

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

2312

# will separate the newline character(s) into their own text runs. The

2313

# link will be applied separately to the runs before and after the newline.

2314

# * Removing a link will update the text style of the range to match the

2315

# style of the preceding text (or the default text styles if the preceding

2316

# text is another link) unless different styles are being set in the same

2317

# request.

2318

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

2319

# presentation with this ID. A page with this ID may not exist.

2320

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

2321

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

2322

# addressed by its position.

2323

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

2324

# in the presentation. There may not be a slide at this index.

},

},

},

"textRun": { # A TextElement kind that represents a run of text that all has the same # A TextElement representing a run of text where all of the characters

2329

# in the run have the same TextStyle.

2330

#

2331

# The `start_index` and `end_index` of TextRuns will always be fully

2332

# contained in the index range of a single `paragraph_marker` TextElement.

2333

# In other words, a TextRun will never span multiple paragraphs.

2334

# styling.

2335

"content": "A String", # The text of this run.

2336

"style": { # Represents the styling that can be applied to a TextRun. # The styling applied to this run.

2337

#

2338

# If this text is contained in a shape with a parent placeholder, then these text styles may be

2339

# inherited from the parent. Which text styles are inherited depend on the

2340

# nesting level of lists:

2341

#

2342

# * A text run in a paragraph that is not in a list will inherit its text style

2343

# from the the newline character in the paragraph at the 0 nesting level of

2344

# the list inside the parent placeholder.

2345

# * A text run in a paragraph that is in a list will inherit its text style

2346

# from the newline character in the paragraph at its corresponding nesting

2347

# level of the list inside the parent placeholder.

2348

#

2349

# Inherited text styles are represented as unset fields in this message. If

2350

# text is contained in a shape without a parent placeholder, unsetting these

2351

# fields will revert the style to a value matching the defaults in the Slides

2352

# editor.

2353

"strikethrough": True or False, # Whether or not the text is struck through.

2354

"fontFamily": "A String", # The font family of the text.

2355

#

2356

# The font family can be any font from the Font menu in Slides or from

2357

# [Google Fonts] (https://fonts.google.com/). If the font name is

2358

# unrecognized, the text is rendered in `Arial`.

2359

#

2360

# Some fonts can affect the weight of the text. If an update request

2361

# specifies values for both `font_family` and `bold`, the explicitly-set

2362

# `bold` value is used.

2363

"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or

2364

# transparent, depending on if the `opaque_color` field in it is set.

2365

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

2366

# a transparent color.

2367

"themeColor": "A String", # An opaque theme color.

2368

"rgbColor": { # An RGB color. # An opaque RGB color.

2369

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2370

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2371

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in

2376

# points.

2377

"unit": "A String", # The units for magnitude.

2378

"magnitude": 3.14, # The magnitude.

2379

},

2380

"baselineOffset": "A String", # The text's vertical offset from its normal position.

2381

#

2382

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

2383

# rendered in a smaller font size, computed based on the `font_size` field.

2384

# The `font_size` itself is not affected by changes in this field.

2385

"foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or

2386

# transparent, depending on if the `opaque_color` field in it is set.

2387

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

2388

# a transparent color.

2389

"themeColor": "A String", # An opaque theme color.

2390

"rgbColor": { # An RGB color. # An opaque RGB color.

2391

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2392

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2393

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

},

},

},

"bold": True or False, # Whether or not the text is rendered as bold.

2398

"italic": True or False, # Whether or not the text is italicized.

2399

"smallCaps": True or False, # Whether or not the text is in small capital letters.

2400

"weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text.

2401

#

2402

# This field is an extension of `font_family` meant to support explicit font

2403

# weights without breaking backwards compatibility. As such, when reading the

2404

# style of a range of text, the value of `weighted_font_family#font_family`

2405

# will always be equal to that of `font_family`. However, when writing, if

2406

# both fields are included in the field mask (either explicitly or through

2407

# the wildcard `"*"`), their values are reconciled as follows:

2408

#

2409

# * If `font_family` is set and `weighted_font_family` is not, the value of

2410

# `font_family` is applied with weight `400` ("normal").

2411

# * If both fields are set, the value of `font_family` must match that of

2412

# `weighted_font_family#font_family`. If so, the font family and weight of

2413

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

2414

# returned.

2415

# * If `weighted_font_family` is set and `font_family` is not, the font

2416

# family and weight of `weighted_font_family` is applied.

2417

# * If neither field is set, the font family and weight of the text inherit

2418

# from the parent. Note that these properties cannot inherit separately

2419

# from each other.

2420

#

2421

# If an update request specifies values for both `weighted_font_family` and

2422

# `bold`, the `weighted_font_family` is applied first, then `bold`.

2423

#

2424

# If `weighted_font_family#weight` is not set, it defaults to `400`.

2425

#

2426

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

2427

# must also be set with a non-empty value. Otherwise, a 400 bad request error

2428

# is returned.

2429

"fontFamily": "A String", # The font family of the text.

2430

#

2431

# The font family can be any font from the Font menu in Slides or from

2432

# [Google Fonts] (https://fonts.google.com/). If the font name is

2433

# unrecognized, the text is rendered in `Arial`.

2434

"weight": 42, # The rendered weight of the text. This field can have any value that is a

2435

# multiple of `100` between `100` and `900`, inclusive. This range

2436

# corresponds to the numerical values described in the CSS 2.1

2437

# Specification,

2438

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

2439

# with non-numerical values disallowed. Weights greater than or equal to

2440

# `700` are considered bold, and weights less than `700`are not bold. The

2441

# default value is `400` ("normal").

2442

},

2443

"underline": True or False, # Whether or not the text is underlined.

2444

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

2445

# are not inherited from parent text.

2446

#

2447

# Changing the link in an update request causes some other changes to the

2448

# text style of the range:

2449

#

2450

# * When setting a link, the text foreground color will be set to

2451

# ThemeColorType.HYPERLINK and the text will

2452

# be underlined. If these fields are modified in the same

2453

# request, those values will be used instead of the link defaults.

2454

# * Setting a link on a text range that overlaps with an existing link will

2455

# also update the existing link to point to the new URL.

2456

# * Links are not settable on newline characters. As a result, setting a link

2457

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

2458

# will separate the newline character(s) into their own text runs. The

2459

# link will be applied separately to the runs before and after the newline.

2460

# * Removing a link will update the text style of the range to match the

2461

# style of the preceding text (or the default text styles if the preceding

2462

# text is another link) unless different styles are being set in the same

2463

# request.

2464

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

2465

# presentation with this ID. A page with this ID may not exist.

2466

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

2467

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

2468

# addressed by its position.

2469

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

2470

# in the presentation. There may not be a slide at this index.

},

},

},

"endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code

2475

# units.

2476

"startIndex": 42, # The zero-based start index of this text element, in Unicode code units.

},

],

},

"shapeType": "A String", # The type of the shape.

2481

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2482

},

2483

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2484

"revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in

2485

# update requests to assert that the presentation revision hasn't changed

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2486

# since the last read operation. Only populated if the user has edit access

2487

# to the presentation.

2488

#

2489

# The format of the revision ID may change over time, so it should be treated

2490

# opaquely. A returned revision ID is only guaranteed to be valid for 24

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2491

# hours after it has been returned and cannot be shared across users. If the

2492

# revision ID is unchanged between calls, then the presentation has not

2493

# changed. Conversely, a changed ID (for the same presentation and user)

2494

# usually means the presentation has been updated; however, a changed ID can

2495

# also be due to internal factors such as ID format changes.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

2499

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2500

<code class="details" id="getThumbnail">getThumbnail(presentationId, pageObjectId, thumbnailProperties_thumbnailSize=None, thumbnailProperties_mimeType=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

2501

<pre>Generates a thumbnail of the latest version of the specified page in the

2502

presentation and returns a URL to the thumbnail image.

2503

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2504

This request counts as an [expensive read request](/slides/limits) for

2505

quota purposes.

2506

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

2507

Args:

2508

presentationId: string, The ID of the presentation to retrieve. (required)

2509

pageObjectId: string, The object ID of the page whose thumbnail to retrieve. (required)

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

2510

thumbnailProperties_thumbnailSize: string, The optional thumbnail image size.

2511

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2512

If you don't specify the size, the server chooses a default size of the

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

2513

image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2514

thumbnailProperties_mimeType: string, The optional mime type of the thumbnail image.

2515

2516

If you don't specify the mime type, the mime type defaults to PNG.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

2517

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2524

2525

{ # The thumbnail of a page.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2526

"contentUrl": "A String", # The content URL of the thumbnail image.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

2527

#

2528

# The URL to the image has a default lifetime of 30 minutes.

2529

# This URL is tagged with the account of the requester. Anyone with the URL

2530

# effectively accesses the image as the original requester. Access to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2531

# image may be lost if the presentation's sharing settings change.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

2532

# The mime type of the thumbnail image is the same as specified in the

2533

# `GetPageThumbnailRequest`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2534

"width": 42, # The positive width in pixels of the thumbnail image.

2535

"height": 42, # The positive height in pixels of the thumbnail image.

Sai Cheemalapati