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

81

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

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.

100

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

101

# relevant for pages with page_type LAYOUT.

Bu Sun Kim

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

[diff] [blame]

102

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

Jon Wayne Parrott

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

[diff] [blame]

103

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

104

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

105

},

106

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

107

{ # A visual element rendered on a page.

108

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

109

# word art.

110

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

111

},

Dan O'Meara

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

[diff] [blame^]

112

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

113

# text.

Jon Wayne Parrott

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

[diff] [blame]

114

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

115

# google.apps.slides.v1.Page and

116

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

117

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

118

# text.

119

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

120

# image.

121

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

122

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

123

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

124

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

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

Jon Wayne Parrott

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

[diff] [blame]

127

#

128

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

129

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

130

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

131

# the page element kind.

Jon Wayne Parrott

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

[diff] [blame]

132

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

133

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

134

# specified color value.

135

#

136

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

137

# if it exists.

138

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

139

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

140

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

141

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

142

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

143

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

144

},

145

},

146

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

147

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

148

#

149

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

150

#

151

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

152

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

153

},

154

},

Sai Cheemalapati

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

[diff] [blame]

155

"propertyState": "A String", # The outline property state.

156

#

Bu Sun Kim

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

[diff] [blame]

157

# Updating the outline on a page element will implicitly update this field

158

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

159

# have no outline on a page element, set this field to `NOT_RENDERED`. In

Sai Cheemalapati

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

[diff] [blame]

160

# this case, any other outline fields set in the same request will be

161

# ignored.

162

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

Jon Wayne Parrott

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

[diff] [blame]

163

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

164

"magnitude": 3.14, # The magnitude.

165

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

166

},

167

},

168

"brightness": 3.14, # The brightness effect of the image. The value should be in the interval

169

# [-1.0, 1.0], where 0 means no effect. This property is read-only.

170

"recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored.

171

# This property is read-only.

172

"recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color

Sai Cheemalapati

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

[diff] [blame]

173

# stops.

174

#

175

# The colors in the gradient will replace the corresponding colors at

176

# the same position in the color palette and apply to the image. This

177

# property is read-only.

Jon Wayne Parrott

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

[diff] [blame]

178

{ # A color and position in a gradient band.

179

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

180

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

181

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

182

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

183

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

184

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

185

},

186

},

Jon Wayne Parrott

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

[diff] [blame]

187

"alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0,

188

# fully opaque.

Sai Cheemalapati

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

[diff] [blame]

189

"position": 3.14, # The relative position of the color stop in the gradient band measured

190

# in percentage. The value should be in the interval [0.0, 1.0].

Jon Wayne Parrott

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

[diff] [blame]

191

},

192

],

Sai Cheemalapati

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

[diff] [blame]

193

"name": "A String", # The name of the recolor effect.

194

#

195

# The name is determined from the `recolor_stops` by matching the gradient

196

# against the colors in the page's current color scheme. This property is

197

# read-only.

Jon Wayne Parrott

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

[diff] [blame]

198

},

199

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

200

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

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

201

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

202

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

Sai Cheemalapati

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

[diff] [blame]

203

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

204

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

Jon Wayne Parrott

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

[diff] [blame]

205

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

206

# addressed by its position.

207

},

208

"transparency": 3.14, # The transparency effect of the image. The value should be in the interval

209

# [0.0, 1.0], where 0 means no effect and 1 means completely transparent.

210

# This property is read-only.

211

"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.

212

# This property is read-only.

213

# Image.

214

#

215

# The crop properties is represented by the offsets of four edges which define

216

# a crop rectangle. The offsets are measured in percentage from the

217

# corresponding edges of the object's original bounding rectangle towards

218

# inside, relative to the object's original dimensions.

219

#

220

# - If the offset is in the interval (0, 1), the corresponding edge of crop

221

# rectangle is positioned inside of the object's original bounding rectangle.

222

# - If the offset is negative or greater than 1, the corresponding edge of crop

223

# rectangle is positioned outside of the object's original bounding rectangle.

224

# - If the left edge of the crop rectangle is on the right side of its right

225

# edge, the object will be flipped horizontally.

226

# - If the top edge of the crop rectangle is below its bottom edge, the object

227

# will be flipped vertically.

228

# - If all offsets and rotation angle is 0, the object is not cropped.

229

#

230

# After cropping, the content in the crop rectangle will be stretched to fit

231

# its container.

232

"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to

233

# the right of the original bounding rectangle left edge, relative to the

234

# object's original width.

Dan O'Meara

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

[diff] [blame^]

235

"topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located

236

# below the original bounding rectangle top edge, relative to the object's

237

# original height.

Bu Sun Kim

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

[diff] [blame]

238

"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located

239

# above the original bounding rectangle bottom edge, relative to the object's

240

# original height.

Sai Cheemalapati

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

[diff] [blame]

241

"angle": 3.14, # The rotation angle of the crop window around its center, in radians.

242

# Rotation angle is applied after the offset.

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

243

"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located

244

# to the left of the original bounding rectangle right edge, relative to the

245

# object's original width.

Jon Wayne Parrott

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

[diff] [blame]

246

},

247

"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property

248

# is read-only.

249

#

250

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

251

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

252

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

253

# the page element kind.

254

"color": { # A themeable solid color value. # The shadow color value.

255

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

256

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

257

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

258

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

259

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

260

},

261

},

262

"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,

263

# relative to the alignment position.

264

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

265

# according to:

266

#

267

# x' x = shear_y scale_y translate_y

268

# 1 [ 1 ]

269

#

270

# After transformation,

271

#

272

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

273

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

274

#

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

},

284

"propertyState": "A String", # The shadow property state.

285

#

Bu Sun Kim

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

[diff] [blame]

286

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

287

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

288

# no shadow on a page element, set this field to `NOT_RENDERED`. In this

Jon Wayne Parrott

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

[diff] [blame]

289

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

290

"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

291

# shadow becomes.

292

"magnitude": 3.14, # The magnitude.

293

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

294

},

295

"alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0.

Bu Sun Kim

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

[diff] [blame]

296

"type": "A String", # The type of the shadow. This property is read-only.

Jon Wayne Parrott

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

[diff] [blame]

297

"alignment": "A String", # The alignment point of the shadow, that sets the origin for translate,

Bu Sun Kim

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

[diff] [blame]

298

# scale and skew of the shadow. This property is read-only.

299

"rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is

300

# read-only.

Jon Wayne Parrott

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

[diff] [blame]

301

},

302

"contrast": 3.14, # The contrast effect of the image. The value should be in the interval

303

# [-1.0, 1.0], where 0 means no effect. This property is read-only.

304

},

Bu Sun Kim

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

[diff] [blame]

305

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

306

# empty.

Jon Wayne Parrott

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

[diff] [blame]

307

},

308

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

Bu Sun Kim

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

[diff] [blame]

309

#

310

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

311

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

312

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

313

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

314

# value in this field.

315

#

316

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

Jon Wayne Parrott

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

[diff] [blame]

317

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

318

# according to:

319

#

320

# x' x = shear_y scale_y translate_y

321

# 1 [ 1 ]

322

#

323

# After transformation,

324

#

325

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

326

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

327

#

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

},

337

"shape": { # A PageElement kind representing a # A generic shape.

338

# generic shape that does not have a more specific classification.

339

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

340

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

341

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

342

# information. This property is read-only.

343

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

344

# of a Shape or TableCell.

345

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

346

# replaced with content that can change over time.

347

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

348

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

349

#

350

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

351

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

352

# nesting level of lists:

353

#

354

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

355

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

356

# the list inside the parent placeholder.

357

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

358

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

359

# level of the list inside the parent placeholder.

360

#

361

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

362

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

363

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

364

# editor.

365

"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

366

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

367

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

368

# a transparent color.

369

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

370

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

371

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

372

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

373

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

374

},

375

},

376

},

Dan O'Meara

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

[diff] [blame^]

377

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

Jon Wayne Parrott

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

[diff] [blame]

378

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

379

#

380

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

381

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

382

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

383

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

Sai Cheemalapati

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

[diff] [blame]

384

"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]

385

#

386

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

387

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

Sai Cheemalapati

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

[diff] [blame]

388

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

389

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

390

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

391

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

392

#

393

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

394

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

395

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

396

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

397

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

398

# returned.

399

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

400

# family and weight of `weighted_font_family` is applied.

401

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

402

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

403

# from each other.

404

#

405

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

406

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

407

#

408

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

409

#

410

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

411

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

412

# is returned.

Sai Cheemalapati

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

[diff] [blame]

413

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

414

#

415

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

416

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

417

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

418

"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]

419

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

420

# corresponds to the numerical values described in the CSS 2.1

Bu Sun Kim

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

[diff] [blame]

421

# Specification,

422

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

Sai Cheemalapati

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

[diff] [blame]

423

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

424

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

425

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

Sai Cheemalapati

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

[diff] [blame]

426

},

Jon Wayne Parrott

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

[diff] [blame]

427

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

428

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

429

#

430

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

431

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

432

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

433

#

434

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

435

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

436

# `bold` value is used.

437

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

438

# are not inherited from parent text.

439

#

440

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

441

# text style of the range:

442

#

443

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

444

# ThemeColorType.HYPERLINK and the text will

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

# request.

457

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

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

458

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

459

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

Sai Cheemalapati

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

[diff] [blame]

460

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

461

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

Jon Wayne Parrott

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

[diff] [blame]

462

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

463

# addressed by its position.

464

},

Dan O'Meara

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

[diff] [blame^]

465

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

466

"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

467

# points.

468

"magnitude": 3.14, # The magnitude.

469

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

470

},

Sai Cheemalapati

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

[diff] [blame]

471

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

Dan O'Meara

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

[diff] [blame^]

472

"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

473

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

474

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

475

# a transparent color.

476

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

477

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

478

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

479

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

480

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

481

},

482

},

483

},

Jon Wayne Parrott

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

[diff] [blame]

484

},

485

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

486

},

487

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

488

# units.

489

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

490

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

491

#

492

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

493

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

494

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

495

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

496

# overlap.

497

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

498

#

499

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

500

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

501

# nesting level of lists:

502

#

503

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

504

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

505

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

506

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

507

# placeholder.

508

#

509

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

Sai Cheemalapati

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

[diff] [blame]

510

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

511

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

Sai Cheemalapati

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

[diff] [blame]

512

# LEFT_TO_RIGHT since

513

# text direction is not inherited.

Bu Sun Kim

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

[diff] [blame]

514

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

Sai Cheemalapati

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

[diff] [blame]

515

# inherited from the parent.

Jon Wayne Parrott

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

[diff] [blame]

516

"magnitude": 3.14, # The magnitude.

517

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

518

},

519

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

520

# 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]

521

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

522

# 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]

523

# value is inherited from the parent.

Jon Wayne Parrott

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

[diff] [blame]

524

"magnitude": 3.14, # The magnitude.

525

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

526

},

527

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

Sai Cheemalapati

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

[diff] [blame]

528

# inherited from the parent.

Jon Wayne Parrott

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

[diff] [blame]

529

"magnitude": 3.14, # The magnitude.

530

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

531

},

532

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

533

# 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]

534

# value is inherited from the parent.

Jon Wayne Parrott

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

[diff] [blame]

535

"magnitude": 3.14, # The magnitude.

536

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

537

},

538

"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]

539

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

Jon Wayne Parrott

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

[diff] [blame]

540

"magnitude": 3.14, # The magnitude.

541

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

542

},

Sai Cheemalapati

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

[diff] [blame]

543

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

Jon Wayne Parrott

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

[diff] [blame]

544

},

545

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

546

# belong to a list.

547

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

548

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

549

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

550

#

551

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

552

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

553

# nesting level of lists:

554

#

555

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

556

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

557

# the list inside the parent placeholder.

558

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

559

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

560

# level of the list inside the parent placeholder.

561

#

562

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

563

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

564

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

565

# editor.

566

"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

567

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

568

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

569

# a transparent color.

570

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

571

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

572

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

573

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

574

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

575

},

576

},

577

},

Dan O'Meara

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

[diff] [blame^]

578

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

Jon Wayne Parrott

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

[diff] [blame]

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

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

Sai Cheemalapati

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

[diff] [blame]

585

"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]

586

#

587

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

588

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

Sai Cheemalapati

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

[diff] [blame]

589

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

590

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

591

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

592

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

593

#

594

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

595

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

596

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

597

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

598

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

599

# returned.

600

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

601

# family and weight of `weighted_font_family` is applied.

602

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

603

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

604

# from each other.

605

#

606

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

607

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

608

#

609

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

610

#

611

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

612

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

613

# is returned.

Sai Cheemalapati

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

[diff] [blame]

614

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

615

#

616

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

617

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

618

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

619

"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]

620

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

621

# corresponds to the numerical values described in the CSS 2.1

Bu Sun Kim

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

[diff] [blame]

622

# Specification,

623

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

Sai Cheemalapati

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

[diff] [blame]

624

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

625

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

626

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

Sai Cheemalapati

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

[diff] [blame]

627

},

Jon Wayne Parrott

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

[diff] [blame]

628

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

629

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

630

#

631

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

632

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

633

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

634

#

635

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

636

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

637

# `bold` value is used.

638

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

639

# are not inherited from parent text.

640

#

641

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

642

# text style of the range:

643

#

644

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

645

# ThemeColorType.HYPERLINK and the text will

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

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

654

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

655

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

656

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

657

# request.

658

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

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

659

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

660

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

Sai Cheemalapati

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

[diff] [blame]

661

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

662

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

Jon Wayne Parrott

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

[diff] [blame]

663

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

664

# addressed by its position.

665

},

Dan O'Meara

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

[diff] [blame^]

666

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

667

"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

668

# points.

669

"magnitude": 3.14, # The magnitude.

670

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

671

},

Sai Cheemalapati

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

[diff] [blame]

672

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

Dan O'Meara

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

[diff] [blame^]

673

"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

674

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

675

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

676

# a transparent color.

677

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

678

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

679

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

680

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

681

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

682

},

683

},

684

},

Jon Wayne Parrott

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

[diff] [blame]

685

},

686

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

687

},

688

},

689

"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

690

# in the run have the same TextStyle.

691

#

692

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

693

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

694

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

695

# styling.

696

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

697

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

698

#

699

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

700

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

701

# nesting level of lists:

702

#

703

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

704

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

705

# the list inside the parent placeholder.

706

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

707

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

708

# level of the list inside the parent placeholder.

709

#

710

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

711

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

712

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

713

# editor.

714

"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

715

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

716

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

717

# a transparent color.

718

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

719

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

720

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

721

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

722

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

723

},

724

},

725

},

Dan O'Meara

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

[diff] [blame^]

726

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

Jon Wayne Parrott

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

[diff] [blame]

727

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

728

#

729

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

730

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

731

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

732

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

Sai Cheemalapati

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

[diff] [blame]

733

"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]

734

#

735

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

736

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

Sai Cheemalapati

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

[diff] [blame]

737

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

738

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

739

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

740

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

741

#

742

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

743

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

744

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

745

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

746

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

747

# returned.

748

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

749

# family and weight of `weighted_font_family` is applied.

750

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

751

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

752

# from each other.

753

#

754

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

755

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

756

#

757

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

758

#

759

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

760

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

761

# is returned.

Sai Cheemalapati

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

[diff] [blame]

762

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

763

#

764

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

765

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

766

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

767

"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]

768

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

769

# corresponds to the numerical values described in the CSS 2.1

Bu Sun Kim

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

[diff] [blame]

770

# Specification,

771

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

Sai Cheemalapati

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

[diff] [blame]

772

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

773

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

774

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

Sai Cheemalapati

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

[diff] [blame]

775

},

Jon Wayne Parrott

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

[diff] [blame]

776

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

777

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

778

#

779

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

780

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

781

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

782

#

783

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

784

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

785

# `bold` value is used.

786

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

787

# are not inherited from parent text.

788

#

789

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

790

# text style of the range:

791

#

792

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

793

# ThemeColorType.HYPERLINK and the text will

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

# request.

806

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

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

807

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

808

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

Sai Cheemalapati

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

[diff] [blame]

809

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

810

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

Jon Wayne Parrott

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

[diff] [blame]

811

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

812

# addressed by its position.

813

},

Dan O'Meara

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

[diff] [blame^]

814

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

815

"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

816

# points.

817

"magnitude": 3.14, # The magnitude.

818

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

819

},

Sai Cheemalapati

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

[diff] [blame]

820

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

Dan O'Meara

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

[diff] [blame^]

821

"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

822

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

823

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

824

# a transparent color.

825

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

826

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

827

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

828

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

829

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

830

},

831

},

832

},

Jon Wayne Parrott

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

[diff] [blame]

},

},

},

],

Bu Sun Kim

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

[diff] [blame]

837

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

838

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

839

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

840

# reference to that list's ID.

841

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

842

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

843

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

844

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

845

# level of nesting.

846

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

847

#

848

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

849

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

850

# nesting level of lists:

851

#

852

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

853

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

854

# the list inside the parent placeholder.

855

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

856

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

857

# level of the list inside the parent placeholder.

858

#

859

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

860

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

861

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

862

# editor.

863

"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

864

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

865

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

866

# a transparent color.

867

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

868

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

869

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

870

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

871

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

872

},

873

},

874

},

Dan O'Meara

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

[diff] [blame^]

875

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

Bu Sun Kim

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

[diff] [blame]

876

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

877

#

878

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

879

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

880

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

881

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

882

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

883

#

884

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

885

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

886

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

887

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

888

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

889

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

890

#

891

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

892

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

893

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

894

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

895

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

896

# returned.

897

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

898

# family and weight of `weighted_font_family` is applied.

899

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

900

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

901

# from each other.

902

#

903

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

904

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

905

#

906

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

907

#

908

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

909

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

910

# is returned.

911

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

912

#

913

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

914

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

915

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

916

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

917

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

918

# corresponds to the numerical values described in the CSS 2.1

919

# Specification,

920

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

921

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

922

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

923

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

924

},

925

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

926

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

927

#

928

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

929

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

930

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

931

#

932

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

933

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

934

# `bold` value is used.

Bu Sun Kim

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

[diff] [blame]

935

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

936

# are not inherited from parent text.

937

#

938

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

939

# text style of the range:

940

#

941

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

942

# ThemeColorType.HYPERLINK and the text will

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

# request.

955

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

956

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

957

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

958

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

959

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

960

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

961

# addressed by its position.

962

},

Dan O'Meara

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

[diff] [blame^]

963

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

964

"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

965

# points.

966

"magnitude": 3.14, # The magnitude.

967

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

968

},

Bu Sun Kim

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

[diff] [blame]

969

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

Dan O'Meara

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

[diff] [blame^]

970

"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

971

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

972

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

973

# a transparent color.

974

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

975

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

976

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

977

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

978

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

979

},

980

},

981

},

Bu Sun Kim

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

[diff] [blame]

},

},

},

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

986

},

987

},

Jon Wayne Parrott

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

[diff] [blame]

988

},

989

"shapeProperties": { # The properties of a Shape. # The properties of the shape.

990

#

991

# If the shape is a placeholder shape as determined by the

992

# placeholder field, then these

993

# properties may be inherited from a parent placeholder shape.

994

# Determining the rendered value of the property depends on the corresponding

995

# property_state field value.

996

"shadow": { # The shadow properties of a page element. # The shadow properties of the shape. If unset, the shadow is inherited from

997

# a parent placeholder if it exists. If the shape has no parent, then the

998

# default shadow matches the defaults for new shapes created in the Slides

999

# editor. This property is read-only.

1000

#

1001

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

1002

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

1003

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

1004

# the page element kind.

1005

"color": { # A themeable solid color value. # The shadow color value.

1006

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

1007

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

1008

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

1009

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

1010

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

1011

},

1012

},

1013

"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,

1014

# relative to the alignment position.

1015

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

1016

# according to:

1017

#

1018

# x' x = shear_y scale_y translate_y

1019

# 1 [ 1 ]

1020

#

1021

# After transformation,

1022

#

1023

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

1024

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

1025

#

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

},

1035

"propertyState": "A String", # The shadow property state.

1036

#

Bu Sun Kim

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

[diff] [blame]

1037

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

1038

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

1039

# no shadow on a page element, set this field to `NOT_RENDERED`. In this

Jon Wayne Parrott

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

[diff] [blame]

1040

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

1041

"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

1042

# shadow becomes.

1043

"magnitude": 3.14, # The magnitude.

1044

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

1045

},

1046

"alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0.

Bu Sun Kim

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

[diff] [blame]

1047

"type": "A String", # The type of the shadow. This property is read-only.

Jon Wayne Parrott

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

[diff] [blame]

1048

"alignment": "A String", # The alignment point of the shadow, that sets the origin for translate,

Bu Sun Kim

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

[diff] [blame]

1049

# scale and skew of the shadow. This property is read-only.

1050

"rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is

1051

# read-only.

Jon Wayne Parrott

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

[diff] [blame]

1052

},

1053

"shapeBackgroundFill": { # The shape background fill. # The background fill of the shape. If unset, the background fill is

1054

# inherited from a parent placeholder if it exists. If the shape has no

1055

# parent, then the default background fill depends on the shape type,

1056

# matching the defaults for new shapes created in the Slides editor.

1057

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

1058

# specified color value.

1059

#

1060

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

1061

# if it exists.

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

},

1069

},

1070

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

1071

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

1072

#

1073

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

1074

#

1075

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

1076

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

1077

},

1078

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

1079

#

Bu Sun Kim

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

[diff] [blame]

1080

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

Jon Wayne Parrott

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

[diff] [blame]

1081

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

1082

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

1083

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

1084

},

1085

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

1086

# are not inherited from parent placeholders.

1087

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

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

1088

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

1089

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

Sai Cheemalapati

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

[diff] [blame]

1090

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

1091

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

Jon Wayne Parrott

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

[diff] [blame]

1092

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

1093

# addressed by its position.

1094

},

1095

"outline": { # The outline of a PageElement. # The outline of the shape. If unset, the outline is inherited from a

1096

# parent placeholder if it exists. If the shape has no parent, then the

1097

# default outline depends on the shape type, matching the defaults for

1098

# new shapes created in the Slides editor.

1099

#

1100

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

1101

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

1102

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

1103

# the page element kind.

Jon Wayne Parrott

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

[diff] [blame]

1104

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

1105

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

1106

# specified color value.

1107

#

1108

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

1109

# if it exists.

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

},

1117

},

1118

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

1119

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

1120

#

1121

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

1122

#

1123

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

1124

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

1125

},

1126

},

Sai Cheemalapati

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

[diff] [blame]

1127

"propertyState": "A String", # The outline property state.

1128

#

Bu Sun Kim

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

[diff] [blame]

1129

# Updating the outline on a page element will implicitly update this field

1130

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

1131

# have no outline on a page element, set this field to `NOT_RENDERED`. In

Sai Cheemalapati

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

[diff] [blame]

1132

# this case, any other outline fields set in the same request will be

1133

# ignored.

1134

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

Jon Wayne Parrott

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

[diff] [blame]

1135

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

1136

"magnitude": 3.14, # The magnitude.

1137

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

1138

},

1139

},

Bu Sun Kim

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

[diff] [blame]

1140

"contentAlignment": "A String", # The alignment of the content in the shape. If unspecified,

1141

# the alignment is inherited from a parent placeholder if it exists. If the

1142

# shape has no parent, the default alignment matches the alignment for new

1143

# shapes created in the Slides editor.

Jon Wayne Parrott

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

[diff] [blame]

1144

},

1145

"placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are shapes that are inherit from corresponding placeholders on

1146

# layouts and masters.

1147

#

1148

# If set, the shape is a placeholder shape and any inherited properties

1149

# can be resolved by looking at the parent placeholder identified by the

1150

# Placeholder.parent_object_id field.

1151

"parentObjectId": "A String", # The object ID of this shape's parent placeholder.

1152

# If unset, the parent placeholder shape does not exist, so the shape does

1153

# not inherit properties from any other shape.

Sai Cheemalapati

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

[diff] [blame]

1154

"index": 42, # The index of the placeholder. If the same placeholder types are present in

1155

# the same page, they would have different index values.

Jon Wayne Parrott

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

[diff] [blame]

1156

"type": "A String", # The type of the placeholder.

1157

},

1158

"shapeType": "A String", # The type of the shape.

1159

},

1160

"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are

1161

# represented as images.

1162

# a linked chart embedded from Google Sheets.

Sai Cheemalapati

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

[diff] [blame]

1163

"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30

1164

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

1165

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

1166

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

Sai Cheemalapati

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

[diff] [blame]

1167

"spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.

Jon Wayne Parrott

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

[diff] [blame]

1168

"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.

1169

"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.

Bu Sun Kim

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

[diff] [blame]

1170

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

Jon Wayne Parrott

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

[diff] [blame]

1171

#

1172

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

1173

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

1174

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

1175

# the page element kind.

Jon Wayne Parrott

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

[diff] [blame]

1176

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

1177

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

1178

# specified color value.

1179

#

1180

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

1181

# if it exists.

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

},

1189

},

1190

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

1191

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

1192

#

1193

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

1194

#

1195

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

1196

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

1197

},

1198

},

Sai Cheemalapati

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

[diff] [blame]

1199

"propertyState": "A String", # The outline property state.

1200

#

Bu Sun Kim

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

[diff] [blame]

1201

# Updating the outline on a page element will implicitly update this field

1202

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

1203

# have no outline on a page element, set this field to `NOT_RENDERED`. In

Sai Cheemalapati

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

[diff] [blame]

1204

# this case, any other outline fields set in the same request will be

1205

# ignored.

1206

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

Jon Wayne Parrott

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

[diff] [blame]

1207

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

1208

"magnitude": 3.14, # The magnitude.

1209

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

1210

},

1211

},

1212

"brightness": 3.14, # The brightness effect of the image. The value should be in the interval

1213

# [-1.0, 1.0], where 0 means no effect. This property is read-only.

1214

"recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored.

1215

# This property is read-only.

1216

"recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color

Sai Cheemalapati

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

[diff] [blame]

1217

# stops.

1218

#

1219

# The colors in the gradient will replace the corresponding colors at

1220

# the same position in the color palette and apply to the image. This

1221

# property is read-only.

Jon Wayne Parrott

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

[diff] [blame]

1222

{ # A color and position in a gradient band.

1223

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

1224

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

1225

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

1226

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

1227

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

1228

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

1229

},

1230

},

Jon Wayne Parrott

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

[diff] [blame]

1231

"alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0,

1232

# fully opaque.

Sai Cheemalapati

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

[diff] [blame]

1233

"position": 3.14, # The relative position of the color stop in the gradient band measured

1234

# in percentage. The value should be in the interval [0.0, 1.0].

Jon Wayne Parrott

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

[diff] [blame]

1235

},

1236

],

Sai Cheemalapati

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

[diff] [blame]

1237

"name": "A String", # The name of the recolor effect.

1238

#

1239

# The name is determined from the `recolor_stops` by matching the gradient

1240

# against the colors in the page's current color scheme. This property is

1241

# read-only.

Jon Wayne Parrott

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

[diff] [blame]

1242

},

1243

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

1244

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

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

1245

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

1246

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

Sai Cheemalapati

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

[diff] [blame]

1247

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

1248

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

Jon Wayne Parrott

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

[diff] [blame]

1249

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

1250

# addressed by its position.

1251

},

1252

"transparency": 3.14, # The transparency effect of the image. The value should be in the interval

1253

# [0.0, 1.0], where 0 means no effect and 1 means completely transparent.

1254

# This property is read-only.

1255

"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.

1256

# This property is read-only.

1257

# Image.

1258

#

1259

# The crop properties is represented by the offsets of four edges which define

1260

# a crop rectangle. The offsets are measured in percentage from the

1261

# corresponding edges of the object's original bounding rectangle towards

1262

# inside, relative to the object's original dimensions.

1263

#

1264

# - If the offset is in the interval (0, 1), the corresponding edge of crop

1265

# rectangle is positioned inside of the object's original bounding rectangle.

1266

# - If the offset is negative or greater than 1, the corresponding edge of crop

1267

# rectangle is positioned outside of the object's original bounding rectangle.

1268

# - If the left edge of the crop rectangle is on the right side of its right

1269

# edge, the object will be flipped horizontally.

1270

# - If the top edge of the crop rectangle is below its bottom edge, the object

1271

# will be flipped vertically.

1272

# - If all offsets and rotation angle is 0, the object is not cropped.

1273

#

1274

# After cropping, the content in the crop rectangle will be stretched to fit

1275

# its container.

1276

"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to

1277

# the right of the original bounding rectangle left edge, relative to the

1278

# object's original width.

Dan O'Meara

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

[diff] [blame^]

1279

"topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located

1280

# below the original bounding rectangle top edge, relative to the object's

1281

# original height.

Bu Sun Kim

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

[diff] [blame]

1282

"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located

1283

# above the original bounding rectangle bottom edge, relative to the object's

1284

# original height.

Sai Cheemalapati

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

[diff] [blame]

1285

"angle": 3.14, # The rotation angle of the crop window around its center, in radians.

1286

# Rotation angle is applied after the offset.

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

1287

"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located

1288

# to the left of the original bounding rectangle right edge, relative to the

1289

# object's original width.

Jon Wayne Parrott

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

[diff] [blame]

1290

},

1291

"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property

1292

# is read-only.

1293

#

1294

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

1295

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

1296

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

1297

# the page element kind.

1298

"color": { # A themeable solid color value. # The shadow color value.

1299

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

1300

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

1301

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

1302

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

1303

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

1304

},

1305

},

1306

"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,

1307

# relative to the alignment position.

1308

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

1309

# according to:

1310

#

1311

# x' x = shear_y scale_y translate_y

1312

# 1 [ 1 ]

1313

#

1314

# After transformation,

1315

#

1316

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

1317

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

1318

#

1319

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

1320

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

1321

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

1322

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

1323

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

1324

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

1325

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

1326

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

1327

},

1328

"propertyState": "A String", # The shadow property state.

1329

#

Bu Sun Kim

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

[diff] [blame]

1330

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

1331

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

1332

# no shadow on a page element, set this field to `NOT_RENDERED`. In this

Jon Wayne Parrott

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

[diff] [blame]

1333

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

1334

"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

1335

# shadow becomes.

1336

"magnitude": 3.14, # The magnitude.

1337

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

1338

},

1339

"alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0.

Bu Sun Kim

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

[diff] [blame]

1340

"type": "A String", # The type of the shadow. This property is read-only.

Jon Wayne Parrott

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

[diff] [blame]

1341

"alignment": "A String", # The alignment point of the shadow, that sets the origin for translate,

Bu Sun Kim

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

[diff] [blame]

1342

# scale and skew of the shadow. This property is read-only.

1343

"rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is

1344

# read-only.

Jon Wayne Parrott

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

[diff] [blame]

1345

},

1346

"contrast": 3.14, # The contrast effect of the image. The value should be in the interval

1347

# [-1.0, 1.0], where 0 means no effect. This property is read-only.

1348

},

1349

},

Sai Cheemalapati

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

[diff] [blame]

1350

"chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is

1351

# embedded.

Jon Wayne Parrott

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

[diff] [blame]

1352

},

1353

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

1354

# video.

Bu Sun Kim

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

[diff] [blame]

1355

"url": "A String", # An URL to a video. The URL is valid as long as the source video exists and

1356

# sharing settings do not change.

Dan O'Meara

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

[diff] [blame^]

1357

"source": "A String", # The video source.

1358

"id": "A String", # The video source's unique identifier for this video.

Jon Wayne Parrott

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

[diff] [blame]

1359

"videoProperties": { # The properties of the Video. # The properties of the video.

Bu Sun Kim

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

[diff] [blame]

1360

"start": 42, # The time at which to start playback, measured in seconds from the beginning

1361

# of the video.

1362

# If set, the start time should be before the end time.

1363

# If you set this to a value that exceeds the video's length in seconds, the

1364

# video will be played from the last second.

1365

# If not set, the video will be played from the beginning.

1366

"autoPlay": True or False, # Whether to enable video autoplay when the page is displayed in present

1367

# mode. Defaults to false.

1368

"end": 42, # The time at which to end playback, measured in seconds from the beginning

1369

# of the video.

1370

# If set, the end time should be after the start time.

1371

# If not set or if you set this to a value that exceeds the video's length,

1372

# the video will be played until its end.

Jon Wayne Parrott

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

[diff] [blame]

1373

"outline": { # The outline of a PageElement. # The outline of the video. The default outline matches the defaults for new

1374

# videos created in the Slides editor.

1375

#

1376

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

1377

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

1378

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

1379

# the page element kind.

Jon Wayne Parrott

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

[diff] [blame]

1380

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

1381

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

1382

# specified color value.

1383

#

1384

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

1385

# if it exists.

1386

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

1387

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

1388

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

1389

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

1390

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

1391

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

1392

},

1393

},

1394

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

1395

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

1396

#

1397

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

1398

#

1399

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

1400

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

1401

},

1402

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1403

"propertyState": "A String", # The outline property state.

1404

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1405

# Updating the outline on a page element will implicitly update this field

1406

# to `RENDERED`, unless another value is specified in the same request. To

1407

# have no outline on a page element, set this field to `NOT_RENDERED`. In

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1408

# this case, any other outline fields set in the same request will be

1409

# ignored.

1410

"dashStyle": "A String", # The dash style of the outline.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1411

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline.

1412

"magnitude": 3.14, # The magnitude.

1413

"unit": "A String", # The units for magnitude.

1414

},

1415

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1416

"mute": True or False, # Whether to mute the audio during video playback. Defaults to false.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1417

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1418

},

1419

"table": { # A PageElement kind representing a # A table page element.

1420

# table.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1421

"rows": 42, # Number of rows in the table.

1422

"horizontalBorderRows": [ # Properties of horizontal cell borders.

1423

#

1424

# A table's horizontal cell borders are represented as a grid. The grid has

1425

# one more row than the number of rows in the table and the same number of

1426

# columns as the table. For example, if the table is 3 x 3, its horizontal

1427

# borders will be represented as a grid with 4 rows and 3 columns.

1428

{ # Contents of each border row in a table.

1429

"tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are

1430

# merged, it is not included in the response.

1431

{ # The properties of each border cell.

1432

"tableBorderProperties": { # The border styling properties of the # The border properties.

1433

# TableBorderCell.

1434

"tableBorderFill": { # The fill of the border. # The fill of the table border.

1435

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid fill.

1436

# specified color value.

1437

#

1438

# If any field is unset, its value may be inherited from a parent placeholder

1439

# if it exists.

1440

"color": { # A themeable solid color value. # The color value of the solid fill.

1441

"themeColor": "A String", # An opaque theme color.

1442

"rgbColor": { # An RGB color. # An opaque RGB color.

1443

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1444

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1445

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1446

},

1447

},

1448

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

1449

# That is, the final pixel color is defined by the equation:

1450

#

1451

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

1452

#

1453

# This means that a value of 1.0 corresponds to a solid color, whereas

1454

# a value of 0.0 corresponds to a completely transparent color.

1455

},

1456

},

1457

"dashStyle": "A String", # The dash style of the border.

1458

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the border.

1459

"magnitude": 3.14, # The magnitude.

1460

"unit": "A String", # The units for magnitude.

1461

},

1462

},

1463

"location": { # A location of a single table cell within a table. # The location of the border within the border table.

1464

"rowIndex": 42, # The 0-based row index.

1465

"columnIndex": 42, # The 0-based column index.

},

},

],

},

],

"verticalBorderRows": [ # Properties of vertical cell borders.

1472

#

1473

# A table's vertical cell borders are represented as a grid. The grid has the

1474

# same number of rows as the table and one more column than the number of

1475

# columns in the table. For example, if the table is 3 x 3, its vertical

1476

# borders will be represented as a grid with 3 rows and 4 columns.

1477

{ # Contents of each border row in a table.

1478

"tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are

1479

# merged, it is not included in the response.

1480

{ # The properties of each border cell.

1481

"tableBorderProperties": { # The border styling properties of the # The border properties.

1482

# TableBorderCell.

1483

"tableBorderFill": { # The fill of the border. # The fill of the table border.

1484

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid fill.

1485

# specified color value.

1486

#

1487

# If any field is unset, its value may be inherited from a parent placeholder

1488

# if it exists.

1489

"color": { # A themeable solid color value. # The color value of the solid fill.

1490

"themeColor": "A String", # An opaque theme color.

1491

"rgbColor": { # An RGB color. # An opaque RGB color.

1492

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1493

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1494

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1495

},

1496

},

1497

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

1498

# That is, the final pixel color is defined by the equation:

1499

#

1500

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

1501

#

1502

# This means that a value of 1.0 corresponds to a solid color, whereas

1503

# a value of 0.0 corresponds to a completely transparent color.

1504

},

1505

},

1506

"dashStyle": "A String", # The dash style of the border.

1507

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the border.

1508

"magnitude": 3.14, # The magnitude.

1509

"unit": "A String", # The units for magnitude.

1510

},

1511

},

1512

"location": { # A location of a single table cell within a table. # The location of the border within the border table.

1513

"rowIndex": 42, # The 0-based row index.

1514

"columnIndex": 42, # The 0-based column index.

},

},

],

},

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1520

"tableColumns": [ # Properties of each column.

1521

{ # Properties of each column in a table.

1522

"columnWidth": { # A magnitude in a single direction in the specified units. # Width of a column.

1523

"magnitude": 3.14, # The magnitude.

1524

"unit": "A String", # The units for magnitude.

},

},

],

"tableRows": [ # Properties and contents of each row.

1529

#

1530

# Cells that span multiple rows are contained in only one of these rows and

1531

# have a row_span greater

1532

# than 1.

1533

{ # Properties and contents of each row in a table.

1534

"tableCells": [ # Properties and contents of each cell.

1535

#

1536

# Cells that span multiple columns are represented only once with a

1537

# column_span greater

1538

# than 1. As a result, the length of this collection does not always match

1539

# the number of columns of the entire table.

1540

{ # Properties and contents of each table cell.

1541

"text": { # The general text content. The text must reside in a compatible shape (e.g. # The text content of the cell.

1542

# text box or rectangle) or a table cell in a page.

1543

"textElements": [ # The text contents broken down into its component parts, including styling

1544

# information. This property is read-only.

1545

{ # A TextElement describes the content of a range of indices in the text content

1546

# of a Shape or TableCell.

1547

"autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically

1548

# replaced with content that can change over time.

1549

"content": "A String", # The rendered content of this auto text, if available.

1550

"style": { # Represents the styling that can be applied to a TextRun. # The styling applied to this auto text.

1551

#

1552

# If this text is contained in a shape with a parent placeholder, then these text styles may be

1553

# inherited from the parent. Which text styles are inherited depend on the

1554

# nesting level of lists:

1555

#

1556

# * A text run in a paragraph that is not in a list will inherit its text style

1557

# from the the newline character in the paragraph at the 0 nesting level of

1558

# the list inside the parent placeholder.

1559

# * A text run in a paragraph that is in a list will inherit its text style

1560

# from the newline character in the paragraph at its corresponding nesting

1561

# level of the list inside the parent placeholder.

1562

#

1563

# Inherited text styles are represented as unset fields in this message. If

1564

# text is contained in a shape without a parent placeholder, unsetting these

1565

# fields will revert the style to a value matching the defaults in the Slides

1566

# editor.

1567

"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

1568

# transparent, depending on if the `opaque_color` field in it is set.

1569

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

1570

# a transparent color.

1571

"themeColor": "A String", # An opaque theme color.

1572

"rgbColor": { # An RGB color. # An opaque RGB color.

1573

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1574

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1575

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1576

},

1577

},

1578

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

1579

"bold": True or False, # Whether or not the text is rendered as bold.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1580

"baselineOffset": "A String", # The text's vertical offset from its normal position.

1581

#

1582

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

1583

# rendered in a smaller font size, computed based on the `font_size` field.

1584

# The `font_size` itself is not affected by changes in this field.

1585

"strikethrough": True or False, # Whether or not the text is struck through.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1586

"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]

1587

#

1588

# This field is an extension of `font_family` meant to support explicit font

1589

# weights without breaking backwards compatibility. As such, when reading the

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1590

# style of a range of text, the value of `weighted_font_family#font_family`

1591

# will always be equal to that of `font_family`. However, when writing, if

1592

# both fields are included in the field mask (either explicitly or through

1593

# the wildcard `"*"`), their values are reconciled as follows:

1594

#

1595

# * If `font_family` is set and `weighted_font_family` is not, the value of

1596

# `font_family` is applied with weight `400` ("normal").

1597

# * If both fields are set, the value of `font_family` must match that of

1598

# `weighted_font_family#font_family`. If so, the font family and weight of

1599

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

1600

# returned.

1601

# * If `weighted_font_family` is set and `font_family` is not, the font

1602

# family and weight of `weighted_font_family` is applied.

1603

# * If neither field is set, the font family and weight of the text inherit

1604

# from the parent. Note that these properties cannot inherit separately

1605

# from each other.

1606

#

1607

# If an update request specifies values for both `weighted_font_family` and

1608

# `bold`, the `weighted_font_family` is applied first, then `bold`.

1609

#

1610

# If `weighted_font_family#weight` is not set, it defaults to `400`.

1611

#

1612

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

1613

# must also be set with a non-empty value. Otherwise, a 400 bad request error

1614

# is returned.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1615

"fontFamily": "A String", # The font family of the text.

1616

#

1617

# The font family can be any font from the Font menu in Slides or from

1618

# [Google Fonts] (https://fonts.google.com/). If the font name is

1619

# unrecognized, the text is rendered in `Arial`.

1620

"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]

1621

# multiple of `100` between `100` and `900`, inclusive. This range

1622

# corresponds to the numerical values described in the CSS 2.1

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1623

# Specification,

1624

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1625

# with non-numerical values disallowed. Weights greater than or equal to

1626

# `700` are considered bold, and weights less than `700`are not bold. The

1627

# default value is `400` ("normal").

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1628

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1629

"smallCaps": True or False, # Whether or not the text is in small capital letters.

1630

"fontFamily": "A String", # The font family of the text.

1631

#

1632

# The font family can be any font from the Font menu in Slides or from

1633

# [Google Fonts] (https://fonts.google.com/). If the font name is

1634

# unrecognized, the text is rendered in `Arial`.

1635

#

1636

# Some fonts can affect the weight of the text. If an update request

1637

# specifies values for both `font_family` and `bold`, the explicitly-set

1638

# `bold` value is used.

1639

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

1640

# are not inherited from parent text.

1641

#

1642

# Changing the link in an update request causes some other changes to the

1643

# text style of the range:

1644

#

1645

# * When setting a link, the text foreground color will be set to

1646

# ThemeColorType.HYPERLINK and the text will

1647

# be underlined. If these fields are modified in the same

1648

# request, those values will be used instead of the link defaults.

1649

# * Setting a link on a text range that overlaps with an existing link will

1650

# also update the existing link to point to the new URL.

1651

# * Links are not settable on newline characters. As a result, setting a link

1652

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

1653

# will separate the newline character(s) into their own text runs. The

1654

# link will be applied separately to the runs before and after the newline.

1655

# * Removing a link will update the text style of the range to match the

1656

# style of the preceding text (or the default text styles if the preceding

1657

# text is another link) unless different styles are being set in the same

1658

# request.

1659

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

1660

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

1661

# in the presentation. There may not be a slide at this index.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1662

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

1663

# presentation with this ID. A page with this ID may not exist.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1664

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

1665

# addressed by its position.

1666

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

1667

"italic": True or False, # Whether or not the text is italicized.

1668

"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

1669

# points.

1670

"magnitude": 3.14, # The magnitude.

1671

"unit": "A String", # The units for magnitude.

1672

},

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1673

"underline": True or False, # Whether or not the text is underlined.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

1674

"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

1675

# transparent, depending on if the `opaque_color` field in it is set.

1676

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

1677

# a transparent color.

1678

"themeColor": "A String", # An opaque theme color.

1679

"rgbColor": { # An RGB color. # An opaque RGB color.

1680

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1681

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1682

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1683

},

1684

},

1685

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1686

},

1687

"type": "A String", # The type of this auto text.

1688

},

1689

"endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code

1690

# units.

1691

"startIndex": 42, # The zero-based start index of this text element, in Unicode code units.

1692

"paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph.

1693

#

1694

# The `start_index` and `end_index` of this TextElement represent the

1695

# range of the paragraph. Other TextElements with an index range contained

1696

# inside this paragraph's range are considered to be part of this

1697

# paragraph. The range of indices of two separate paragraphs will never

1698

# overlap.

1699

"style": { # Styles that apply to a whole paragraph. # The paragraph's style

1700

#

1701

# If this text is contained in a shape with a parent placeholder, then these paragraph styles may be

1702

# inherited from the parent. Which paragraph styles are inherited depend on the

1703

# nesting level of lists:

1704

#

1705

# * A paragraph not in a list will inherit its paragraph style from the

1706

# paragraph at the 0 nesting level of the list inside the parent placeholder.

1707

# * A paragraph in a list will inherit its paragraph style from the paragraph

1708

# at its corresponding nesting level of the list inside the parent

1709

# placeholder.

1710

#

1711

# Inherited paragraph styles are represented as unset fields in this message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1712

"spacingMode": "A String", # The spacing mode for the paragraph.

1713

"direction": "A String", # The text direction of this paragraph. If unset, the value defaults to

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1714

# LEFT_TO_RIGHT since

1715

# text direction is not inherited.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1716

"spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1717

# inherited from the parent.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1718

"magnitude": 3.14, # The magnitude.

1719

"unit": "A String", # The units for magnitude.

1720

},

1721

"lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal

1722

# 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]

1723

"indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to

1724

# 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]

1725

# value is inherited from the parent.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1726

"magnitude": 3.14, # The magnitude.

1727

"unit": "A String", # The units for magnitude.

1728

},

1729

"spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1730

# inherited from the parent.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1731

"magnitude": 3.14, # The magnitude.

1732

"unit": "A String", # The units for magnitude.

1733

},

1734

"indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to

1735

# 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]

1736

# value is inherited from the parent.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1737

"magnitude": 3.14, # The magnitude.

1738

"unit": "A String", # The units for magnitude.

1739

},

1740

"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]

1741

# If unset, the value is inherited from the parent.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1742

"magnitude": 3.14, # The magnitude.

1743

"unit": "A String", # The units for magnitude.

1744

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1745

"alignment": "A String", # The text alignment for this paragraph.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1746

},

1747

"bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not

1748

# belong to a list.

1749

"nestingLevel": 42, # The nesting level of this paragraph in the list.

1750

"listId": "A String", # The ID of the list this paragraph belongs to.

1751

"bulletStyle": { # Represents the styling that can be applied to a TextRun. # The paragraph specific text style applied to this bullet.

1752

#

1753

# If this text is contained in a shape with a parent placeholder, then these text styles may be

1754

# inherited from the parent. Which text styles are inherited depend on the

1755

# nesting level of lists:

1756

#

1757

# * A text run in a paragraph that is not in a list will inherit its text style

1758

# from the the newline character in the paragraph at the 0 nesting level of

1759

# the list inside the parent placeholder.

1760

# * A text run in a paragraph that is in a list will inherit its text style

1761

# from the newline character in the paragraph at its corresponding nesting

1762

# level of the list inside the parent placeholder.

1763

#

1764

# Inherited text styles are represented as unset fields in this message. If

1765

# text is contained in a shape without a parent placeholder, unsetting these

1766

# fields will revert the style to a value matching the defaults in the Slides

1767

# editor.

1768

"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

1769

# transparent, depending on if the `opaque_color` field in it is set.

1770

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

1771

# a transparent color.

1772

"themeColor": "A String", # An opaque theme color.

1773

"rgbColor": { # An RGB color. # An opaque RGB color.

1774

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1775

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1776

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1777

},

1778

},

1779

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

1780

"bold": True or False, # Whether or not the text is rendered as bold.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1781

"baselineOffset": "A String", # The text's vertical offset from its normal position.

1782

#

1783

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

1784

# rendered in a smaller font size, computed based on the `font_size` field.

1785

# The `font_size` itself is not affected by changes in this field.

1786

"strikethrough": True or False, # Whether or not the text is struck through.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1787

"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]

1788

#

1789

# This field is an extension of `font_family` meant to support explicit font

1790

# weights without breaking backwards compatibility. As such, when reading the

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1791

# style of a range of text, the value of `weighted_font_family#font_family`

1792

# will always be equal to that of `font_family`. However, when writing, if

1793

# both fields are included in the field mask (either explicitly or through

1794

# the wildcard `"*"`), their values are reconciled as follows:

1795

#

1796

# * If `font_family` is set and `weighted_font_family` is not, the value of

1797

# `font_family` is applied with weight `400` ("normal").

1798

# * If both fields are set, the value of `font_family` must match that of

1799

# `weighted_font_family#font_family`. If so, the font family and weight of

1800

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

1801

# returned.

1802

# * If `weighted_font_family` is set and `font_family` is not, the font

1803

# family and weight of `weighted_font_family` is applied.

1804

# * If neither field is set, the font family and weight of the text inherit

1805

# from the parent. Note that these properties cannot inherit separately

1806

# from each other.

1807

#

1808

# If an update request specifies values for both `weighted_font_family` and

1809

# `bold`, the `weighted_font_family` is applied first, then `bold`.

1810

#

1811

# If `weighted_font_family#weight` is not set, it defaults to `400`.

1812

#

1813

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

1814

# must also be set with a non-empty value. Otherwise, a 400 bad request error

1815

# is returned.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1816

"fontFamily": "A String", # The font family of the text.

1817

#

1818

# The font family can be any font from the Font menu in Slides or from

1819

# [Google Fonts] (https://fonts.google.com/). If the font name is

1820

# unrecognized, the text is rendered in `Arial`.

1821

"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]

1822

# multiple of `100` between `100` and `900`, inclusive. This range

1823

# corresponds to the numerical values described in the CSS 2.1

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1824

# Specification,

1825

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1826

# with non-numerical values disallowed. Weights greater than or equal to

1827

# `700` are considered bold, and weights less than `700`are not bold. The

1828

# default value is `400` ("normal").

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1829

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1830

"smallCaps": True or False, # Whether or not the text is in small capital letters.

1831

"fontFamily": "A String", # The font family of the text.

1832

#

1833

# The font family can be any font from the Font menu in Slides or from

1834

# [Google Fonts] (https://fonts.google.com/). If the font name is

1835

# unrecognized, the text is rendered in `Arial`.

1836

#

1837

# Some fonts can affect the weight of the text. If an update request

1838

# specifies values for both `font_family` and `bold`, the explicitly-set

1839

# `bold` value is used.

1840

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

1841

# are not inherited from parent text.

1842

#

1843

# Changing the link in an update request causes some other changes to the

1844

# text style of the range:

1845

#

1846

# * When setting a link, the text foreground color will be set to

1847

# ThemeColorType.HYPERLINK and the text will

1848

# be underlined. If these fields are modified in the same

1849

# request, those values will be used instead of the link defaults.

1850

# * Setting a link on a text range that overlaps with an existing link will

1851

# also update the existing link to point to the new URL.

1852

# * Links are not settable on newline characters. As a result, setting a link

1853

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

1854

# will separate the newline character(s) into their own text runs. The

1855

# link will be applied separately to the runs before and after the newline.

1856

# * Removing a link will update the text style of the range to match the

1857

# style of the preceding text (or the default text styles if the preceding

1858

# text is another link) unless different styles are being set in the same

1859

# request.

1860

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

1861

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

1862

# in the presentation. There may not be a slide at this index.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1863

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

1864

# presentation with this ID. A page with this ID may not exist.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1865

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

1866

# addressed by its position.

1867

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

1868

"italic": True or False, # Whether or not the text is italicized.

1869

"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

1870

# points.

1871

"magnitude": 3.14, # The magnitude.

1872

"unit": "A String", # The units for magnitude.

1873

},

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1874

"underline": True or False, # Whether or not the text is underlined.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

1875

"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

1876

# transparent, depending on if the `opaque_color` field in it is set.

1877

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

1878

# a transparent color.

1879

"themeColor": "A String", # An opaque theme color.

1880

"rgbColor": { # An RGB color. # An opaque RGB color.

1881

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1882

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1883

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1884

},

1885

},

1886

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1887

},

1888

"glyph": "A String", # The rendered bullet glyph for this paragraph.

1889

},

1890

},

1891

"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

1892

# in the run have the same TextStyle.

1893

#

1894

# The `start_index` and `end_index` of TextRuns will always be fully

1895

# contained in the index range of a single `paragraph_marker` TextElement.

1896

# In other words, a TextRun will never span multiple paragraphs.

1897

# styling.

1898

"content": "A String", # The text of this run.

1899

"style": { # Represents the styling that can be applied to a TextRun. # The styling applied to this run.

1900

#

1901

# If this text is contained in a shape with a parent placeholder, then these text styles may be

1902

# inherited from the parent. Which text styles are inherited depend on the

1903

# nesting level of lists:

1904

#

1905

# * A text run in a paragraph that is not in a list will inherit its text style

1906

# from the the newline character in the paragraph at the 0 nesting level of

1907

# the list inside the parent placeholder.

1908

# * A text run in a paragraph that is in a list will inherit its text style

1909

# from the newline character in the paragraph at its corresponding nesting

1910

# level of the list inside the parent placeholder.

1911

#

1912

# Inherited text styles are represented as unset fields in this message. If

1913

# text is contained in a shape without a parent placeholder, unsetting these

1914

# fields will revert the style to a value matching the defaults in the Slides

1915

# editor.

1916

"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

1917

# transparent, depending on if the `opaque_color` field in it is set.

1918

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

1919

# a transparent color.

1920

"themeColor": "A String", # An opaque theme color.

1921

"rgbColor": { # An RGB color. # An opaque RGB color.

1922

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

1923

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

1924

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

1925

},

1926

},

1927

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

1928

"bold": True or False, # Whether or not the text is rendered as bold.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1929

"baselineOffset": "A String", # The text's vertical offset from its normal position.

1930

#

1931

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

1932

# rendered in a smaller font size, computed based on the `font_size` field.

1933

# The `font_size` itself is not affected by changes in this field.

1934

"strikethrough": True or False, # Whether or not the text is struck through.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1935

"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]

1936

#

1937

# This field is an extension of `font_family` meant to support explicit font

1938

# weights without breaking backwards compatibility. As such, when reading the

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1939

# style of a range of text, the value of `weighted_font_family#font_family`

1940

# will always be equal to that of `font_family`. However, when writing, if

1941

# both fields are included in the field mask (either explicitly or through

1942

# the wildcard `"*"`), their values are reconciled as follows:

1943

#

1944

# * If `font_family` is set and `weighted_font_family` is not, the value of

1945

# `font_family` is applied with weight `400` ("normal").

1946

# * If both fields are set, the value of `font_family` must match that of

1947

# `weighted_font_family#font_family`. If so, the font family and weight of

1948

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

1949

# returned.

1950

# * If `weighted_font_family` is set and `font_family` is not, the font

1951

# family and weight of `weighted_font_family` is applied.

1952

# * If neither field is set, the font family and weight of the text inherit

1953

# from the parent. Note that these properties cannot inherit separately

1954

# from each other.

1955

#

1956

# If an update request specifies values for both `weighted_font_family` and

1957

# `bold`, the `weighted_font_family` is applied first, then `bold`.

1958

#

1959

# If `weighted_font_family#weight` is not set, it defaults to `400`.

1960

#

1961

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

1962

# must also be set with a non-empty value. Otherwise, a 400 bad request error

1963

# is returned.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1964

"fontFamily": "A String", # The font family of the text.

1965

#

1966

# The font family can be any font from the Font menu in Slides or from

1967

# [Google Fonts] (https://fonts.google.com/). If the font name is

1968

# unrecognized, the text is rendered in `Arial`.

1969

"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]

1970

# multiple of `100` between `100` and `900`, inclusive. This range

1971

# corresponds to the numerical values described in the CSS 2.1

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1972

# Specification,

1973

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1974

# with non-numerical values disallowed. Weights greater than or equal to

1975

# `700` are considered bold, and weights less than `700`are not bold. The

1976

# default value is `400` ("normal").

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1977

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1978

"smallCaps": True or False, # Whether or not the text is in small capital letters.

1979

"fontFamily": "A String", # The font family of the text.

1980

#

1981

# The font family can be any font from the Font menu in Slides or from

1982

# [Google Fonts] (https://fonts.google.com/). If the font name is

1983

# unrecognized, the text is rendered in `Arial`.

1984

#

1985

# Some fonts can affect the weight of the text. If an update request

1986

# specifies values for both `font_family` and `bold`, the explicitly-set

1987

# `bold` value is used.

1988

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

1989

# are not inherited from parent text.

1990

#

1991

# Changing the link in an update request causes some other changes to the

1992

# text style of the range:

1993

#

1994

# * When setting a link, the text foreground color will be set to

1995

# ThemeColorType.HYPERLINK and the text will

1996

# be underlined. If these fields are modified in the same

1997

# request, those values will be used instead of the link defaults.

1998

# * Setting a link on a text range that overlaps with an existing link will

1999

# also update the existing link to point to the new URL.

2000

# * Links are not settable on newline characters. As a result, setting a link

2001

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

2002

# will separate the newline character(s) into their own text runs. The

2003

# link will be applied separately to the runs before and after the newline.

2004

# * Removing a link will update the text style of the range to match the

2005

# style of the preceding text (or the default text styles if the preceding

2006

# text is another link) unless different styles are being set in the same

2007

# request.

2008

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

2009

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

2010

# in the presentation. There may not be a slide at this index.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2011

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

2012

# presentation with this ID. A page with this ID may not exist.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2013

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

2014

# addressed by its position.

2015

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2016

"italic": True or False, # Whether or not the text is italicized.

2017

"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

2018

# points.

2019

"magnitude": 3.14, # The magnitude.

2020

"unit": "A String", # The units for magnitude.

2021

},

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

2022

"underline": True or False, # Whether or not the text is underlined.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2023

"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

2024

# transparent, depending on if the `opaque_color` field in it is set.

2025

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

2026

# a transparent color.

2027

"themeColor": "A String", # An opaque theme color.

2028

"rgbColor": { # An RGB color. # An opaque RGB color.

2029

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2030

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2031

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

2032

},

2033

},

2034

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

},

},

},

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2039

"lists": { # The bulleted lists contained in this text, keyed by list ID.

2040

"a_key": { # A List describes the look and feel of bullets belonging to paragraphs

2041

# associated with a list. A paragraph that is part of a list has an implicit

2042

# reference to that list's ID.

2043

"nestingLevel": { # A map of nesting levels to the properties of bullets at the associated

2044

# level. A list has at most nine levels of nesting, so the possible values

2045

# for the keys of this map are 0 through 8, inclusive.

2046

"a_key": { # Contains properties describing the look and feel of a list bullet at a given

2047

# level of nesting.

2048

"bulletStyle": { # Represents the styling that can be applied to a TextRun. # The style of a bullet at this level of nesting.

2049

#

2050

# If this text is contained in a shape with a parent placeholder, then these text styles may be

2051

# inherited from the parent. Which text styles are inherited depend on the

2052

# nesting level of lists:

2053

#

2054

# * A text run in a paragraph that is not in a list will inherit its text style

2055

# from the the newline character in the paragraph at the 0 nesting level of

2056

# the list inside the parent placeholder.

2057

# * A text run in a paragraph that is in a list will inherit its text style

2058

# from the newline character in the paragraph at its corresponding nesting

2059

# level of the list inside the parent placeholder.

2060

#

2061

# Inherited text styles are represented as unset fields in this message. If

2062

# text is contained in a shape without a parent placeholder, unsetting these

2063

# fields will revert the style to a value matching the defaults in the Slides

2064

# editor.

2065

"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

2066

# transparent, depending on if the `opaque_color` field in it is set.

2067

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

2068

# a transparent color.

2069

"themeColor": "A String", # An opaque theme color.

2070

"rgbColor": { # An RGB color. # An opaque RGB color.

2071

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2072

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2073

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

2074

},

2075

},

2076

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2077

"bold": True or False, # Whether or not the text is rendered as bold.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2078

"baselineOffset": "A String", # The text's vertical offset from its normal position.

2079

#

2080

# Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically

2081

# rendered in a smaller font size, computed based on the `font_size` field.

2082

# The `font_size` itself is not affected by changes in this field.

2083

"strikethrough": True or False, # Whether or not the text is struck through.

2084

"weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text.

2085

#

2086

# This field is an extension of `font_family` meant to support explicit font

2087

# weights without breaking backwards compatibility. As such, when reading the

2088

# style of a range of text, the value of `weighted_font_family#font_family`

2089

# will always be equal to that of `font_family`. However, when writing, if

2090

# both fields are included in the field mask (either explicitly or through

2091

# the wildcard `"*"`), their values are reconciled as follows:

2092

#

2093

# * If `font_family` is set and `weighted_font_family` is not, the value of

2094

# `font_family` is applied with weight `400` ("normal").

2095

# * If both fields are set, the value of `font_family` must match that of

2096

# `weighted_font_family#font_family`. If so, the font family and weight of

2097

# `weighted_font_family` is applied. Otherwise, a 400 bad request error is

2098

# returned.

2099

# * If `weighted_font_family` is set and `font_family` is not, the font

2100

# family and weight of `weighted_font_family` is applied.

2101

# * If neither field is set, the font family and weight of the text inherit

2102

# from the parent. Note that these properties cannot inherit separately

2103

# from each other.

2104

#

2105

# If an update request specifies values for both `weighted_font_family` and

2106

# `bold`, the `weighted_font_family` is applied first, then `bold`.

2107

#

2108

# If `weighted_font_family#weight` is not set, it defaults to `400`.

2109

#

2110

# If `weighted_font_family` is set, then `weighted_font_family#font_family`

2111

# must also be set with a non-empty value. Otherwise, a 400 bad request error

2112

# is returned.

2113

"fontFamily": "A String", # The font family of the text.

2114

#

2115

# The font family can be any font from the Font menu in Slides or from

2116

# [Google Fonts] (https://fonts.google.com/). If the font name is

2117

# unrecognized, the text is rendered in `Arial`.

2118

"weight": 42, # The rendered weight of the text. This field can have any value that is a

2119

# multiple of `100` between `100` and `900`, inclusive. This range

2120

# corresponds to the numerical values described in the CSS 2.1

2121

# Specification,

2122

# [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),

2123

# with non-numerical values disallowed. Weights greater than or equal to

2124

# `700` are considered bold, and weights less than `700`are not bold. The

2125

# default value is `400` ("normal").

2126

},

2127

"smallCaps": True or False, # Whether or not the text is in small capital letters.

2128

"fontFamily": "A String", # The font family of the text.

2129

#

2130

# The font family can be any font from the Font menu in Slides or from

2131

# [Google Fonts] (https://fonts.google.com/). If the font name is

2132

# unrecognized, the text is rendered in `Arial`.

2133

#

2134

# Some fonts can affect the weight of the text. If an update request

2135

# specifies values for both `font_family` and `bold`, the explicitly-set

2136

# `bold` value is used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2137

"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links

2138

# are not inherited from parent text.

2139

#

2140

# Changing the link in an update request causes some other changes to the

2141

# text style of the range:

2142

#

2143

# * When setting a link, the text foreground color will be set to

2144

# ThemeColorType.HYPERLINK and the text will

2145

# be underlined. If these fields are modified in the same

2146

# request, those values will be used instead of the link defaults.

2147

# * Setting a link on a text range that overlaps with an existing link will

2148

# also update the existing link to point to the new URL.

2149

# * Links are not settable on newline characters. As a result, setting a link

2150

# on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,

2151

# will separate the newline character(s) into their own text runs. The

2152

# link will be applied separately to the runs before and after the newline.

2153

# * Removing a link will update the text style of the range to match the

2154

# style of the preceding text (or the default text styles if the preceding

2155

# text is another link) unless different styles are being set in the same

2156

# request.

2157

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

2158

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

2159

# in the presentation. There may not be a slide at this index.

2160

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

2161

# presentation with this ID. A page with this ID may not exist.

2162

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

2163

# addressed by its position.

2164

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2165

"italic": True or False, # Whether or not the text is italicized.

2166

"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

2167

# points.

2168

"magnitude": 3.14, # The magnitude.

2169

"unit": "A String", # The units for magnitude.

2170

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2171

"underline": True or False, # Whether or not the text is underlined.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2172

"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

2173

# transparent, depending on if the `opaque_color` field in it is set.

2174

"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents

2175

# a transparent color.

2176

"themeColor": "A String", # An opaque theme color.

2177

"rgbColor": { # An RGB color. # An opaque RGB color.

2178

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2179

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2180

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

2181

},

2182

},

2183

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

},

},

"listId": "A String", # The ID of the list.

2188

},

2189

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2190

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2191

"rowSpan": 42, # Row span of the cell.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2192

"tableCellProperties": { # The properties of the TableCell. # The properties of the table cell.

2193

"tableCellBackgroundFill": { # The table cell background fill. # The background fill of the table cell. The default fill matches the fill

2194

# for newly created table cells in the Slides editor.

2195

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

2196

# specified color value.

2197

#

2198

# If any field is unset, its value may be inherited from a parent placeholder

2199

# if it exists.

2200

"color": { # A themeable solid color value. # The color value of the solid fill.

2201

"themeColor": "A String", # An opaque theme color.

2202

"rgbColor": { # An RGB color. # An opaque RGB color.

2203

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2204

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2205

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

2206

},

2207

},

2208

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

2209

# That is, the final pixel color is defined by the equation:

2210

#

2211

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

2212

#

2213

# This means that a value of 1.0 corresponds to a solid color, whereas

2214

# a value of 0.0 corresponds to a completely transparent color.

2215

},

2216

"propertyState": "A String", # The background fill property state.

2217

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2218

# Updating the fill on a table cell will implicitly update this field

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2219

# to `RENDERED`, unless another value is specified in the same request. To

2220

# have no fill on a table cell, set this field to `NOT_RENDERED`. In this

2221

# case, any other fill fields set in the same request will be ignored.

2222

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2223

"contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment

2224

# matches the alignment for newly created table cells in the Slides editor.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2225

},

2226

"location": { # A location of a single table cell within a table. # The location of the cell within the table.

2227

"rowIndex": 42, # The 0-based row index.

2228

"columnIndex": 42, # The 0-based column index.

2229

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2230

"columnSpan": 42, # Column span of the cell.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2231

},

2232

],

2233

"rowHeight": { # A magnitude in a single direction in the specified units. # Height of a row.

2234

"magnitude": 3.14, # The magnitude.

2235

"unit": "A String", # The units for magnitude.

2236

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2237

"tableRowProperties": { # Properties of each row in a table. # Properties of the row.

2238

"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

2239

# a height equal to or greater than this value in order to show all the text

2240

# in the row's cell(s).

2241

"magnitude": 3.14, # The magnitude.

2242

"unit": "A String", # The units for magnitude.

2243

},

2244

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2245

},

2246

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2247

"columns": 42, # Number of columns in the table.

2248

},

2249

"line": { # A PageElement kind representing a # A line page element.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2250

# non-connector line, straight connector, curved connector, or bent connector.

2251

"lineCategory": "A String", # The category of the line.

2252

#

2253

# It matches the `category` specified in CreateLineRequest, and can be updated with

2254

# UpdateLineCategoryRequest.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2255

"lineProperties": { # The properties of the Line. # The properties of the line.

2256

#

2257

# When unset, these fields default to values that match the appearance of

2258

# new lines created in the Slides editor.

2259

"dashStyle": "A String", # The dash style of the line.

2260

"weight": { # A magnitude in a single direction in the specified units. # The thickness of the line.

2261

"magnitude": 3.14, # The magnitude.

2262

"unit": "A String", # The units for magnitude.

2263

},

2264

"endArrow": "A String", # The style of the arrow at the end of the line.

2265

"link": { # A hypertext link. # The hyperlink destination of the line. If unset, there is no link.

2266

"url": "A String", # If set, indicates this is a link to the external web page at this URL.

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

2267

"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index

2268

# in the presentation. There may not be a slide at this index.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2269

"pageObjectId": "A String", # If set, indicates this is a link to the specific page in this

2270

# presentation with this ID. A page with this ID may not exist.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2271

"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,

2272

# addressed by its position.

2273

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2274

"startArrow": "A String", # The style of the arrow at the beginning of the line.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2275

"startConnection": { # The properties for one end of a Line # The connection at the beginning of the line. If unset, there is no

2276

# connection.

2277

#

2278

# Only lines with a Type indicating it is

2279

# a "connector" can have a `start_connection`.

2280

# connection.

2281

"connectionSiteIndex": 42, # The index of the connection site on the connected page element.

2282

#

2283

# In most cases, it corresponds to the predefined connection site index from

2284

# the ECMA-376 standard. More information on those connection sites can be

2285

# found in the description of the "cnx" attribute in section 20.1.9.9 and

2286

# Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open

2287

# XML File Formats-Fundamentals and Markup Language Reference", part 1 of

2288

# [ECMA-376 5th edition]

2289

# (http://www.ecma-international.org/publications/standards/Ecma-376.htm).

2290

#

2291

# The position of each connection site can also be viewed from Slides editor.

2292

"connectedObjectId": "A String", # The object ID of the connected page element.

2293

#

2294

# Some page elements, such as groups, tables, and lines

2295

# do not have connection sites and therefore cannot be connected to a

2296

# connector line.

2297

},

2298

"endConnection": { # The properties for one end of a Line # The connection at the end of the line. If unset, there is no connection.

2299

#

2300

# Only lines with a Type indicating it is

2301

# a "connector" can have an `end_connection`.

2302

# connection.

2303

"connectionSiteIndex": 42, # The index of the connection site on the connected page element.

2304

#

2305

# In most cases, it corresponds to the predefined connection site index from

2306

# the ECMA-376 standard. More information on those connection sites can be

2307

# found in the description of the "cnx" attribute in section 20.1.9.9 and

2308

# Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open

2309

# XML File Formats-Fundamentals and Markup Language Reference", part 1 of

2310

# [ECMA-376 5th edition]

2311

# (http://www.ecma-international.org/publications/standards/Ecma-376.htm).

2312

#

2313

# The position of each connection site can also be viewed from Slides editor.

2314

"connectedObjectId": "A String", # The object ID of the connected page element.

2315

#

2316

# Some page elements, such as groups, tables, and lines

2317

# do not have connection sites and therefore cannot be connected to a

2318

# connector line.

2319

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2320

"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new

2321

# lines created in the Slides editor.

2322

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

2323

# specified color value.

2324

#

2325

# If any field is unset, its value may be inherited from a parent placeholder

2326

# if it exists.

2327

"color": { # A themeable solid color value. # The color value of the solid fill.

2328

"themeColor": "A String", # An opaque theme color.

2329

"rgbColor": { # An RGB color. # An opaque RGB color.

2330

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2331

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2332

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

2333

},

2334

},

2335

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

2336

# That is, the final pixel color is defined by the equation:

2337

#

2338

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

2339

#

2340

# This means that a value of 1.0 corresponds to a solid color, whereas

2341

# a value of 0.0 corresponds to a completely transparent color.

2342

},

2343

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2344

},

2345

"lineType": "A String", # The type of the line.

2346

},

2347

"size": { # A width and height. # The size of the page element.

2348

"width": { # A magnitude in a single direction in the specified units. # The width of the object.

2349

"magnitude": 3.14, # The magnitude.

2350

"unit": "A String", # The units for magnitude.

2351

},

2352

"height": { # A magnitude in a single direction in the specified units. # The height of the object.

2353

"magnitude": 3.14, # The magnitude.

2354

"unit": "A String", # The units for magnitude.

2355

},

2356

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2357

"elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.

2358

# joined collection of PageElements.

2359

"children": [ # The collection of elements in the group. The minimum size of a group is 2.

2360

# Object with schema name: PageElement

2361

],

2362

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2363

},

2364

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2365

"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.

2366

# relevant for pages with page_type NOTES.

2367

"speakerNotesObjectId": "A String", # The object ID of the shape on this notes page that contains the speaker

2368

# notes for the corresponding slide.

2369

# The actual shape may not always exist on the notes page. Inserting text

2370

# using this object ID will automatically create the shape. In this case, the

2371

# actual shape may have different object ID. The `GetPresentation` or

2372

# `GetPage` action will always return the latest object ID.

2373

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2374

"objectId": "A String", # The object ID for this page. Object IDs used by

2375

# Page and

2376

# PageElement share the same namespace.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2377

"revisionId": "A String", # The revision ID of the presentation containing this page. Can be used in

2378

# update requests to assert that the presentation revision hasn't changed

2379

# since the last read operation. Only populated if the user has edit access

2380

# to the presentation.

2381

#

2382

# The format of the revision ID may change over time, so it should be treated

2383

# opaquely. A returned revision ID is only guaranteed to be valid for 24

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2384

# hours after it has been returned and cannot be shared across users. If the

2385

# revision ID is unchanged between calls, then the presentation has not

2386

# changed. Conversely, a changed ID (for the same presentation and user)

2387

# usually means the presentation has been updated; however, a changed ID can

2388

# also be due to internal factors such as ID format changes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2389

"masterProperties": { # The properties of Page that are only # Master specific properties. Only set if page_type = MASTER.

2390

# relevant for pages with page_type MASTER.

2391

"displayName": "A String", # The human-readable name of the master.

2392

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2393

"pageProperties": { # The properties of the Page. # The properties of the page.

2394

#

2395

# The page will inherit properties from the parent page. Depending on the page

2396

# type the hierarchy is defined in either

2397

# SlideProperties or

2398

# LayoutProperties.

2399

"pageBackgroundFill": { # The page background fill. # The background fill of the page. If unset, the background fill is inherited

2400

# from a parent page if it exists. If the page has no parent, then the

2401

# background fill defaults to the corresponding fill in the Slides editor.

2402

"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.

2403

# specified color value.

2404

#

2405

# If any field is unset, its value may be inherited from a parent placeholder

2406

# if it exists.

2407

"color": { # A themeable solid color value. # The color value of the solid fill.

2408

"themeColor": "A String", # An opaque theme color.

2409

"rgbColor": { # An RGB color. # An opaque RGB color.

2410

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2411

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2412

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

2413

},

2414

},

2415

"alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.

2416

# That is, the final pixel color is defined by the equation:

2417

#

2418

# pixel color = alpha * (color) + (1.0 - alpha) * (background color)

2419

#

2420

# This means that a value of 1.0 corresponds to a solid color, whereas

2421

# a value of 0.0 corresponds to a completely transparent color.

2422

},

2423

"propertyState": "A String", # The background fill property state.

2424

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2425

# Updating the fill on a page will implicitly update this field to

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2426

# `RENDERED`, unless another value is specified in the same request. To

2427

# have no fill on a page, set this field to `NOT_RENDERED`. In this case,

2428

# any other fill fields set in the same request will be ignored.

2429

"stretchedPictureFill": { # The stretched picture fill. The page or page element is filled entirely with # Stretched picture fill.

2430

# the specified picture. The picture is stretched to fit its container.

2431

"contentUrl": "A String", # Reading the content_url:

2432

#

2433

# An URL to a picture with a default lifetime of 30 minutes.

2434

# This URL is tagged with the account of the requester. Anyone with the URL

2435

# effectively accesses the picture as the original requester. Access to the

2436

# picture may be lost if the presentation's sharing settings change.

2437

#

2438

# Writing the content_url:

2439

#

2440

# The picture is fetched once at insertion time and a copy is stored for

2441

# display inside the presentation. Pictures must be less than 50MB in size,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2442

# cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2443

# format.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2444

#

2445

# The provided URL can be at most 2 kB in length.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2446

"size": { # A width and height. # The original size of the picture fill. This field is read-only.

2447

"width": { # A magnitude in a single direction in the specified units. # The width of the object.

2448

"magnitude": 3.14, # The magnitude.

2449

"unit": "A String", # The units for magnitude.

2450

},

2451

"height": { # A magnitude in a single direction in the specified units. # The height of the object.

2452

"magnitude": 3.14, # The magnitude.

2453

"unit": "A String", # The units for magnitude.

},

},

},

},

"colorScheme": { # The palette of predefined colors for a page. # The color scheme of the page. If unset, the color scheme is inherited from

2459

# a parent page. If the page has no parent, the color scheme uses a default

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame^]

2460

# Slides color scheme, matching the defaults in the Slides editor.

2461

#

2462

# Only the concrete colors of the first 12 ThemeColorTypes are editable. In addition, only

2463

# the color scheme on `Master` pages can be updated. To update the field, a

2464

# color scheme containing mappings from all the first 12 ThemeColorTypes to

2465

# their concrete colors must be provided. Colors for the remaining

2466

# ThemeColorTypes will be ignored.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2467

"colors": [ # The ThemeColorType and corresponding concrete color pairs.

2468

{ # A pair mapping a theme color type to the concrete color it represents.

2469

"color": { # An RGB color. # The concrete color corresponding to the theme color type above.

2470

"blue": 3.14, # The blue component of the color, from 0.0 to 1.0.

2471

"green": 3.14, # The green component of the color, from 0.0 to 1.0.

2472

"red": 3.14, # The red component of the color, from 0.0 to 1.0.

2473

},

2474

"type": "A String", # The type of the theme color.

},

],

},

},

"pageType": "A String", # The type of the page.

2480

"slideProperties": { # The properties of Page that are only # Slide specific properties. Only set if page_type = SLIDE.

2481

# relevant for pages with page_type SLIDE.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2482

"notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual

2483

# appearance of a notes page when printing or exporting slides with speaker

2484

# notes. A notes page inherits properties from the

2485

# notes master.

2486

# The placeholder shape with type BODY on the notes page contains the speaker

2487

# notes for this slide. The ID of this shape is identified by the

2488

# speakerNotesObjectId field.

2489

# The notes page is read-only except for the text content and styles of the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2490

# speaker notes shape. This property is read-only.

2491

"masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is

2492

# read-only.

2493

"layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is

2494

# read-only.

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

2500

<code class="details" id="getThumbnail">getThumbnail(presentationId, pageObjectId, thumbnailProperties_mimeType=None, thumbnailProperties_thumbnailSize=None, x__xgafv=None)</code>

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