EmbeddedObject

An embedded object in the document.

JSON representation
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
Fields
title

string

The title of the embedded object. The title and description are both combined to display alt text.

description

string

The description of the embedded object. The title and description are both combined to display alt text.

embeddedObjectBorder

object (EmbeddedObjectBorder)

The border of the embedded object.

size

object (Size)

The visible size of the image after cropping.

marginTop

object (Dimension)

The top margin of the embedded object.

marginBottom

object (Dimension)

The bottom margin of the embedded object.

marginRight

object (Dimension)

The right margin of the embedded object.

marginLeft

object (Dimension)

The left margin of the embedded object.

linkedContentReference

object (LinkedContentReference)

A reference to the external linked source content. For example, it contains a reference to the source Sheets chart when the embedded object is a linked chart.

If unset, then the embedded object is not linked.

Union field properties. The properties that are specific to each embedded object type. properties can be only one of the following:
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

The properties of an embedded drawing.

imageProperties

object (ImageProperties)

The properties of an image.

ImageProperties

The properties of an image.

JSON representation
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
Fields
contentUri

string

A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.

sourceUri

string

The source URI is the URI used to insert the image. The source URI can be empty.

brightness

number

The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

contrast

number

The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

transparency

number

The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent.

cropProperties

object (CropProperties)

The crop properties of the image.

angle

number

The clockwise rotation angle of the image, in radians.

EmbeddedObjectBorder

A border around an EmbeddedObject.

JSON representation
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
Fields
color

object (OptionalColor)

The color of the border.

width

object (Dimension)

The width of the border.

dashStyle

enum (DashStyle)

The dash style of the border.

propertyState

enum (PropertyState)

The property state of the border property.

LinkedContentReference

A reference to the external linked source content.

JSON representation
{
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
}
Fields
sheetsChartReference

object (SheetsChartReference)

A reference to the linked chart.

SheetsChartReference

A reference to a linked chart embedded from Google Sheets.

JSON representation
{
  "spreadsheetId": string,
  "chartId": number
}
Fields
spreadsheetId

string

The ID of the Google Sheets spreadsheet that contains the source chart.

chartId

number

The ID of the specific chart in the Google Sheets spreadsheet that is embedded.