REST Resource: documents

Recurso: Document

Um documento do Google Docs.

Representação JSON
{
  "documentId": string,
  "title": string,
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Campos
documentId

string

Apenas saída. O ID do documento.

title

string

O título do documento.

body

object (Body)

Apenas saída. O corpo principal do documento.

headers

map (key: string, value: object (Header))

Apenas saída. Os cabeçalhos no documento, codificados pelo ID do cabeçalho.

footers

map (key: string, value: object (Footer))

Apenas saída. Os rodapés no documento, codificados pelo ID do rodapé.

footnotes

map (key: string, value: object (Footnote))

Apenas saída. As notas de rodapé no documento, codificadas pelo código da nota de rodapé.

documentStyle

object (DocumentStyle)

Apenas saída. O estilo do documento.

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Apenas saída. As alterações sugeridas para o estilo do documento, codificadas pelo código da sugestão.

namedStyles

object (NamedStyles)

Apenas saída. Os estilos nomeados do documento.

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Apenas saída. As alterações sugeridas para os estilos nomeados do documento, codificadas pelo ID da sugestão.

lists

map (key: string, value: object (List))

Apenas saída. As listas no documento, codificadas pelo código da lista.

namedRanges

map (key: string, value: object (NamedRanges))

Apenas saída. Os intervalos nomeados no documento, codificados por nome.

revisionId

string

Apenas saída. O ID de revisão do documento. Pode ser usado em solicitações de atualização para especificar a qual revisão de um documento as atualizações serão aplicadas e como a solicitação deve se comportar se o documento tiver sido editado desde a revisão. Preenchido apenas se o usuário tiver acesso de edição ao documento.

O código de revisão não é um número sequencial, mas uma string opaca. O formato do ID de revisão pode mudar ao longo do tempo. Um código de revisão retornado só é válido por 24 horas depois de ser retornado e não pode ser compartilhado entre usuários. Se o ID de revisão não for alterado entre as chamadas, o documento não foi alterado. Por outro lado, um ID alterado (para o mesmo documento e usuário) normalmente significa que o documento foi atualizado. No entanto, um ID alterado também pode ser causado por fatores internos, como alterações no formato do ID.

suggestionsViewMode

enum (SuggestionsViewMode)

Apenas saída. O modo de visualização de sugestões aplicado ao documento.

Observação: ao editar um documento, as alterações precisam ser baseadas em um documento com SUGGESTIONS_INLINE.

inlineObjects

map (key: string, value: object (InlineObject))

Apenas saída. Os objetos in-line no documento, codificados pelo ID do objeto.

positionedObjects

map (key: string, value: object (PositionedObject))

Apenas saída. Os objetos posicionados no documento, codificados pelo ID do objeto.

Body

O corpo do documento.

O corpo normalmente contém todo o conteúdo do documento, exceto headers, footers e footnotes.

Representação JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Campos
content[]

object (StructuralElement)

O conteúdo do corpo.

Os índices do conteúdo do corpo começam em zero.

Elemento estrutural

Um StructuralElement descreve o conteúdo que fornece estrutura para o documento.

Representação JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
Campos
startIndex

integer

O índice inicial deste elemento estrutural, com base em zero, em unidades de código UTF-16.

endIndex

integer

O índice final desse elemento estrutural, exclusivo, em unidades de código UTF-16.

Campo de união content. O conteúdo do elemento estrutural. content pode ser apenas de um dos tipos a seguir:
paragraph

object (Paragraph)

Um tipo de parágrafo de elemento estrutural.

sectionBreak

object (SectionBreak)

Um tipo de quebra de seção do elemento estrutural.

table

object (Table)

Um tipo de tabela de elemento estrutural.

tableOfContents

object (TableOfContents)

Um índice no tipo de elemento estrutural.

Parágrafo

Um StructuralElement que representa um parágrafo. Um parágrafo é um intervalo de conteúdo terminado em um caractere de nova linha.

Representação JSON
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
Campos
elements[]

object (ParagraphElement)

O conteúdo do parágrafo, dividido em suas partes componentes.

paragraphStyle

object (ParagraphStyle)

O estilo deste parágrafo.

suggestedParagraphStyleChanges

map (key: string, value: object (SuggestedParagraphStyle))

O estilo de parágrafo sugerido muda para este parágrafo, codificado pelo código da sugestão.

bullet

object (Bullet)

O marcador para este parágrafo. Se não estiver presente, o parágrafo não pertence a uma lista.

suggestedBulletChanges

map (key: string, value: object (SuggestedBullet))

As alterações sugeridas para o marcador deste parágrafo.

positionedObjectIds[]

string

Os IDs dos objetos posicionados vinculados a este parágrafo.

suggestedPositionedObjectIds

map (key: string, value: object (ObjectReferences))

Os IDs dos objetos posicionados sugeridos para serem anexados a este parágrafo, codificados pelo ID da sugestão.

ParagraphElemento

Um ParagraphElement descreve conteúdo em uma Paragraph.

Representação JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  }
  // End of list of possible types for union field content.
}
Campos
startIndex

integer

O índice inicial deste elemento do parágrafo, com base em zero, em unidades de código UTF-16.

endIndex

integer

O índice final de base zero desse elemento de parágrafo, exclusivo, em unidades de código UTF-16.

Campo de união content. O conteúdo do elemento do parágrafo. content pode ser apenas de um dos tipos a seguir:
textRun

object (TextRun)

Um elemento de parágrafo de execução de texto.

autoText

object (AutoText)

Um elemento de parágrafo de texto automático.

pageBreak

object (PageBreak)

Um elemento de parágrafo de quebra de página.

columnBreak

object (ColumnBreak)

Um elemento de parágrafo de quebra de coluna.

footnoteReference

object (FootnoteReference)

Um elemento de parágrafo de referência da nota de rodapé.

horizontalRule

object (HorizontalRule)

Um elemento de parágrafo de regra horizontal.

equation

object (Equation)

Um elemento de parágrafo da equação.

inlineObjectElement

object (InlineObjectElement)

Um elemento de parágrafo do objeto in-line.

person

object (Person)

Um elemento de parágrafo vinculado a uma pessoa ou um endereço de e-mail.

Execução de texto

Um ParagraphElement que representa um conjunto de textos com o mesmo estilo.

Representação JSON
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
content

string

O texto dessa execução.

Todos os elementos não textuais na execução são substituídos pelo caractere Unicode U+E907.

suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma TextRun pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

textStyle

object (TextStyle)

O estilo de texto dessa execução.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

O estilo de texto sugerido muda para essa execução, indicado pelo ID da sugestão.

TextStyle

Representa o estilo que pode ser aplicado ao texto.

Os estilos de texto herdados são representados como campos não definidos nesta mensagem. O pai de um estilo de texto depende de onde o estilo de texto é definido:

  • O TextStyle do texto em uma Paragraph herda do named style type correspondente do parágrafo.
  • O TextStyle em um named style herda do estilo nomeado normal text.
  • O TextStyle do estilo nomeado normal text herda do estilo de texto padrão no editor do Documentos.
  • O TextStyle em um elemento Paragraph contido em uma tabela pode herdar o estilo de texto dele.

Se o estilo de texto não herdar de um pai, cancelar a configuração dos campos reverterá o estilo para um valor que corresponda aos padrões no editor do Documentos.

Representação JSON
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
Campos
bold

boolean

Indica se o texto é renderizado como negrito.

italic

boolean

Se o texto está ou não em itálico.

underline

boolean

Se o texto está sublinhado ou não.

strikethrough

boolean

Se o texto é tachado ou não.

smallCaps

boolean

Se o texto está em letras minúsculas ou não.

backgroundColor

object (OptionalColor)

A cor do plano de fundo do texto. Se definida, a cor será RGB ou transparente, dependendo do campo color.

foregroundColor

object (OptionalColor)

A cor de primeiro plano do texto. Se definida, a cor será RGB ou transparente, dependendo do campo color.

fontSize

object (Dimension)

O tamanho da fonte do texto.

weightedFontFamily

object (WeightedFontFamily)

A família de fontes e a ponderação renderizada do texto.

Se uma solicitação de atualização especificar valores para weightedFontFamily e bold, o weightedFontFamily será aplicado primeiro e depois bold.

Se weightedFontFamily#weight não estiver definido, o padrão será 400.

Se weightedFontFamily estiver definido, weightedFontFamily#fontFamily também precisa ser definido com um valor não vazio. Caso contrário, será retornado um erro 400 de solicitação inválida.

baselineOffset

enum (BaselineOffset)

O deslocamento vertical do texto a partir da posição normal.

O texto com deslocamentos de valor de referência SUPERSCRIPT ou SUBSCRIPT é renderizado automaticamente em um tamanho de fonte menor, calculado com base no campo fontSize. As alterações nesse campo não afetam o fontSize.

Cor opcional

Uma cor que pode ser totalmente opaca ou totalmente transparente.

Representação JSON
{
  "color": {
    object (Color)
  }
}
Campos
color

object (Color)

Se definido, ele será usado como uma cor opaca. Se não for definida, representará uma cor transparente.

Cor

Uma cor sólida.

Representação JSON
{
  "rgbColor": {
    object (RgbColor)
  }
}
Campos
rgbColor

object (RgbColor)

O valor da cor RGB.

Cor gb

Uma cor RGB.

Representação JSON
{
  "red": number,
  "green": number,
  "blue": number
}
Campos
red

number

O componente vermelho da cor, de 0,0 a 1,0.

green

number

O componente verde da cor, de 0,0 a 1,0.

blue

number

O componente azul da cor, de 0,0 a 1,0.

Dimensão

Uma magnitude em uma única direção nas unidades especificadas.

Representação JSON
{
  "magnitude": number,
  "unit": enum (Unit)
}
Campos
magnitude

number

A magnitude.

unit

enum (Unit)

As unidades de magnitude.

Unidade

Unidades de medida.

Enums
UNIT_UNSPECIFIED As unidades são desconhecidas.
PT Um ponto, 1/72 de polegada.

Família de fontes ponderadas

Representa uma família de fontes e o peso do texto.

Representação JSON
{
  "fontFamily": string,
  "weight": integer
}
Campos
fontFamily

string

A família de fontes do texto.

A família de fontes pode ser qualquer fonte do menu "Fontes" do Documentos ou do Google Fonts. Se o nome da fonte não for reconhecido, o texto será renderizado em Arial.

weight

integer

A espessura da fonte. Esse campo pode ter qualquer valor que seja um múltiplo de 100 entre 100 e 900, inclusive. Esse intervalo corresponde aos valores numéricos descritos na Especificação CSS 2.1, seção 15.6, com valores não numéricos não permitidos.

O valor padrão é 400 ("normal").

O peso da fonte forma apenas um componente do peso da fonte renderizada. Uma combinação de weight e do valor de bold resolvido do estilo de texto determina a ponderação renderizada, após considerar a herança:

  • Se o texto estiver em negrito e a ponderação for menor que 400, a ponderação renderizada será de 400.
  • Se o texto estiver em negrito e a ponderação for maior ou igual a 400, mas for menor que 700, a ponderação renderizada será 700.
  • Se a ponderação for maior ou igual a 700, a ponderação renderizada será igual à ponderação.
  • Se o texto não estiver em negrito, a ponderação renderizada será igual à ponderação.

Deslocamento base

Maneiras em que o texto pode ser deslocado verticalmente da posição normal.

Enums
BASELINE_OFFSET_UNSPECIFIED O deslocamento do valor de referência do texto é herdado do pai.
NONE O texto não está deslocado verticalmente.
SUPERSCRIPT O texto está deslocado verticalmente para cima (sobrescrito).
SUBSCRIPT O texto está deslocado verticalmente para baixo (subscrito).

Estilo de texto sugerido

Uma alteração sugerida para um TextStyle.

Representação JSON
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Campos
textStyle

object (TextStyle)

Um TextStyle que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com textStyleSuggestionState para ver quais campos foram alterados e os novos valores deles.

textStyleSuggestionState

object (TextStyleSuggestionState)

Uma máscara que indica quais dos campos na base TextStyle foram alterados nessa sugestão.

TextStyleSuggestionState

Uma máscara que indica quais dos campos na base TextStyle foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
Campos
boldSuggested

boolean

Indica se houve uma alteração sugerida para bold.

italicSuggested

boolean

Indica se houve uma alteração sugerida para italic.

underlineSuggested

boolean

Indica se houve uma alteração sugerida para underline.

strikethroughSuggested

boolean

Indica se houve uma alteração sugerida para strikethrough.

smallCapsSuggested

boolean

Indica se houve uma alteração sugerida para smallCaps.

backgroundColorSuggested

boolean

Indica se houve uma alteração sugerida para backgroundColor.

foregroundColorSuggested

boolean

Indica se houve uma alteração sugerida para foregroundColor.

fontSizeSuggested

boolean

Indica se houve uma alteração sugerida para fontSize.

weightedFontFamilySuggested

boolean

Indica se houve uma alteração sugerida para weightedFontFamily.

baselineOffsetSuggested

boolean

Indica se houve uma alteração sugerida para baselineOffset.

Texto automático

Um ParagraphElement que representa uma posição no texto que é substituída dinamicamente por um conteúdo que pode mudar ao longo do tempo, como um número de página.

Representação JSON
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
type

enum (Type)

O tipo deste texto automático.

suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma AutoText pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

textStyle

object (TextStyle)

O estilo de texto deste AutoText.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

O estilo de texto sugerido muda para esse texto automático, codificado pelo código da sugestão.

Tipo

Os tipos de texto automático.

Enums
TYPE_UNSPECIFIED Um tipo de texto automático não especificado.
PAGE_NUMBER Tipo de texto automático que representa o número da página atual.
PAGE_COUNT Tipo de texto automático que representa o número total de páginas no documento.

Quebra de página

Um ParagraphElement que representa uma quebra de página. Uma quebra de página faz com que o texto subsequente comece na parte superior da próxima página.

Representação JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma PageBreak pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

textStyle

object (TextStyle)

O estilo de texto deste PageBreak.

Assim como o conteúdo de texto, como execuções de texto e referências de nota de rodapé, o estilo de texto de uma quebra de página pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

O estilo de texto sugerido muda para este PageBreak, inserido pelo ID da sugestão.

Quebra de coluna

Um ParagraphElement que representa uma quebra de coluna. Uma quebra de coluna faz com que o texto subsequente comece na parte superior da próxima coluna.

Representação JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma ColumnBreak pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

textStyle

object (TextStyle)

O estilo de texto dessa ColumnBreak.

Assim como o conteúdo de texto, como execuções de texto e referências de nota de rodapé, o estilo de texto de uma quebra de coluna pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

O estilo de texto sugerido muda para essa coluna, dividida pelo código da sugestão.

Referência da nota de rodapé

Um ParagraphElement que representa uma referência de nota de rodapé. Uma referência de nota de rodapé é o conteúdo in-line renderizado com um número e é usado para identificar a nota de rodapé.

Representação JSON
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
footnoteId

string

O ID do footnote que contém o conteúdo desta referência de nota de rodapé.

footnoteNumber

string

O número renderizado dessa nota de rodapé.

suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma FootnoteReference pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

textStyle

object (TextStyle)

O estilo de texto desta FootnoteReference.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

O estilo de texto sugerido muda para essa FootnoteReference, inserido pelo ID da sugestão.

Regra horizontal

Um ParagraphElement que representa uma linha horizontal.

Representação JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma HorizontalRule pode ter vários IDs de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

textStyle

object (TextStyle)

O estilo de texto dessa HorizontalRule.

Semelhante ao conteúdo de texto, como execuções de texto e referências de nota de rodapé, o estilo de texto de uma regra horizontal pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

O estilo de texto sugerido muda para esta horizontal, codificado pelo código da sugestão.

Equação

Um ParagraphElement que representa uma equação.

Representação JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Campos
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma Equation pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

InLineObjectElement

Um ParagraphElement que contém um InlineObject.

Representação JSON
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
inlineObjectId

string

O ID da InlineObject que esse elemento contém.

suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma InlineObjectElement pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

textStyle

object (TextStyle)

O estilo de texto deste InlineObjectElement.

Assim como o conteúdo de texto, como execuções de texto e referências de nota de rodapé, o estilo de texto de um elemento de objeto in-line pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

O estilo de texto sugerido muda para este InlineObject, codificado pelo ID da sugestão.

Pessoa

Uma pessoa ou um endereço de e-mail mencionado em um documento. Essas referências se comportam como um único elemento imutável, que contém o nome ou o endereço de e-mail da pessoa.

Representação JSON
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
Campos
personId

string

Apenas saída. O ID exclusivo desse link.

suggestedInsertionIds[]

string

IDs de sugestões que inserem o link desta pessoa no documento. Uma Person pode ter vários códigos de inserção se for uma alteração sugerida aninhada (uma sugestão em uma sugestão feita por um usuário diferente, por exemplo). Se estiver vazio, esse link de pessoa não é uma inserção sugerida.

suggestedDeletionIds[]

string

IDs de sugestões que removem o link desta pessoa do documento. Um Person pode ter vários códigos de exclusão se, por exemplo, vários usuários sugerirem a exclusão. Se estiver vazio, o link dessa pessoa não será sugerido para exclusão.

textStyle

object (TextStyle)

O estilo de texto deste Person.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

O estilo de texto sugerido muda para este Person, codificado pelo ID da sugestão.

personProperties

object (PersonProperties)

Apenas saída. As propriedades desse Person. Este campo está sempre presente.

Propriedades de pessoa

Propriedades específicas de um Person vinculado.

Representação JSON
{
  "name": string,
  "email": string
}
Campos
name

string

Apenas saída. O nome da pessoa, se ele for exibido no texto do link em vez do endereço de e-mail da pessoa.

email

string

Apenas saída. O endereço de e-mail vinculado a este Person. Este campo está sempre presente.

PropriedadesLink

Propriedades específicas de um RichLink.

Representação JSON
{
  "title": string,
  "uri": string,
  "mimeType": string
}
Campos
title

string

Apenas saída. O título da RichLink, conforme exibido no link. Esse título corresponde ao título do recurso vinculado no momento da inserção ou da última atualização do link. Este campo está sempre presente.

uri

string

Apenas saída. O URI do RichLink. Ela está sempre presente.

mimeType

string

Apenas saída. O tipo MIME da RichLink, se houver, por exemplo, quando for um arquivo no Drive.

ParagraphStyle

Estilos que se aplicam a um parágrafo inteiro.

Os estilos de parágrafo herdados são representados como campos não definidos nesta mensagem. O pai de um estilo de parágrafo depende de onde o estilo é definido:

  • O ParagraphStyle em um Paragraph herda do named style type correspondente do parágrafo.
  • O ParagraphStyle em um named style herda do estilo nomeado normal text.
  • O ParagraphStyle do estilo nomeado normal text herda do estilo de parágrafo padrão no editor do Documentos.
  • O ParagraphStyle em um elemento Paragraph contido em uma tabela pode herdar o estilo de parágrafo do estilo da tabela.

Se o estilo do parágrafo não for herdado de um elemento pai, a não definição dos campos o reverterá para um valor que corresponda aos padrões do editor do Documentos Google.

Representação JSON
{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
Campos
headingId

string

O ID do título do parágrafo. Se estiver vazio, esse parágrafo não será um título.

Esta propriedade é somente leitura.

namedStyleType

enum (NamedStyleType)

O tipo de estilo nomeado do parágrafo.

Como a atualização do tipo de estilo nomeado afeta outras propriedades no ParagraphStyle, o tipo de estilo nomeado é aplicado antes que as outras propriedades sejam atualizadas.

alignment

enum (Alignment)

O alinhamento do texto para este parágrafo.

lineSpacing

number

A quantidade de espaço entre as linhas, como uma porcentagem do normal, em que o normal é representado como 100,0. Se não for definido, o valor será herdado do pai.

direction

enum (ContentDirection)

A direção do texto deste parágrafo. Se não for definido, o valor padrão será LEFT_TO_RIGHT, já que a direção do parágrafo não é herdada.

spacingMode

enum (SpacingMode)

O modo de espaçamento para o parágrafo.

spaceAbove

object (Dimension)

A quantidade de espaço extra acima do parágrafo. Se não for definido, o valor será herdado do pai.

spaceBelow

object (Dimension)

A quantidade de espaço extra abaixo do parágrafo. Se não for definido, o valor será herdado do pai.

borderBetween

object (ParagraphBorder)

A borda entre este parágrafo e os parágrafos seguinte e anterior. Se não for definido, o valor será herdado do pai.

A borda entre é renderizada quando o parágrafo adjacente tem as mesmas propriedades de borda e recuo.

As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo.

borderTop

object (ParagraphBorder)

A borda na parte superior deste parágrafo. Se não for definido, o valor será herdado do pai.

A borda superior é renderizada quando o parágrafo acima tem propriedades de borda e recuo diferentes.

As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo.

borderBottom

object (ParagraphBorder)

A borda na parte inferior deste parágrafo. Se não for definido, o valor será herdado do pai.

A borda inferior é renderizada quando o parágrafo abaixo tem propriedades de borda e recuo diferentes.

As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo.

borderLeft

object (ParagraphBorder)

A borda à esquerda deste parágrafo. Se não for definido, o valor será herdado do pai.

As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo.

borderRight

object (ParagraphBorder)

A borda à direita deste parágrafo. Se não for definido, o valor será herdado do pai.

As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo.

indentFirstLine

object (Dimension)

A quantidade de recuo para a primeira linha do parágrafo. Se não for definido, o valor será herdado do pai.

indentStart

object (Dimension)

A quantidade de recuo do parágrafo na lateral que corresponde ao início do texto, com base na direção atual do parágrafo. Se não for definido, o valor será herdado do pai.

indentEnd

object (Dimension)

A quantidade de recuo do parágrafo na lateral que corresponde ao final do texto, com base na direção atual do parágrafo. Se não for definido, o valor será herdado do pai.

tabStops[]

object (TabStop)

Uma lista da guia para esse parágrafo. A lista de paradas de tabulação não é herdada.

Esta propriedade é somente leitura.

keepLinesTogether

boolean

Indica se todas as linhas do parágrafo devem ser dispostas na mesma página ou coluna, se possível. Se não for definido, o valor será herdado do pai.

keepWithNext

boolean

Se pelo menos uma parte deste parágrafo deve ser colocada na mesma página ou coluna do próximo parágrafo, se possível. Se não for definido, o valor será herdado do pai.

avoidWidowAndOrphan

boolean

Define se viúvas e órfãos devem ser evitados no parágrafo. Se não for definido, o valor será herdado do pai.

shading

object (Shading)

O sombreamento do parágrafo. Se não for definido, o valor será herdado do pai.

pageBreakBefore

boolean

Se o parágrafo atual deve começar sempre no início de uma página. Se não for definido, o valor será herdado do pai.

A tentativa de atualizar pageBreakBefore para parágrafos em regiões incompatíveis, incluindo Table, Header, Footer e Footnote, pode resultar em um estado de documento inválido que retorna um erro 400 de solicitação inválida.

TipoNomeNomeado

Os tipos de estilos nomeados.

Enums
NAMED_STYLE_TYPE_UNSPECIFIED O tipo de estilo nomeado não foi especificado.
NORMAL_TEXT Texto normal.
TITLE Título.
SUBTITLE Legenda.
HEADING_1 Título 1.
HEADING_2 Título 2.
HEADING_3 Título 3.
HEADING_4 Título 4.
HEADING_5 Título 5.
HEADING_6 Título 6.

Alinhamento

Os tipos de alinhamento de texto de um parágrafo.

Enums
ALIGNMENT_UNSPECIFIED O alinhamento do parágrafo é herdado do elemento pai.
START O parágrafo está alinhado ao início da linha. Alinhado à esquerda para texto LTR, alinhado à direita caso contrário.
CENTER O parágrafo está centralizado.
END O parágrafo está alinhado ao final da linha. Alinhado à direita para texto LTR, alinhado à esquerda caso contrário.
JUSTIFIED O parágrafo é justificado.

ContentDirection

O conteúdo das rotas pode fluir.

Enums
CONTENT_DIRECTION_UNSPECIFIED A direção do conteúdo não é especificada.
LEFT_TO_RIGHT O conteúdo vai da esquerda para a direita.
RIGHT_TO_LEFT O conteúdo vai da direita para a esquerda.

Modo de espaçamento

Os diferentes modos de espaçamento de parágrafo.

Enums
SPACING_MODE_UNSPECIFIED O modo de espaçamento é herdado do principal.
NEVER_COLLAPSE O espaçamento entre parágrafos é sempre processado.
COLLAPSE_LISTS O espaçamento entre parágrafos é ignorado entre os elementos da lista.

Borda do parágrafo

Uma borda ao redor de um parágrafo.

Representação JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Campos
color

object (OptionalColor)

A cor da borda.

width

object (Dimension)

A largura da borda.

padding

object (Dimension)

O padding da borda.

dashStyle

enum (DashStyle)

O estilo de traço da borda.

Traço estilo

Os tipos de traços com os quais a geometria linear pode ser renderizada. Esses valores são baseados no tipo simples "ST_PresetLineDashVal" descrito na seção 20.1.10.48 de "Formatos de arquivos XML abertos do Office: referência da linguagem de marcação e fundamentos", parte 1 da 4a edição ECMA-376.

Enums
DASH_STYLE_UNSPECIFIED Estilo de traço não especificado.
SOLID Linha sólida. Corresponde ao valor ST_PresetLineDashVal ECMA-376 "sólido". Este é o estilo de traço padrão.
DOT Linha pontilhada. Corresponde ao valor "dot" de ECMA-376 ST_PresetLineDashVal.
DASH Linha tracejada. Corresponde ao valor "ST" de ECMA-376 ST_PresetLineDashVal.

TabTab

Uma tabulação para dentro de um parágrafo.

Representação JSON
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
Campos
offset

object (Dimension)

O deslocamento entre a parada da guia e a margem inicial.

alignment

enum (TabStopAlignment)

O alinhamento desta guia é interrompido. Se não for definido, o valor padrão será START.

TabStopAlignment

O alinhamento da parada de tabulação.

Enums
TAB_STOP_ALIGNMENT_UNSPECIFIED O alinhamento de tabulação não é especificado.
START A parada de tabulação está alinhada ao início da linha. Esse é o padrão.
CENTER A parada de tabulação é alinhada ao centro da linha.
END A parada de tabulação é alinhada ao final da linha.

Sombreamento

O sombreamento de um parágrafo.

Representação JSON
{
  "backgroundColor": {
    object (OptionalColor)
  }
}
Campos
backgroundColor

object (OptionalColor)

A cor do plano de fundo do sombreamento do parágrafo.

ParagraphParagraphStyle

Uma alteração sugerida para um ParagraphStyle.

Representação JSON
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Campos
paragraphStyle

object (ParagraphStyle)

Um ParagraphStyle que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com paragraphStyleSuggestionState para ver quais campos foram alterados e os novos valores deles.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Uma máscara que indica quais dos campos na base ParagraphStyle foram alterados nessa sugestão.

ParagraphStyleSuggestionState

Uma máscara que indica quais dos campos na base ParagraphStyle foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
Campos
headingIdSuggested

boolean

Indica se houve uma alteração sugerida para headingId.

namedStyleTypeSuggested

boolean

Indica se houve uma alteração sugerida para namedStyleType.

alignmentSuggested

boolean

Indica se houve uma alteração sugerida para alignment.

lineSpacingSuggested

boolean

Indica se houve uma alteração sugerida para lineSpacing.

directionSuggested

boolean

Indica se houve uma alteração sugerida para direction.

spacingModeSuggested

boolean

Indica se houve uma alteração sugerida para spacingMode.

spaceAboveSuggested

boolean

Indica se houve uma alteração sugerida para spaceAbove.

spaceBelowSuggested

boolean

Indica se houve uma alteração sugerida para spaceBelow.

borderBetweenSuggested

boolean

Indica se houve uma alteração sugerida para borderBetween.

borderTopSuggested

boolean

Indica se houve uma alteração sugerida para borderTop.

borderBottomSuggested

boolean

Indica se houve uma alteração sugerida para borderBottom.

borderLeftSuggested

boolean

Indica se houve uma alteração sugerida para borderLeft.

borderRightSuggested

boolean

Indica se houve uma alteração sugerida para borderRight.

indentFirstLineSuggested

boolean

Indica se houve uma alteração sugerida para indentFirstLine.

indentStartSuggested

boolean

Indica se houve uma alteração sugerida para indentStart.

indentEndSuggested

boolean

Indica se houve uma alteração sugerida para indentEnd.

keepLinesTogetherSuggested

boolean

Indica se houve uma alteração sugerida para keepLinesTogether.

keepWithNextSuggested

boolean

Indica se houve uma alteração sugerida para keepWithNext.

avoidWidowAndOrphanSuggested

boolean

Indica se houve uma alteração sugerida para avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

Uma máscara que indica quais campos do shading foram alterados nesta sugestão.

pageBreakBeforeSuggested

boolean

Indica se houve uma alteração sugerida para pageBreakBefore.

ShadingSuggestionState

Uma máscara que indica quais dos campos na base Shading foram alterados nessa alteração sugerida. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "backgroundColorSuggested": boolean
}
Campos
backgroundColorSuggested

boolean

Indica se houve uma alteração sugerida para o Shading.

Marcador

Descreve o marcador de um parágrafo.

Representação JSON
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
Campos
listId

string

O ID da lista à qual este parágrafo pertence.

nestingLevel

integer

O nível de aninhamento deste parágrafo na lista.

textStyle

object (TextStyle)

O estilo de texto específico do parágrafo aplicado a este marcador.

Marcador sugerido

Uma alteração sugerida para um Bullet.

Representação JSON
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
Campos
bullet

object (Bullet)

Um Bullet que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com bulletSuggestionState para ver quais campos foram alterados e os novos valores deles.

bulletSuggestionState

object (BulletSuggestionState)

Uma máscara que indica quais dos campos na base Bullet foram alterados nessa sugestão.

BulletSuggestionState

Uma máscara que indica quais dos campos na base Bullet foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Campos
listIdSuggested

boolean

Indica se houve uma alteração sugerida para o listId.

nestingLevelSuggested

boolean

Indica se houve uma alteração sugerida para o nestingLevel.

textStyleSuggestionState

object (TextStyleSuggestionState)

Uma máscara que indica quais campos do text style foram alterados nesta sugestão.

Referências de objetos

Uma coleção de IDs de objeto.

Representação JSON
{
  "objectIds": [
    string
  ]
}
Campos
objectIds[]

string

Os IDs de objeto.

Quebra de seção

Um StructuralElement que representa uma quebra de seção. Uma seção é um intervalo de conteúdo com o mesmo SectionStyle. Uma quebra de seção representa o início de uma nova seção, e o estilo da seção é aplicado à seção após a quebra.

O corpo do documento sempre começa com uma quebra de seção.

Representação JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
Campos
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma SectionBreak pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

sectionStyle

object (SectionStyle)

O estilo da seção após a quebra desta seção.

Estilo de seção

O estilo que se aplica a uma seção.

Representação JSON
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer
}
Campos
columnProperties[]

object (SectionColumnProperties)

Propriedades das colunas da seção.

Se estiver vazia, a seção terá uma coluna com as propriedades padrão no editor do Documentos. Uma seção pode ter no máximo três colunas.

Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resultará em um erro 400 de solicitação inválida.

columnSeparatorStyle

enum (ColumnSeparatorStyle)

O estilo dos separadores de coluna.

Esse estilo pode ser definido mesmo quando há uma coluna na seção.

Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida.

contentDirection

enum (ContentDirection)

A direção do conteúdo desta seção. Se não for definido, o valor padrão será LEFT_TO_RIGHT.

Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida.

marginTop

object (Dimension)

A margem superior da página da seção. Se não for definido, o valor do documento será definido como marginTop por padrão.

Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida.

marginBottom

object (Dimension)

A margem inferior da página da seção. Se não for definido, o valor do documento será definido como marginBottom por padrão.

Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida.

marginRight

object (Dimension)

A margem direita da página da seção. Se não for definido, o valor do documento será definido como marginRight por padrão. Atualizar a margem direita faz com que as colunas desta seção sejam redimensionadas. Como a margem afeta a largura da coluna, ela é aplicada antes das propriedades da coluna.

Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida.

marginLeft

object (Dimension)

A margem esquerda da seção. Se não for definido, o valor do documento será definido como marginLeft por padrão. Atualizar a margem esquerda faz com que as colunas desta seção sejam redimensionadas. Como a margem afeta a largura da coluna, ela é aplicada antes das propriedades da coluna.

Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida.

marginHeader

object (Dimension)

A margem do cabeçalho da seção. Se não for definido, o valor do documento será definido como marginHeader por padrão. Se atualizado, useCustomHeaderFooterMargins será definido como verdadeiro no DocumentStyle. O valor de useCustomHeaderFooterMargins em DocumentStyle indica se uma margem de cabeçalho está sendo respeitada para esta seção.

Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida.

sectionType

enum (SectionType)

Apenas saída. O tipo de seção.

defaultHeaderId

string

O ID do cabeçalho padrão. Se não for definido, o valor vai ser herdado do método SectionStyle SectionBreak's anterior. Se o valor não for definido na primeira SeçãoBreak, ele herdará da defaultHeaderId do DocumentStyle.

Esta propriedade é somente leitura.

firstPageHeaderId

string

O ID do cabeçalho usado apenas para a primeira página da seção. Se useFirstPageHeaderFooter for verdadeiro, esse valor será usado para o cabeçalho na primeira página da seção. Se for falso, o cabeçalho na primeira página da seção usará defaultHeaderId. Se não for definido, o valor vai ser herdado do método SectionStyle SectionBreak's anterior. Se o valor não for definido na primeira SeçãoBreak, ele herdará da firstPageHeaderId do DocumentStyle.

Esta propriedade é somente leitura.

evenPageHeaderId

string

O ID do cabeçalho usado apenas para páginas pares. Se o valor de useEvenPageHeaderFooter do DocumentStyle for verdadeiro, ele será usado para cabeçalhos em páginas pares na seção. Se for falso, os cabeçalhos em páginas pares usarão o defaultHeaderId. Se não for definido, o valor vai ser herdado do método SectionStyle SectionBreak's anterior. Se o valor não for definido na primeira SeçãoBreak, ele herdará da evenPageHeaderId do DocumentStyle.

Esta propriedade é somente leitura.

pageNumberStart

integer

O número da página a partir da qual inicia a contagem do número de páginas desta seção. Se ela não for definida, a numeração da página continuará a partir da seção anterior. Se o valor não for definido no primeiro SectionBreak, consulte o pageNumberStart do DocumentStyle.

Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida.

Propriedades da coluna de seção

Propriedades que se aplicam à coluna de uma seção.

Representação JSON
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
Campos
width

object (Dimension)

Apenas saída. A largura da coluna.

paddingEnd

object (Dimension)

O padding no final da coluna.

ColumnSeparatorStyle

O estilo dos separadores de coluna entre colunas.

Enums
COLUMN_SEPARATOR_STYLE_UNSPECIFIED Um estilo de separador de coluna não especificado.
NONE Não há linhas separadoras para as colunas.
BETWEEN_EACH_COLUMN Renderiza uma linha separadora de coluna entre cada coluna.

SectionType

Representa como o início da seção atual é posicionado em relação à seção anterior.

Enums
SECTION_TYPE_UNSPECIFIED O tipo de seção não foi especificado.
CONTINUOUS A seção começa imediatamente após o último parágrafo da seção anterior.
NEXT_PAGE A seção começa na próxima página.

Tabela

Um StructuralElement que representa uma tabela.

Representação JSON
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
Campos
rows

integer

Número de linhas na tabela.

columns

integer

Número de colunas na tabela.

É possível que a tabela não seja retangular, por isso algumas linhas podem ter um número de células diferente.

tableRows[]

object (TableRow)

O conteúdo e o estilo de cada linha.

suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma Table pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

tableStyle

object (TableStyle)

O estilo da tabela.

TableRow

O conteúdo e o estilo de uma linha em uma Table.

Representação JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
Campos
startIndex

integer

O índice inicial dessa linha, baseado em zero, em unidades de código UTF-16.

endIndex

integer

O índice final dessa linha, com base em zero, exclusivo, em unidades de código UTF-16.

tableCells[]

object (TableCell)

O conteúdo e o estilo de cada célula nessa linha.

É possível que a tabela não seja retangular, portanto, algumas linhas podem ter um número de células diferente de outras linhas da mesma tabela.

suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma TableRow pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

tableRowStyle

object (TableRowStyle)

O estilo da linha da tabela.

suggestedTableRowStyleChanges

map (key: string, value: object (SuggestedTableRowStyle))

O estilo sugerido muda para essa linha, codificado pelo ID da sugestão.

TableCell

O conteúdo e o estilo de uma célula em uma Table.

Representação JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
Campos
startIndex

integer

O índice inicial dessa célula, em zero, nas unidades de código UTF-16.

endIndex

integer

Índice final dessa célula, exclusivo, em unidades de código UTF-16.

content[]

object (StructuralElement)

O conteúdo da célula.

tableCellStyle

object (TableCellStyle)

O estilo da célula.

suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma TableCell pode ter vários códigos de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

suggestedTableCellStyleChanges

map (key: string, value: object (SuggestedTableCellStyle))

As alterações sugeridas para o estilo de célula da tabela, codificadas pelo código da sugestão.

TableCellStyle

O estilo de um TableCell.

Os estilos de células da tabela herdados são representados como campos não definidos nesta mensagem. Um estilo de célula de tabela pode herdar do estilo da tabela.

Representação JSON
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
Campos
rowSpan

integer

O período da linha da célula.

Esta propriedade é somente leitura.

columnSpan

integer

O período da coluna da célula.

Esta propriedade é somente leitura.

backgroundColor

object (OptionalColor)

A cor de plano de fundo da célula.

borderLeft

object (TableCellBorder)

A borda esquerda da célula.

borderRight

object (TableCellBorder)

A borda direita da célula.

borderTop

object (TableCellBorder)

A borda superior da célula.

borderBottom

object (TableCellBorder)

A borda inferior da célula.

paddingLeft

object (Dimension)

O padding esquerdo da célula.

paddingRight

object (Dimension)

O padding direito da célula.

paddingTop

object (Dimension)

O padding superior da célula.

paddingBottom

object (Dimension)

O padding inferior da célula.

contentAlignment

enum (ContentAlignment)

O alinhamento do conteúdo na célula da tabela. O alinhamento padrão corresponde ao das células da tabela recém-criadas no editor do Documentos.

TableCellBorder

Uma borda ao redor de uma célula da tabela.

As bordas das células da tabela não podem ser transparentes. Para ocultar uma borda de célula da tabela, defina a largura como 0.

Representação JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Campos
color

object (OptionalColor)

A cor da borda.

Esta cor não pode ser transparente.

width

object (Dimension)

A largura da borda.

dashStyle

enum (DashStyle)

O estilo de traço da borda.

Alinhamento de conteúdo

Os tipos de alinhamento de conteúdo.

Derivado de um subconjunto dos valores do tipo simples "ST_TextAnchoringType" na seção 20.1.10.59 de "Formatos de arquivo XML abertos do Office: referência da linguagem de marcação e fundamentos", parte 1 da 4a edição ECMA-376.

Enums
CONTENT_ALIGNMENT_UNSPECIFIED Um alinhamento de conteúdo não especificado. O alinhamento do conteúdo é herdado do pai, se houver.
CONTENT_ALIGNMENT_UNSUPPORTED Um alinhamento de conteúdo incompatível.
TOP Um alinhamento que alinha o conteúdo à parte superior do detentor de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType 't'.
MIDDLE Um alinhamento que alinha o conteúdo ao meio do detentor de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType "ctr".
BOTTOM Um alinhamento que alinha o conteúdo à parte inferior do detentor de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType 'b'.

TableTableCellStyle

Uma alteração sugerida para um TableCellStyle.

Representação JSON
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
Campos
tableCellStyle

object (TableCellStyle)

Um TableCellStyle que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com tableCellStyleSuggestionState para ver quais campos foram alterados e os novos valores deles.

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

Uma máscara que indica quais dos campos na base TableCellStyle foram alterados nessa sugestão.

TableCellStyleSuggestionState

Uma máscara que indica quais dos campos na base TableCellStyle foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
Campos
rowSpanSuggested

boolean

Indica se houve uma alteração sugerida para rowSpan.

columnSpanSuggested

boolean

Indica se houve uma alteração sugerida para columnSpan.

backgroundColorSuggested

boolean

Indica se houve uma alteração sugerida para backgroundColor.

borderLeftSuggested

boolean

Indica se houve uma alteração sugerida para borderLeft.

borderRightSuggested

boolean

Indica se houve uma alteração sugerida para borderRight.

borderTopSuggested

boolean

Indica se houve uma alteração sugerida para borderTop.

borderBottomSuggested

boolean

Indica se houve uma alteração sugerida para borderBottom.

paddingLeftSuggested

boolean

Indica se houve uma alteração sugerida para paddingLeft.

paddingRightSuggested

boolean

Indica se houve uma alteração sugerida para paddingRight.

paddingTopSuggested

boolean

Indica se houve uma alteração sugerida para paddingTop.

paddingBottomSuggested

boolean

Indica se houve uma alteração sugerida para paddingBottom.

contentAlignmentSuggested

boolean

Indica se houve uma alteração sugerida para contentAlignment.

TableRowStyle

Estilos que se aplicam a uma linha da tabela.

Representação JSON
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
Campos
minRowHeight

object (Dimension)

A altura mínima da linha. A linha será renderizada no editor do Documentos com uma altura igual ou maior que esse valor para exibir todo o conteúdo nas células da linha.

tableHeader

boolean

Se a linha é um cabeçalho de tabela.

preventOverflow

boolean

Se a linha não pode ultrapassar os limites de página ou coluna.

TableTableRowStyle sugerido.

Uma alteração sugerida para um TableRowStyle.

Representação JSON
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
Campos
tableRowStyle

object (TableRowStyle)

Um TableRowStyle que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com tableRowStyleSuggestionState para ver quais campos foram alterados e os novos valores deles.

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

Uma máscara que indica quais dos campos na base TableRowStyle foram alterados nessa sugestão.

TableRowStyleSuggestionState

Uma máscara que indica quais dos campos na base TableRowStyle foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "minRowHeightSuggested": boolean
}
Campos
minRowHeightSuggested

boolean

Indica se houve uma alteração sugerida para minRowHeight.

Estilo de tabela

Estilos que se aplicam a uma tabela.

Representação JSON
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
Campos
tableColumnProperties[]

object (TableColumnProperties)

As propriedades de cada coluna.

No Documentos, as tabelas contêm linhas e as linhas contêm células, semelhante ao HTML. Assim, as propriedades de uma linha podem ser encontradas no tableRowStyle da linha.

TableColumnProperties

As propriedades de uma coluna em uma tabela.

Representação JSON
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
Campos
widthType

enum (WidthType)

O tipo de largura da coluna.

width

object (Dimension)

A largura da coluna. Definido quando o widthType da coluna é FIXED_WIDTH.

Tipo de largura

O tipo de largura da coluna.

Enums
WIDTH_TYPE_UNSPECIFIED O tipo de largura da coluna não foi especificado.
EVENLY_DISTRIBUTED

A largura da coluna é distribuída uniformemente entre as outras colunas.

A largura da coluna é determinada automaticamente e terá uma parte igual à largura restante para a tabela depois de contabilizar todas as colunas com larguras especificadas.

FIXED_WIDTH Largura fixa da coluna. A propriedade [width][google.apps.docs.v1.TableColumnProperties.width contém a largura da coluna.

Sumário

Um StructuralElement que representa um índice.

Representação JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Campos
content[]

object (StructuralElement)

O conteúdo do sumário.

suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma TableOfContents pode ter vários IDs de inserção se for uma alteração sugerida aninhada. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

Nota de rodapé

Uma nota de rodapé de documento.

Representação JSON
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Campos
footnoteId

string

O ID da nota de rodapé.

content[]

object (StructuralElement)

O conteúdo da nota de rodapé.

Os índices do conteúdo de uma nota de rodapé começam em zero.

DocumentStyle

O estilo do documento.

Representação JSON
{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean
}
Campos
background

object (Background)

O plano de fundo do documento. Os documentos não podem ter uma cor de fundo transparente.

defaultHeaderId

string

O ID do cabeçalho padrão. Se não for definido, não haverá cabeçalho padrão.

Esta propriedade é somente leitura.

evenPageHeaderId

string

O ID do cabeçalho usado apenas para páginas pares. O valor de useEvenPageHeaderFooter determina se o defaultHeaderId ou se esse valor será usado para o cabeçalho em páginas pares. Se não estiver definido, não haverá cabeçalho de página par.

Esta propriedade é somente leitura.

firstPageHeaderId

string

O ID do cabeçalho usado somente para a primeira página. Se não for definido, um cabeçalho exclusivo para a primeira página não existirá. O valor de useFirstPageHeaderFooter determina se é necessário usar defaultHeaderId ou esse valor para o cabeçalho na primeira página. Se não for definido, não haverá cabeçalho de primeira página.

Esta propriedade é somente leitura.

pageNumberStart

integer

O número da página a partir da qual inicia a contagem do número de páginas.

marginTop

object (Dimension)

A margem superior da página.

Atualizar a margem da página superior no estilo de documento limpa a margem de todas as seções.

marginBottom

object (Dimension)

A margem inferior da página.

Atualizar a margem da página inferior no estilo de documento limpa a margem de página inferior em todos os estilos de seção.

marginRight

object (Dimension)

A margem direita da página.

A atualização da margem direita da página no estilo de documento limpa a margem da página correta em todos os estilos de seção. Isso também pode fazer com que as colunas sejam redimensionadas em todas as seções.

marginLeft

object (Dimension)

A margem esquerda da página.

A atualização da margem esquerda da página no estilo de documento limpa a margem esquerda de todos os estilos de seção. Isso também pode fazer com que as colunas sejam redimensionadas em todas as seções.

pageSize

object (Size)

O tamanho de uma página no documento.

marginHeader

object (Dimension)

A quantidade de espaço entre a parte superior da página e o conteúdo do cabeçalho.

Contexto

Representa o plano de fundo de um documento.

Representação JSON
{
  "color": {
    object (OptionalColor)
  }
}
Campos
color

object (OptionalColor)

A cor do plano de fundo.

Tamanho

Largura e altura.

Representação JSON
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
Campos
height

object (Dimension)

A altura do objeto.

width

object (Dimension)

A largura do objeto.

Estilo de documento sugerido

Uma alteração sugerida para o DocumentStyle.

Representação JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
Campos
documentStyle

object (DocumentStyle)

Um DocumentStyle que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com documentStyleSuggestionState para ver quais campos foram alterados e os novos valores deles.

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

Uma máscara que indica quais dos campos na base DocumentStyle foram alterados nessa sugestão.

DocumentStyleSuggestionState

Uma máscara que indica quais dos campos na base DocumentStyle foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean
}
Campos
backgroundSuggestionState

object (BackgroundSuggestionState)

Uma máscara que indica quais campos do background foram alterados nesta sugestão.

defaultHeaderIdSuggested

boolean

Indica se houve uma alteração sugerida para defaultHeaderId.

evenPageHeaderIdSuggested

boolean

Indica se houve uma alteração sugerida para evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

Indica se houve uma alteração sugerida para firstPageHeaderId.

pageNumberStartSuggested

boolean

Indica se houve uma alteração sugerida para pageNumberStart.

marginTopSuggested

boolean

Indica se houve uma alteração sugerida para marginTop.

marginBottomSuggested

boolean

Indica se houve uma alteração sugerida para marginBottom.

marginRightSuggested

boolean

Indica se houve uma alteração sugerida para marginRight.

marginLeftSuggested

boolean

Indica se houve uma alteração sugerida para marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

Uma máscara que indica quais dos campos em [size] [google.apps.docs.v1.DocumentStyle.size] foram alterados nesta sugestão.

marginHeaderSuggested

boolean

Indica se houve uma alteração sugerida para marginHeader.

BackgroundSuggestionState

Uma máscara que indica quais dos campos na base Background foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, o Backgound tem um novo valor sugerido.

Representação JSON
{
  "backgroundColorSuggested": boolean
}
Campos
backgroundColorSuggested

boolean

Indica se a cor atual do plano de fundo foi modificada nessa sugestão.

EstadodeSugestãodeTamanho

Uma máscara que indica quais dos campos na base Size foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, o Size tem um novo valor sugerido.

Representação JSON
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
Campos
heightSuggested

boolean

Indica se houve uma alteração sugerida para height.

widthSuggested

boolean

Indica se houve uma alteração sugerida para width.

Estilos nomeados

Os estilos nomeados. Os parágrafos do documento podem herdar TextStyle e ParagraphStyle desses estilos nomeados.

Representação JSON
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
Campos
styles[]

object (NamedStyle)

Os estilos nomeados.

Há uma entrada para cada named style types possível.

EstiloNome

Um estilo nomeado. Os parágrafos no documento podem herdar TextStyle e ParagraphStyle desse estilo nomeado quando têm o mesmo tipo de estilo nomeado.

Representação JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
Campos
namedStyleType

enum (NamedStyleType)

O tipo desse estilo nomeado.

textStyle

object (TextStyle)

O estilo de texto desse estilo nomeado.

paragraphStyle

object (ParagraphStyle)

O estilo de parágrafo desse estilo nomeado.

SugeridosNomesEstilos

Uma alteração sugerida para o NamedStyles.

Representação JSON
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
Campos
namedStyles

object (NamedStyles)

Um NamedStyles que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com namedStylesSuggestionState para ver quais campos foram alterados e os novos valores deles.

namedStylesSuggestionState

object (NamedStylesSuggestionState)

Uma máscara que indica quais dos campos na base NamedStyles foram alterados nessa sugestão.

NamedStylesSuggestionState

O estado de sugestão de uma mensagem NamedStyles.

Representação JSON
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
Campos
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

Uma máscara que indica quais campos do NamedStyle correspondente em styles foram alterados nessa sugestão.

A ordem desses estados de sugestão de estilo nomeados corresponde à ordem do estilo nomeado correspondente na sugestão named styles.

NamedStyleSuggestionState

Um estado de sugestão de uma mensagem NamedStyle.

Representação JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Campos
namedStyleType

enum (NamedStyleType)

O tipo de estilo nomeado ao qual este estado de sugestão corresponde.

Esse campo é fornecido como uma conveniência para corresponder o NamedStyleSuggestionState com o NamedStyle correspondente.

textStyleSuggestionState

object (TextStyleSuggestionState)

Uma máscara que indica quais campos do text style foram alterados nesta sugestão.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Uma máscara que indica quais campos do paragraph style foram alterados nesta sugestão.

Listar

Uma lista representa os atributos da lista para um grupo de parágrafos que pertencem à mesma lista. Um parágrafo que faz parte de uma lista tem uma referência ao ID da lista em bullet.

Representação JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Campos
listProperties

object (ListProperties)

As propriedades da lista.

suggestedListPropertiesChanges

map (key: string, value: object (SuggestedListProperties))

As alterações sugeridas para as propriedades da lista, codificadas pelo ID da sugestão.

suggestedInsertionId

string

O código de inserção sugerido. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão dessa lista.

Propriedades de lista

As propriedades de um list que descrevem a aparência de marcadores pertencentes a parágrafos associados a uma lista.

Representação JSON
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
Campos
nestingLevels[]

object (NestingLevel)

Descreve as propriedades dos marcadores no nível associado.

Uma lista tem no máximo 9 níveis de aninhamento com nível 0 correspondente ao nível superior e nível 8 correspondente ao nível mais aninhado. Os níveis de aninhamento são retornados em ordem crescente, com o menor valor aninhado retornado primeiro.

Nível de transição

Contém propriedades que descrevem a aparência de um marcador de lista em um determinado nível de aninhamento.

Representação JSON
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
Campos
bulletAlignment

enum (BulletAlignment)

O alinhamento do marcador dentro do espaço alocado para renderizar o marcador.

glyphFormat

string

A string de formato usada pelos marcadores neste nível de aninhamento.

O formato do glifo contém um ou mais marcadores, que são substituídos pelos valores adequados, dependendo de glyphType ou glyphSymbol. Os marcadores de posição seguem o padrão %[nestingLevel]. Além disso, os marcadores podem ter prefixos e sufixos. Assim, o formato do glifo segue o padrão <prefix>%[nestingLevel]<suffix>. O prefixo e o sufixo são opcionais e podem ser strings arbitrárias.

Por exemplo, o formato de glifo %0. indica que o glifo renderizado substituirá o marcador pelo glifo correspondente do nível de aninhamento 0 seguido de um ponto como sufixo. Então, uma lista com o tipo de glifo de UPPER_ALPHA e o formato de glifo %0. no nível de aninhamento 0 resultará em uma lista com glifos renderizados

A.

B.

C.

O formato de glifo pode conter marcadores de posição para o nível de aninhamento atual, bem como marcadores para os níveis de aninhamento principais. Por exemplo, uma lista pode ter um formato de glifo de %0. no nível de aninhamento 0 e um formato de glifo de %0.%1. no aninhamento de nível 1. Supondo que os dois níveis de aninhamento tenham DECIMAL tipo de glifo, isso resultaria em uma lista com glifos renderizados

1.

2.

2.1.

2.2.

3.

Para níveis de aninhamento ordenados, a string que substitui um marcador no formato de glifo de um parágrafo específico depende da ordem do parágrafo na lista.

indentFirstLine

object (Dimension)

A quantidade de recuo para a primeira linha dos parágrafos neste nível de aninhamento.

indentStart

object (Dimension)

A quantidade de recuo para parágrafos neste nível de aninhamento. Aplicado ao lado que corresponde ao início do texto, com base na direção de conteúdo do parágrafo.

textStyle

object (TextStyle)

O estilo de texto dos marcadores neste nível de aninhamento.

startNumber

integer

O número do primeiro item da lista nesse nível de aninhamento.

Um valor de 0 é tratado como um valor de 1 para as listas numeradas e numeradas com letra. Para valores de 0 e 1, as listas de algarismos com letras e romanas começarão em a e i, respectivamente.

Esse valor é ignorado para níveis de aninhamento com glifos não ordenados.

Campo de união glyph_kind. O tipo de glifo usado pelos marcadores. Isso define o símbolo do marcador que substitui os marcadores no glyph_format. glyph_kind pode ser apenas de um dos tipos a seguir:
glyphType

enum (GlyphType)

Tipo de glifo usado pelos marcadores quando os parágrafos desse nível de aninhamento são ordenados.

O tipo de glifo determina o tipo de glifo usado para substituir marcadores de posição no glyphFormat quando os parágrafos nesse nível de aninhamento são ordenados. Por exemplo, se o nível de aninhamento for 0, o glyphFormat for %0. e o tipo de glifo for DECIMAL, o glifo renderizado substituirá o marcador %0 no formato de glifo por um número correspondente à ordem do item da lista.

glyphSymbol

string

Um símbolo de glifo personalizado usado por marcadores quando os parágrafos desse nível de aninhamento não são ordenados.

O símbolo de glifo substitui os marcadores no glyphFormat. Por exemplo, se o glifo é o círculo sólido correspondente ao ponto de código Unicode U+25cf e o glyphFormat é %0, o glifo renderizado seria o círculo sólido.

BulletAlignment (em inglês)

Os tipos de alinhamento de um marcador.

Enums
BULLET_ALIGNMENT_UNSPECIFIED O alinhamento do marcador não foi especificado.
START O marcador é alinhado ao início do espaço alocado para renderizá-lo. Alinhado à esquerda para texto LTR, alinhado à direita caso contrário.
CENTER O marcador é alinhado ao centro do espaço alocado para renderizá-lo.
END O marcador é alinhado ao final do espaço alocado para renderizar o marcador. Alinhado à direita para texto LTR, alinhado à esquerda caso contrário.

Tipo de glifo

Os tipos de glifos usados por marcadores quando os parágrafos desse nível de aninhamento são ordenados.

Enums
GLYPH_TYPE_UNSPECIFIED O tipo de glifo não foi especificado ou não é compatível.
NONE Uma string vazia.
DECIMAL Um número, como 1, 2 ou 3.
ZERO_DECIMAL Um número em que números de um único dígito têm um zero, como 01, 02 ou 03. Números com mais de um dígito não são prefixados com um zero.
UPPER_ALPHA Uma letra maiúscula, como A, B ou C.
ALPHA Uma letra minúscula, como a, b ou c.
UPPER_ROMAN Um algarismo romano maiúsculo, como I, II ou III.
ROMAN Um algarismo romano minúsculo, como i, ii ou iii.

SuggestedListProperties

Uma alteração sugerida para ListProperties.

Representação JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
Campos
listProperties

object (ListProperties)

Um ListProperties que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com listPropertiesSuggestionState para ver quais campos foram alterados e os novos valores deles.

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

Uma máscara que indica quais dos campos na base ListProperties foram alterados nessa sugestão.

ListPropertiesSuggestionState

Uma máscara que indica quais dos campos na base ListProperties foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
Campos
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

Uma máscara que indica quais campos do NestingLevel correspondente em nestingLevels foram alterados nessa sugestão.

Os estados de sugestão de nível de aninhamento são retornados em ordem crescente do nível de aninhamento, com o menos aninhado retornado primeiro.

NestingLevelSuggestionState

Uma máscara que indica quais dos campos na base NestingLevel foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
Campos
bulletAlignmentSuggested

boolean

Indica se houve uma alteração sugerida para bulletAlignment.

glyphTypeSuggested

boolean

Indica se houve uma alteração sugerida para glyphType.

glyphFormatSuggested

boolean

Indica se houve uma alteração sugerida para glyphFormat.

glyphSymbolSuggested

boolean

Indica se houve uma alteração sugerida para glyphSymbol.

indentFirstLineSuggested

boolean

Indica se houve uma alteração sugerida para indentFirstLine.

indentStartSuggested

boolean

Indica se houve uma alteração sugerida para indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

Uma máscara que indica quais campos do text style foram alterados nesta sugestão.

startNumberSuggested

boolean

Indica se houve uma alteração sugerida para startNumber.

Intervalos nomeados

Uma coleção de todas as NamedRanges no documento que compartilham um determinado nome.

Representação JSON
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
Campos
name

string

O nome que todos os named ranges compartilham.

namedRanges[]

object (NamedRange)

Os NamedRanges que compartilham o mesmo nome.

Intervalo nomeado

Uma coleção de Ranges com o mesmo ID de intervalo nomeado.

Os intervalos nomeados permitem que os desenvolvedores associem partes de um documento a um marcador arbitrário definido pelo usuário para que seu conteúdo possa ser lido ou editado programaticamente mais tarde. Um documento pode conter vários intervalos nomeados com o mesmo nome, mas cada intervalo nomeado tem um código exclusivo.

Um intervalo nomeado é criado com um único Range, e o conteúdo inserido nele geralmente expande esse intervalo. No entanto, determinadas alterações de documentos podem fazer com que o intervalo seja dividido em vários intervalos.

Os intervalos nomeados não são particulares. Todos os aplicativos e colaboradores que têm acesso ao documento podem ver seus intervalos nomeados.

Representação JSON
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
Campos
namedRangeId

string

O ID do intervalo nomeado.

name

string

O nome do intervalo nomeado.

ranges[]

object (Range)

Os intervalos que pertencem a esse intervalo nomeado.

Intervalo

Especifica um intervalo contíguo de texto.

Representação JSON
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer
}
Campos
segmentId

string

O ID do cabeçalho, rodapé ou nota de rodapé no qual esse intervalo está contido. Um código de segmento vazio representa o corpo do documento.

startIndex

integer

Índice inicial deste intervalo com base em zero, em unidades de código UTF-16.

Em todos os usos atuais, é necessário fornecer um índice inicial. Esse campo é um Int32Value para acomodar futuros casos de uso com intervalos abertos.

endIndex

integer

O índice final desse intervalo, exclusivo, em unidades de código UTF-16.

Em todos os usos atuais, é necessário fornecer um índice final. Esse campo é um Int32Value para acomodar futuros casos de uso com intervalos abertos.

Modo de sugestão

O modo de visualização de sugestões aplicado ao documento que indica como as alterações sugeridas são representadas. Ele oferece opções para ler o documento com todas as sugestões inline, aceitas ou rejeitadas.

Enums
DEFAULT_FOR_CURRENT_ACCESS O SuggestionsViewMode aplicado ao documento retornado depende do nível de acesso atual do usuário. Se o usuário só tiver acesso para ver, PREVIEW_WITHOUT_SUGGESTIONS será aplicado. Caso contrário, SUGGESTIONS_INLINE será aplicado. Este é o modo de visualização de sugestões padrão.
SUGGESTIONS_INLINE

O documento retornado tem sugestões inline. As alterações sugeridas serão diferenciadas do conteúdo base no documento.

As solicitações para recuperar um documento usando este modo retornarão um erro 403 se o usuário não tiver permissão para visualizar as alterações sugeridas.

PREVIEW_SUGGESTIONS_ACCEPTED

O documento retornado é uma visualização com todas as alterações sugeridas aceitas.

As solicitações para recuperar um documento usando este modo retornarão um erro 403 se o usuário não tiver permissão para visualizar as alterações sugeridas.

PREVIEW_WITHOUT_SUGGESTIONS O documento retornado é uma visualização com todas as alterações sugeridas rejeitadas se houver sugestões no documento.

Objeto in-line

Um objeto que aparece em linha com o texto. Um InlineObject contém um EmbeddedObject, como uma imagem.

Representação JSON
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Campos
objectId

string

O ID deste objeto in-line. Pode ser usado para atualizar as propriedades de um objeto.

inlineObjectProperties

object (InlineObjectProperties)

As propriedades deste objeto in-line.

suggestedInlineObjectPropertiesChanges

map (key: string, value: object (SuggestedInlineObjectProperties))

Alterações sugeridas para as propriedades do objeto in-line, codificadas pelo código da sugestão.

suggestedInsertionId

string

O código de inserção sugerido. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

PropriedadesInLineObject

Propriedades de uma InlineObject.

Representação JSON
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Campos
embeddedObject

object (EmbeddedObject)

O objeto incorporado deste objeto in-line.

Objeto incorporado

Um objeto incorporado no documento.

Representação JSON
{
  "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.
}
Campos
title

string

O título do objeto incorporado. A title e a description são combinadas para exibir o texto alternativo.

description

string

A descrição do objeto incorporado. A title e a description são combinadas para exibir o texto alternativo.

embeddedObjectBorder

object (EmbeddedObjectBorder)

A borda do objeto incorporado.

size

object (Size)

O tamanho visível da imagem após o corte.

marginTop

object (Dimension)

A margem superior do objeto incorporado.

marginBottom

object (Dimension)

A margem inferior do objeto incorporado.

marginRight

object (Dimension)

A margem direita do objeto incorporado.

marginLeft

object (Dimension)

A margem esquerda do objeto incorporado.

linkedContentReference

object (LinkedContentReference)

Uma referência ao conteúdo da fonte vinculada externa. Por exemplo, ele contém uma referência ao gráfico do Planilhas Google de origem quando o objeto incorporado for um gráfico vinculado.

Se não for definido, o objeto incorporado não será vinculado.

Campo de união properties. As propriedades específicas de cada tipo de objeto incorporado. properties pode ser apenas de um dos tipos a seguir:
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

As propriedades de um desenho incorporado.

imageProperties

object (ImageProperties)

As propriedades de uma imagem.

EmbeddedDrawingProperties

As propriedades de um desenho incorporado e usadas para diferenciar o tipo de objeto. Um desenho incorporado é aquele criado e editado em um documento. Não há suporte para detalhes abrangentes.

ImageProperties

As propriedades de uma imagem.

Representação JSON
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
Campos
contentUri

string

Um URI para a imagem com duração padrão de 30 minutos. Esse URI é marcado com a conta do solicitante. Qualquer pessoa com o URI acessa a imagem como o solicitante original. O acesso à imagem pode ser perdido se as configurações de compartilhamento do documento forem alteradas.

sourceUri

string

O URI de origem é o URI usado para inserir a imagem. O URI de origem pode estar vazio.

brightness

number

O efeito de brilho da imagem. O valor deve estar no intervalo [-1,0, 1,0], em que 0 significa que não há efeito.

contrast

number

O efeito de contraste da imagem. O valor deve estar no intervalo [-1,0, 1,0], em que 0 significa que não há efeito.

transparency

number

O efeito de transparência da imagem. O valor deve estar no intervalo [0.0, 1.0], em que 0 significa não ter efeito e 1 significa transparente.

cropProperties

object (CropProperties)

As propriedades de corte da imagem.

angle

number

O ângulo de rotação no sentido horário da imagem, em radianos.

CropProperties

As propriedades de corte de uma imagem.

O retângulo de corte é representado por deslocamentos fracionários das quatro bordas do conteúdo original.

  • Se o deslocamento estiver no intervalo (0, 1), a borda correspondente do retângulo de corte será posicionada dentro do retângulo delimitador original da imagem.
  • Se o deslocamento for negativo ou maior que 1, a borda correspondente do retângulo de corte será posicionada fora do retângulo delimitador original da imagem.
  • Se todos os deslocamentos e ângulos de rotação forem zero, a imagem não será cortada.
Representação JSON
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
Campos
offsetLeft

number

O deslocamento especifica a distância entre a borda esquerda do retângulo de corte e a borda esquerda do conteúdo original, como uma fração da largura do conteúdo original.

offsetRight

number

O deslocamento especifica a distância entre a borda direita do retângulo de corte e a borda direita do conteúdo original, como uma fração da largura do conteúdo original.

offsetTop

number

O deslocamento especifica a distância entre a borda superior do retângulo de corte e a borda superior do conteúdo original, como uma fração da altura do conteúdo original.

offsetBottom

number

O deslocamento especifica a distância entre a borda inferior do retângulo de corte e a borda inferior do conteúdo original, como uma fração da altura do conteúdo original.

angle

number

O ângulo de rotação no sentido horário do retângulo de corte ao redor do centro, em radianos. A rotação é aplicada depois dos deslocamentos.

Borda do objeto incorporado

Uma borda ao redor de um EmbeddedObject.

Representação JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
Campos
color

object (OptionalColor)

A cor da borda.

width

object (Dimension)

A largura da borda.

dashStyle

enum (DashStyle)

O estilo de traço da borda.

propertyState

enum (PropertyState)

O estado da propriedade de borda.

Estado da propriedade

Os estados possíveis de uma propriedade.

Enums
RENDERED Se o estado de uma propriedade for RENDERED, o elemento vai ter a propriedade correspondente quando renderizado no documento. Esse é o valor padrão.
NOT_RENDERED Se o estado de uma propriedade for NOT_RENDERED, o elemento não terá a propriedade correspondente quando renderizado no documento.

LinkedContentReference

Uma referência ao conteúdo da fonte vinculada externa.

Representação JSON
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
Campos
Campo de união reference. A referência específica ao tipo de conteúdo vinculado. reference pode ser apenas de um dos tipos a seguir:
sheetsChartReference

object (SheetsChartReference)

Uma referência ao gráfico vinculado.

Referência do Planilhas

Uma referência a um gráfico vinculado incorporado ao Planilhas Google.

Representação JSON
{
  "spreadsheetId": string,
  "chartId": integer
}
Campos
spreadsheetId

string

O código da planilha do Planilhas Google que contém o gráfico de origem.

chartId

integer

O código do gráfico específico incorporado à planilha do Planilhas Google.

SuggestedInlineObjectProperties

Uma alteração sugerida para InlineObjectProperties.

Representação JSON
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
Campos
inlineObjectProperties

object (InlineObjectProperties)

Um InlineObjectProperties que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com inlineObjectPropertiesSuggestionState para ver quais campos foram alterados e os novos valores deles.

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

Uma máscara que indica quais dos campos na base InlineObjectProperties foram alterados nessa sugestão.

InlineObjectPropertiesSuggestionState

Uma máscara que indica quais dos campos na base InlineObjectProperties foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Campos
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Uma máscara que indica quais campos do embeddedObject foram alterados nesta sugestão.

EmbeddedObjectSuggestionState

Uma máscara que indica quais dos campos na base EmbeddedObject foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
Campos
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

Uma máscara que indica quais campos do embeddedDrawingProperties foram alterados nesta sugestão.

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

Uma máscara que indica quais campos do imageProperties foram alterados nesta sugestão.

titleSuggested

boolean

Indica se houve uma alteração sugerida para title.

descriptionSuggested

boolean

Indica se houve uma alteração sugerida para description.

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

Uma máscara que indica quais campos do embeddedObjectBorder foram alterados nesta sugestão.

sizeSuggestionState

object (SizeSuggestionState)

Uma máscara que indica quais campos do size foram alterados nesta sugestão.

marginLeftSuggested

boolean

Indica se houve uma alteração sugerida para marginLeft.

marginRightSuggested

boolean

Indica se houve uma alteração sugerida para marginRight.

marginTopSuggested

boolean

Indica se houve uma alteração sugerida para marginTop.

marginBottomSuggested

boolean

Indica se houve uma alteração sugerida para marginBottom.

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

Uma máscara que indica quais campos do linkedContentReference foram alterados nesta sugestão.

EmbeddedDrawingPropertiesSuggestionState

Uma máscara que indica quais dos campos na base EmbeddedDrawingProperties foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

ImagePropertiesSuggestionState

Uma máscara que indica quais dos campos na base ImageProperties foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
Campos
contentUriSuggested

boolean

Indica se houve uma alteração sugerida para contentUri.

sourceUriSuggested

boolean

Indica se houve uma alteração sugerida para [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].

brightnessSuggested

boolean

Indica se houve uma alteração sugerida para [brilho] [google.apps.docs.v1.EmbeddedObject.brightness].

contrastSuggested

boolean

Indica se houve uma alteração sugerida para [contrast] [google.apps.docs.v1.EmbeddedObject.contrast].

transparencySuggested

boolean

Indica se houve uma alteração sugerida para [transparency] [google.apps.docs.v1.EmbeddedObject.transparency].

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

Uma máscara que indica quais campos do cropProperties foram alterados nesta sugestão.

angleSuggested

boolean

Indica se houve uma alteração sugerida para [angle] [google.apps.docs.v1.EmbeddedObject.angle].

CropPropertiesSuggestionState

Uma máscara que indica quais dos campos na base CropProperties foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
Campos
offsetLeftSuggested

boolean

Indica se houve uma alteração sugerida para offsetLeft.

offsetRightSuggested

boolean

Indica se houve uma alteração sugerida para offsetRight.

offsetTopSuggested

boolean

Indica se houve uma alteração sugerida para offsetTop.

offsetBottomSuggested

boolean

Indica se houve uma alteração sugerida para offsetBottom.

angleSuggested

boolean

Indica se houve uma alteração sugerida para angle.

EmbeddedObjectBorderSuggestionState

Uma máscara que indica quais dos campos na base EmbeddedObjectBorder foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
Campos
colorSuggested

boolean

Indica se houve uma alteração sugerida para [color] [google.apps.docs.v1.EmbeddedBorderObject.color].

widthSuggested

boolean

Indica se houve uma alteração sugerida para [width] [google.apps.docs.v1.EmbeddedBorderObject.width].

dashStyleSuggested

boolean

Indica se houve uma alteração sugerida para [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].

propertyStateSuggested

boolean

Indica se houve uma alteração sugerida para [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

Uma máscara que indica quais dos campos na base LinkedContentReference foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
Campos
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

Uma máscara que indica quais campos do sheetsChartReference foram alterados nesta sugestão.

PlanilhasChartReferenceSuggestionState

Uma máscara que indica quais dos campos na base SheetsChartReference foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
Campos
spreadsheetIdSuggested

boolean

Indica se houve uma alteração sugerida para spreadsheetId.

chartIdSuggested

boolean

Indica se houve uma alteração sugerida para chartId.

Objeto de posição

Um objeto vinculado a uma Paragraph e posicionado em relação ao início do parágrafo. Um PositionedObject contém um EmbeddedObject, como uma imagem.

Representação JSON
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Campos
objectId

string

O ID deste objeto posicionado.

positionedObjectProperties

object (PositionedObjectProperties)

As propriedades deste objeto posicionado.

suggestedPositionedObjectPropertiesChanges

map (key: string, value: object (SuggestedPositionedObjectProperties))

As alterações sugeridas para as propriedades do objeto posicionado, codificadas pelo ID da sugestão.

suggestedInsertionId

string

O código de inserção sugerido. Se estiver vazio, isso não é uma inserção sugerida.

suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo.

PositionedObjectProperties

Propriedades de uma PositionedObject.

Representação JSON
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Campos
positioning

object (PositionedObjectPositioning)

O posicionamento deste objeto posicionado em relação à nova linha de Paragraph que faz referência a ele.

embeddedObject

object (EmbeddedObject)

O objeto incorporado deste objeto posicionado.

PositionedObjectPositioning

O posicionamento de um PositionedObject. O objeto posicionado é posicionado em relação ao início do Paragraph ao qual está vinculado.

Representação JSON
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
Campos
layout

enum (PositionedObjectLayout)

O layout deste objeto posicionado.

leftOffset

object (Dimension)

O deslocamento da borda esquerda do objeto posicionado em relação ao início do Paragraph ao qual ele está vinculado. O posicionamento exato do objeto pode depender de outros conteúdos no documento e do estilo do documento.

topOffset

object (Dimension)

O deslocamento da borda superior do objeto posicionado em relação ao início do Paragraph ao qual ele está vinculado. O posicionamento exato do objeto pode depender de outros conteúdos no documento e do estilo do documento.

PositionedObjectLayout (em inglês)

Os layouts possíveis de um [PositionedObject][google.aps.docs.v1.PositionedObject].

Enums
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED O layout não foi especificado.
WRAP_TEXT O texto envolve o objeto posicionado.
BREAK_LEFT Quebra o texto de forma que o objeto posicionado fique à esquerda e o texto à direita.
BREAK_RIGHT Quebra o texto de forma que o objeto posicionado esteja à direita e o texto à esquerda.
BREAK_LEFT_RIGHT Quebra o texto de forma que não haja texto à esquerda ou à direita do objeto posicionado.
IN_FRONT_OF_TEXT O objeto posicionado está na frente do texto.
BEHIND_TEXT O objeto posicionado está atrás do texto.

SuggestedPositionedObjectProperties

Uma alteração sugerida para PositionedObjectProperties.

Representação JSON
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
Campos
positionedObjectProperties

object (PositionedObjectProperties)

Um PositionedObjectProperties que inclui apenas as mudanças feitas nessa sugestão. Isso pode ser usado com positionedObjectPropertiesSuggestionState para ver quais campos foram alterados e os novos valores deles.

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

Uma máscara que indica quais dos campos na base PositionedObjectProperties foram alterados nessa sugestão.

PositionedObjectPropertiesSuggestionState

Uma máscara que indica quais dos campos na base PositionedObjectProperties foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Campos
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

Uma máscara que indica quais campos do positioning foram alterados nesta sugestão.

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Uma máscara que indica quais campos do embeddedObject foram alterados nesta sugestão.

PositionedObjectPositioningSuggestionState

Uma máscara que indica quais dos campos na base PositionedObjectPositioning foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

Representação JSON
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
Campos
layoutSuggested

boolean

Indica se houve uma alteração sugerida para layout.

leftOffsetSuggested

boolean

Indica se houve uma alteração sugerida para leftOffset.

topOffsetSuggested

boolean

Indica se houve uma alteração sugerida para topOffset.

Métodos

batchUpdate

Aplica uma ou mais atualizações ao documento.

create

Cria um documento em branco usando o título fornecido na solicitação.

get

Obtém a versão mais recente do documento especificado.