- Recurso: Document
- Guia
- TabProperties
- DocumentTab
- Body
- StructuralElement
- Parágrafo
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- Cor
- RgbColor
- Dimensão
- Unidade
- WeightedFontFamily
- BaselineOffset
- Link
- BookmarkLink
- HeadingLink
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- Tipo
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- Equação
- InlineObjectElement
- Pessoa
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- Alinhamento
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- Sombreamento
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Marcador
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- Table
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- Cabeçalho
- Rodapé
- Nota de rodapé
- DocumentStyle
- Contexto
- Tamanho
- DocumentFormat
- DocumentMode
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Lista
- ListProperties
- NestingLevel
- BulletAlignment
- GlyphType
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- Intervalo
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- Métodos
Recurso: Document
Um documento Google.
Representação JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
Campos | |
---|---|
documentId |
Apenas saída. O ID do documento. |
title |
O título do documento. |
tabs[] |
Guias que fazem parte de um documento. As guias podem conter guias filhas, ou seja, uma guia aninhada em outra. As guias secundárias são representadas pelo campo |
revisionId |
Apenas saída. O ID da revisão do documento. Pode ser usado em solicitações de atualização para especificar a revisão de um documento a que as atualizações devem ser aplicadas e como a solicitação deve se comportar se o documento tiver sido editado desde essa revisão. Preenchido apenas se o usuário tiver acesso de edição ao documento. O ID da revisão não é um número sequencial, mas uma string opaca. O formato do ID da revisão pode mudar com o tempo. Um ID de revisão retornado só é válido por 24 horas após o retorno e não pode ser compartilhado entre usuários. Se o ID da revisão não mudar entre as chamadas, o documento não foi alterado. Por outro lado, um ID alterado (para o mesmo documento e usuário) geralmente significa que o documento foi atualizado. No entanto, um ID alterado também pode ser devido a fatores internos, como mudanças no formato do ID. |
suggestionsViewMode |
Apenas saída. O modo de visualização de sugestões aplicado ao documento. Observação: ao editar um documento, as mudanças precisam ser baseadas em um documento com |
body |
Apenas saída. O corpo principal do documento. Campo legado: em vez disso, use |
headers |
Apenas saída. Os cabeçalhos no documento, com chave pelo ID do cabeçalho. Campo legado: em vez disso, use |
footers |
Apenas saída. Os rodapés no documento, identificados pelo ID do rodapé. Campo legado: em vez disso, use |
footnotes |
Apenas saída. As notas de rodapé no documento, identificadas pelo ID da nota de rodapé. Campo legado: em vez disso, use |
documentStyle |
Apenas saída. O estilo do documento. Campo legado: em vez disso, use |
suggestedDocumentStyleChanges |
Apenas saída. As mudanças sugeridas no estilo do documento, identificadas pelo ID da sugestão. Campo legado: em vez disso, use |
namedStyles |
Apenas saída. Os estilos nomeados do documento. Campo legado: em vez disso, use |
suggestedNamedStylesChanges |
Apenas saída. As mudanças sugeridas nos estilos nomeados do documento, identificadas pelo ID da sugestão. Campo legado: em vez disso, use |
lists |
Apenas saída. As listas no documento, indexadas pelo ID da lista. Campo legado: em vez disso, use |
namedRanges |
Apenas saída. Os intervalos nomeados no documento, com chave pelo nome. Campo legado: em vez disso, use |
inlineObjects |
Apenas saída. Os objetos inline no documento, com chave pelo ID do objeto. Campo legado: em vez disso, use |
positionedObjects |
Apenas saída. Os objetos posicionados no documento, identificados pelo ID do objeto. Campo legado: em vez disso, use |
Tab
Uma guia em um documento.
Representação JSON |
---|
{ "tabProperties": { object ( |
Campos | |
---|---|
tabProperties |
As propriedades da guia, como ID e título. |
childTabs[] |
As guias filhas aninhadas nessa guia. |
Campo de união content . O conteúdo da guia. content pode ser apenas de um dos tipos a seguir: |
|
documentTab |
Uma guia com o conteúdo do documento, como texto e imagens. |
TabProperties
Propriedades de uma guia.
Representação JSON |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
Campos | |
---|---|
tabId |
Apenas saída. O ID da guia. Não é possível mudar esse campo. |
title |
O nome da guia visível para o usuário. |
parentTabId |
Opcional. O ID da guia principal. Fica vazio quando a guia atual é uma guia de nível raiz, ou seja, não tem pais. |
index |
O índice com base em zero da guia no elemento pai. |
nestingLevel |
Apenas saída. A profundidade da guia no documento. As guias de nível raiz começam em 0. |
DocumentTab
Uma guia com o conteúdo do documento.
Representação JSON |
---|
{ "body": { object ( |
Campos | |
---|---|
body |
O corpo principal da guia do documento. |
headers |
Os cabeçalhos na guia "Documento", identificados pelo ID do cabeçalho. |
footers |
Os rodapés na guia do documento, identificados pelo ID do rodapé. |
footnotes |
As notas de rodapé na guia do documento, identificadas pelo ID da nota. |
documentStyle |
O estilo da guia do documento. |
suggestedDocumentStyleChanges |
As mudanças sugeridas no estilo da guia do documento, identificadas pelo ID da sugestão. |
namedStyles |
Os estilos nomeados da guia do documento. |
suggestedNamedStylesChanges |
As mudanças sugeridas nos estilos nomeados da guia do documento, com chave pelo ID da sugestão. |
lists |
As listas na guia "Documento", com chave pelo ID da lista. |
namedRanges |
Os intervalos nomeados na guia do documento, com chave pelo nome. |
inlineObjects |
Os objetos inline na guia "Documento", com chave pelo ID do objeto. |
positionedObjects |
Os objetos posicionados na guia "Documento", com chave pelo ID do objeto. |
Corpo
O corpo do documento.
O corpo geralmente contém todo o conteúdo do documento, exceto headers
, footers
e footnotes
.
Representação JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
O conteúdo do corpo. Os índices do conteúdo do corpo começam em zero. |
StructuralElement
Um StructuralElement descreve o conteúdo que fornece estrutura ao documento.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
O índice inicial com base zero desse elemento estrutural, em unidades de código UTF-16. |
endIndex |
O índice final com base zero deste 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 |
Um tipo de parágrafo de elemento estrutural. |
sectionBreak |
Um tipo de quebra de seção de elemento estrutural. |
table |
Um tipo de tabela de elemento estrutural. |
tableOfContents |
Um tipo de índice de elemento estrutural. |
Parágrafo
Um StructuralElement
que representa um parágrafo. Um parágrafo é um intervalo de conteúdo que termina com um caractere de nova linha.
Representação JSON |
---|
{ "elements": [ { object ( |
Campos | |
---|---|
elements[] |
O conteúdo do parágrafo, dividido em partes componentes. |
paragraphStyle |
O estilo deste parágrafo. |
suggestedParagraphStyleChanges |
O estilo de parágrafo sugerido muda para este parágrafo, com chave pelo ID da sugestão. |
bullet |
O marcador deste parágrafo. Se não estiver presente, o parágrafo não pertence a uma lista. |
suggestedBulletChanges |
As mudanças sugeridas no marcador deste parágrafo. |
positionedObjectIds[] |
Os IDs dos objetos posicionados vinculados a este parágrafo. |
suggestedPositionedObjectIds |
Os IDs dos objetos posicionados sugeridos para serem anexados a este parágrafo, com chave pelo ID da sugestão. |
ParagraphElement
Um ParagraphElement descreve o conteúdo em um Paragraph
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
O índice inicial baseado em zero desse elemento de parágrafo, em unidades de código UTF-16. |
endIndex |
O índice final de base zero deste elemento de parágrafo, exclusivo, em unidades de código UTF-16. |
Campo de união content . O conteúdo do elemento de parágrafo. content pode ser apenas de um dos tipos a seguir: |
|
textRun |
Um elemento de parágrafo de execução de texto. |
autoText |
Um elemento de parágrafo de texto automático. |
pageBreak |
Um elemento de parágrafo de quebra de página. |
columnBreak |
Um elemento de parágrafo de quebra de coluna. |
footnoteReference |
Um elemento de parágrafo de referência de nota de rodapé. |
horizontalRule |
Um elemento de parágrafo de regra horizontal. |
equation |
Um elemento de parágrafo de equação. |
inlineObjectElement |
Um elemento de parágrafo de objeto inline. |
person |
Um elemento de parágrafo que vincula a uma pessoa ou endereço de e-mail. |
richLink |
Um elemento de parágrafo que vincula a um recurso do Google, como um arquivo no Google Drive, um vídeo do YouTube ou um evento do Google Agenda. |
TextRun
Um ParagraphElement
que representa uma sequência de texto com o mesmo estilo.
Representação JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
content |
O texto desta execução. Todos os elementos que não são de texto na execução são substituídos pelo caractere Unicode U+E907. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo do texto desta execução. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para essa execução, com chave 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 elemento pai de um estilo de texto depende de onde ele é definido:
- O TextStyle do texto em um
Paragraph
herda onamed style type
correspondente do parágrafo. - O TextStyle em um
named style
herda do estilo nomeadonormal text
. - O TextStyle do estilo nomeado
normal text
herda do estilo de texto padrão no editor de documentos. - O TextStyle em um elemento
Paragraph
contido em uma tabela pode herdar o estilo de texto do estilo da tabela.
Se o estilo de texto não herdar de um elemento pai, a remoção da definição dos campos vai reverter o estilo para um valor que corresponda aos padrões no editor do Google Docs.
Representação JSON |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
Campos | |
---|---|
bold |
Indica se o texto é renderizado em negrito. |
italic |
Se o texto está em itálico ou não. |
underline |
Se o texto está sublinhado ou não. |
strikethrough |
Indica se o texto está tachado ou não. |
smallCaps |
Se o texto está em letras maiúsculas pequenas ou não. |
backgroundColor |
A cor de fundo do texto. Se definido, a cor será RGB ou transparente, dependendo do campo |
foregroundColor |
A cor do primeiro plano do texto. Se definido, a cor será RGB ou transparente, dependendo do campo |
fontSize |
O tamanho da fonte do texto. |
weightedFontFamily |
A família de fontes e a espessura renderizada do texto. Se uma solicitação de atualização especificar valores para Se Se |
baselineOffset |
O deslocamento vertical do texto da posição normal. O texto com deslocamentos de valor de referência |
link |
O destino do hiperlink do texto. Se não for definido, não haverá link. Os links não são herdados do texto principal. Mudar o link em uma solicitação de atualização causa outras mudanças no estilo do texto do intervalo:
|
OptionalColor
Uma cor que pode ser totalmente opaca ou totalmente transparente.
Representação JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Se definido, será usado como uma cor opaca. Se não for definido, isso vai representar uma cor transparente. |
Cor
Uma cor sólida.
Representação JSON |
---|
{
"rgbColor": {
object ( |
Campos | |
---|---|
rgbColor |
O valor da cor RGB. |
RgbColor
Uma cor RGB.
Representação JSON |
---|
{ "red": number, "green": number, "blue": number } |
Campos | |
---|---|
red |
O componente vermelho da cor, de 0,0 a 1,0. |
green |
O componente verde da cor, de 0,0 a 1,0. |
blue |
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 ( |
Campos | |
---|---|
magnitude |
A magnitude. |
unit |
As unidades de magnitude. |
Unidade
Unidades de medida.
Tipos enumerados | |
---|---|
UNIT_UNSPECIFIED |
As unidades são desconhecidas. |
PT |
Um ponto, 1/72 de polegada. |
WeightedFontFamily
Representa uma família de fontes e a espessura do texto.
Representação JSON |
---|
{ "fontFamily": string, "weight": integer } |
Campos | |
---|---|
fontFamily |
A família de fontes do texto. A família de fontes pode ser qualquer opção do menu "Fonte" nos Documentos ou do Google Fonts. Se o nome da fonte não for reconhecido, o texto será renderizado em |
weight |
A espessura da fonte. Esse campo pode ter qualquer valor que seja um múltiplo de O valor padrão é A espessura da fonte é apenas um componente da espessura renderizada. Uma combinação do
|
BaselineOffset
As maneiras pelas quais o texto pode ser deslocado verticalmente da posição normal.
Tipos enumerados | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
O deslocamento da linha de base do texto é herdado do elemento pai. |
NONE |
O texto não tem um deslocamento vertical. |
SUPERSCRIPT |
O texto é deslocado verticalmente para cima (sobrescrito). |
SUBSCRIPT |
O texto é deslocado verticalmente para baixo (subscrito). |
Link
Uma referência a outra parte de um documento ou a um recurso de URL externo.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união destination . O destino do link. destination pode ser apenas de um dos tipos a seguir: |
|
url |
Um URL externo. |
tabId |
O ID de uma guia neste documento. |
bookmark |
Um marcador de página neste documento. Em documentos com uma única guia, os links para marcadores dentro da guia singular continuam retornando |
heading |
Um título neste documento. Em documentos com uma única guia, os links para títulos dentro da guia singular continuam retornando |
bookmarkId |
O ID de um marcador neste documento. Campo legado: em vez disso, defina Se esse campo for usado em uma solicitação de gravação, o marcador será considerado do ID da guia especificado na solicitação. Se um ID de guia não for especificado na solicitação, ele será considerado da primeira guia do documento. |
headingId |
O ID de um cabeçalho neste documento. Campo legado: em vez disso, defina Se esse campo for usado em uma solicitação de gravação, o cabeçalho será considerado do ID da guia especificado na solicitação. Se um ID de guia não for especificado na solicitação, ele será considerado da primeira guia do documento. |
BookmarkLink
Uma referência a um marcador neste documento.
Representação JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
O ID de um marcador neste documento. |
tabId |
O ID da guia que contém este marcador. |
HeadingLink
Uma referência a um cabeçalho neste documento.
Representação JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
O ID de um cabeçalho neste documento. |
tabId |
O ID da guia que contém este cabeçalho. |
SuggestedTextStyle
Uma mudança sugerida em um TextStyle
.
Representação JSON |
---|
{ "textStyle": { object ( |
Campos | |
---|---|
textStyle |
Um |
textStyleSuggestionState |
Uma máscara que indica quais campos do |
TextStyleSuggestionState
Uma máscara que indica quais campos do TextStyle
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", 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 |
Indica se houve uma mudança sugerida em |
italicSuggested |
Indica se houve uma mudança sugerida em |
underlineSuggested |
Indica se houve uma mudança sugerida em |
strikethroughSuggested |
Indica se houve uma mudança sugerida em |
smallCapsSuggested |
Indica se houve uma mudança sugerida em |
backgroundColorSuggested |
Indica se houve uma mudança sugerida em |
foregroundColorSuggested |
Indica se houve uma mudança sugerida em |
fontSizeSuggested |
Indica se houve uma mudança sugerida em |
weightedFontFamilySuggested |
Indica se houve uma mudança sugerida em |
baselineOffsetSuggested |
Indica se houve uma mudança sugerida em |
linkSuggested |
Indica se houve uma mudança sugerida em |
AutoText
Um ParagraphElement
que representa um ponto no texto substituído dinamicamente por conteúdo que pode mudar com o tempo, como um número de página.
Representação JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
O tipo do texto automático. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto deste AutoTexto. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para esse texto automático, com chave pelo ID da sugestão. |
Tipo
Os tipos de texto automático.
Tipos enumerados | |
---|---|
TYPE_UNSPECIFIED |
Um tipo de texto automático não especificado. |
PAGE_NUMBER |
Digite para texto automático que representa o número da página atual. |
PAGE_COUNT |
Digite para texto automático que representa o número total de páginas no documento. |
PageBreak
Um ParagraphElement
que representa uma quebra de página. Uma quebra de página faz com que o texto subsequente comece na parte de cima da próxima página.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto deste PageBreak. Assim como o conteúdo de texto, como execuções de texto e referências de notas de rodapé, o estilo de texto de uma quebra de página pode afetar o layout do conteúdo e a estilização do texto inserido ao lado dela. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para esse PageBreak, com chave pelo ID da sugestão. |
ColumnBreak
Um ParagraphElement
que representa uma quebra de coluna. Uma quebra de coluna faz com que o texto subsequente comece na parte de cima da próxima coluna.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto deste ColumnBreak. Assim como o conteúdo de texto, como trechos de texto e referências de notas de rodapé, o estilo de texto de uma quebra de coluna pode afetar o layout do conteúdo e a estilização do texto inserido ao lado dela. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para esse ColumnBreak, com chave pelo ID da sugestão. |
FootnoteReference
Um ParagraphElement
que representa uma referência de nota de rodapé. Uma referência de nota de rodapé é o conteúdo inline 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 ( |
Campos | |
---|---|
footnoteId |
O ID do |
footnoteNumber |
O número renderizado desta nota de rodapé. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto deste FootnoteReference. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para essa FootnoteReference, com chave pelo ID da sugestão. |
HorizontalRule
Um ParagraphElement
que representa uma linha horizontal.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto desta HorizontalRule. 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 regra horizontal pode afetar o layout do conteúdo e a estilização do texto inserido ao lado dela. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para essa HorizontalRule, com chave pelo ID da sugestão. |
Equação
Um ParagraphElement
que representa uma equação.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
InlineObjectElement
Um ParagraphElement
que contém um InlineObject
.
Representação JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
inlineObjectId |
O ID do |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto deste InlineObjectElement. Assim como o conteúdo de texto, como trechos de texto e referências de notas de rodapé, o estilo de texto de um elemento de objeto inline pode afetar o layout do conteúdo e o estilo do texto inserido ao lado dele. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para esse InlineObject, com chave pelo ID da sugestão. |
Pessoa
Uma pessoa ou um endereço de e-mail mencionado em um documento. Essas menções funcionam 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 ( |
Campos | |
---|---|
personId |
Apenas saída. O ID exclusivo deste link. |
suggestedInsertionIds[] |
IDs das sugestões que inserem o link da pessoa no documento. Um |
suggestedDeletionIds[] |
IDs para sugestões que removem a vinculação da pessoa do documento. Um |
textStyle |
O estilo de texto deste |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para este |
personProperties |
Apenas saída. As propriedades deste |
PersonProperties
Propriedades específicas de um Person
vinculado.
Representação JSON |
---|
{ "name": string, "email": string } |
Campos | |
---|---|
name |
O nome da pessoa, se ele for exibido no texto do link em vez do endereço de e-mail. |
email |
O endereço de e-mail vinculado a este |
RichLink
Um link para um recurso do Google, como um arquivo no Drive, um vídeo do YouTube ou um evento do Google Agenda.
Representação JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
richLinkId |
Apenas saída. O ID deste link. |
suggestedInsertionIds[] |
IDs das sugestões que inserem esse link no documento. Um |
suggestedDeletionIds[] |
IDs das sugestões que removem esse link do documento. Um |
textStyle |
O estilo de texto deste |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para este |
richLinkProperties |
Apenas saída. As propriedades deste |
RichLinkProperties
Propriedades específicas de um RichLink
.
Representação JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
Campos | |
---|---|
title |
Apenas saída. O título do |
uri |
Apenas saída. O URI para o |
mimeType |
Apenas saída. O tipo MIME do |
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 elemento pai de um estilo de parágrafo depende de onde ele é definido:
- O ParagraphStyle em um
Paragraph
herda onamed style type
correspondente do parágrafo. - O ParagraphStyle em um
named style
herda do estilo nomeadonormal 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 de parágrafo não herdar de um elemento principal, a remoção da definição dos campos vai reverter o estilo para um valor que corresponda aos padrões no editor do Google Docs.
Representação JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Campos | |
---|---|
headingId |
O ID do cabeçalho do parágrafo. Se estiver vazio, o parágrafo não será um cabeçalho. Essa propriedade é somente leitura. |
namedStyleType |
O tipo de estilo nomeado do parágrafo. Como a atualização do tipo de estilo nomeado afeta outras propriedades em ParagraphStyle, o tipo de estilo nomeado é aplicado antes da atualização das outras propriedades. |
alignment |
O alinhamento do texto para este parágrafo. |
lineSpacing |
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 elemento pai. |
direction |
A direção do texto deste parágrafo. Se não for definido, o valor será |
spacingMode |
O modo de espaçamento do parágrafo. |
spaceAbove |
A quantidade de espaço extra acima do parágrafo. Se não for definido, o valor será herdado do elemento pai. |
spaceBelow |
A quantidade de espaço extra abaixo do parágrafo. Se não for definido, o valor será herdado do elemento pai. |
borderBetween |
A borda entre este parágrafo e os próximos e anteriores. Se não for definido, o valor será herdado do elemento pai. A borda entre é renderizada quando o parágrafo adjacente tem as mesmas propriedades de borda e recuo. Não é possível atualizar parcialmente as bordas de parágrafos. Ao mudar uma borda de parágrafo, é necessário especificar a nova borda por completo. |
borderTop |
A borda na parte de cima deste parágrafo. Se não for definido, o valor será herdado do elemento pai. A borda superior é renderizada quando o parágrafo acima tem propriedades de borda e recuo diferentes. Não é possível atualizar parcialmente as bordas de parágrafos. Ao mudar uma borda de parágrafo, é necessário especificar a nova borda por completo. |
borderBottom |
A borda na parte de baixo deste parágrafo. Se não for definido, o valor será herdado do elemento pai. A borda inferior é renderizada quando o parágrafo abaixo tem propriedades de borda e recuo diferentes. Não é possível atualizar parcialmente as bordas de parágrafos. Ao mudar uma borda de parágrafo, é necessário especificar a nova borda por completo. |
borderLeft |
A borda à esquerda deste parágrafo. Se não for definido, o valor será herdado do elemento pai. Não é possível atualizar parcialmente as bordas de parágrafos. Ao mudar uma borda de parágrafo, é necessário especificar a nova borda por completo. |
borderRight |
A borda à direita deste parágrafo. Se não for definido, o valor será herdado do elemento pai. Não é possível atualizar parcialmente as bordas de parágrafos. Ao mudar uma borda de parágrafo, é necessário especificar a nova borda por completo. |
indentFirstLine |
A quantidade de recuo da primeira linha do parágrafo. Se não for definido, o valor será herdado do elemento pai. |
indentStart |
A quantidade de recuo do parágrafo no lado 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 elemento pai. |
indentEnd |
A quantidade de recuo do parágrafo no lado que corresponde ao fim do texto, com base na direção atual do parágrafo. Se não for definido, o valor será herdado do elemento pai. |
tabStops[] |
Uma lista das paradas de tabulação deste parágrafo. A lista de paradas de tabulação não é herdada. Essa propriedade é somente leitura. |
keepLinesTogether |
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 elemento pai. |
keepWithNext |
Se pelo menos uma parte deste parágrafo deve ser apresentada na mesma página ou coluna que o próximo parágrafo, se possível. Se não for definido, o valor será herdado do elemento pai. |
avoidWidowAndOrphan |
Se é para evitar viúvas e órfãos no parágrafo. Se não for definido, o valor será herdado do elemento pai. |
shading |
O sombreamento do parágrafo. Se não for definido, o valor será herdado do elemento pai. |
pageBreakBefore |
Indica se o parágrafo atual deve sempre começar no início de uma página. Se não for definido, o valor será herdado do elemento pai. Tentar atualizar |
NamedStyleType
Os tipos de estilos nomeados.
Tipos enumerados | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
O tipo de estilo nomeado não foi especificado. |
NORMAL_TEXT |
Texto normal. |
TITLE |
Título. |
SUBTITLE |
Subtítulo. |
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 para um parágrafo.
Tipos enumerados | |
---|---|
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 e à direita para outros casos. |
CENTER |
O parágrafo está centralizado. |
END |
O parágrafo é alinhado ao final da linha. Alinhado à direita para texto LTR e à esquerda para outros casos. |
JUSTIFIED |
O parágrafo está justificado. |
ContentDirection
O conteúdo das rotas pode fluir.
Tipos enumerados | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
A direção do conteúdo não foi 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. |
SpacingMode
Os diferentes modos de espaçamento entre parágrafos.
Tipos enumerados | |
---|---|
SPACING_MODE_UNSPECIFIED |
O modo de espaçamento é herdado do elemento pai. |
NEVER_COLLAPSE |
O espaçamento entre parágrafos é sempre renderizado. |
COLLAPSE_LISTS |
O espaçamento de parágrafo é ignorado entre os elementos da lista. |
ParagraphBorder
Uma borda ao redor de um parágrafo.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
É a cor da borda. |
width |
É a largura da borda. |
padding |
O padding da borda. |
dashStyle |
O estilo de traço da borda. |
DashStyle
Os tipos de traços com que a geometria linear pode ser renderizada. Esses valores se baseiam no tipo simples "ST_PresetLineDashVal" descrito na seção 20.1.10.49 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 da 5ª edição da ECMA-376.
Tipos enumerados | |
---|---|
DASH_STYLE_UNSPECIFIED |
Estilo de traço não especificado. |
SOLID |
Linha sólida. Corresponde ao valor "solid" de ST_PresetLineDashVal da ECMA-376. Esse é 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 "dash" de ST_PresetLineDashVal da ECMA-376. |
TabStop
Uma parada de tabulação em um parágrafo.
Representação JSON |
---|
{ "offset": { object ( |
Campos | |
---|---|
offset |
O deslocamento entre essa parada de tabulação e a margem inicial. |
alignment |
O alinhamento da parada de tabulação. Se não for definido, o valor padrão será |
TabStopAlignment
O alinhamento da parada de tabulação.
Tipos enumerados | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
O alinhamento da parada de tabulação não foi 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 ( |
Campos | |
---|---|
backgroundColor |
A cor de fundo do sombreamento do parágrafo. |
SuggestedParagraphStyle
Uma mudança sugerida em um ParagraphStyle
.
Representação JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraphStyle |
Um |
paragraphStyleSuggestionState |
Uma máscara que indica quais campos do |
ParagraphStyleSuggestionState
Uma máscara que indica quais campos do ParagraphStyle
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", 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 ( |
Campos | |
---|---|
headingIdSuggested |
Indica se houve uma mudança sugerida em |
namedStyleTypeSuggested |
Indica se houve uma mudança sugerida em |
alignmentSuggested |
Indica se houve uma mudança sugerida em |
lineSpacingSuggested |
Indica se houve uma mudança sugerida em |
directionSuggested |
Indica se houve uma mudança sugerida em |
spacingModeSuggested |
Indica se houve uma mudança sugerida em |
spaceAboveSuggested |
Indica se houve uma mudança sugerida em |
spaceBelowSuggested |
Indica se houve uma mudança sugerida em |
borderBetweenSuggested |
Indica se houve uma mudança sugerida em |
borderTopSuggested |
Indica se houve uma mudança sugerida em |
borderBottomSuggested |
Indica se houve uma mudança sugerida em |
borderLeftSuggested |
Indica se houve uma mudança sugerida em |
borderRightSuggested |
Indica se houve uma mudança sugerida em |
indentFirstLineSuggested |
Indica se houve uma mudança sugerida em |
indentStartSuggested |
Indica se houve uma mudança sugerida em |
indentEndSuggested |
Indica se houve uma mudança sugerida em |
keepLinesTogetherSuggested |
Indica se houve uma mudança sugerida em |
keepWithNextSuggested |
Indica se houve uma mudança sugerida em |
avoidWidowAndOrphanSuggested |
Indica se houve uma mudança sugerida em |
shadingSuggestionState |
Uma máscara que indica quais campos em |
pageBreakBeforeSuggested |
Indica se houve uma mudança sugerida em |
ShadingSuggestionState
Uma máscara que indica quais campos no Shading
de base foram alterados nesta mudança sugerida. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica se houve uma mudança sugerida no |
Marcador
Descreve o marcador de um parágrafo.
Representação JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Campos | |
---|---|
listId |
O ID da lista a que este parágrafo pertence. |
nestingLevel |
O nível de aninhamento deste parágrafo na lista. |
textStyle |
O estilo de texto específico do parágrafo aplicado a este marcador. |
SuggestedBullet
Uma mudança sugerida em um Bullet
.
Representação JSON |
---|
{ "bullet": { object ( |
Campos | |
---|---|
bullet |
Um |
bulletSuggestionState |
Uma máscara que indica quais campos do |
BulletSuggestionState
Uma máscara que indica quais campos do Bullet
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
listIdSuggested |
Indica se houve uma mudança sugerida no |
nestingLevelSuggested |
Indica se houve uma mudança sugerida no |
textStyleSuggestionState |
Uma máscara que indica quais campos em |
ObjectReferences
Uma coleção de IDs de objetos.
Representação JSON |
---|
{ "objectIds": [ string ] } |
Campos | |
---|---|
objectIds[] |
Os IDs dos objetos. |
SectionBreak
Um StructuralElement
que representa uma quebra de seção. Uma seção é um intervalo de conteúdo que tem o mesmo SectionStyle
. Uma quebra de seção representa o início de uma nova seção, e o estilo de 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 ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
sectionStyle |
O estilo da seção após essa quebra. |
SectionStyle
O estilo que se aplica a uma seção.
Representação JSON |
---|
{ "columnProperties": [ { object ( |
Campos | |
---|---|
columnProperties[] |
As propriedades das colunas da seção. Se estiver vazia, a seção vai conter uma coluna com as propriedades padrão no editor de documentos. Uma seção pode ser atualizada para ter no máximo três colunas. Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai ocorrer um erro 400 de solicitação inválida. |
columnSeparatorStyle |
O estilo dos separadores de coluna. Esse estilo pode ser definido mesmo quando há uma coluna na seção. Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
contentDirection |
A direção do conteúdo desta seção. Se não for definido, o valor padrão será Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
marginTop |
A margem superior da página da seção. Se não for definido, o valor padrão será Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
marginBottom |
A margem inferior da página da seção. Se não for definido, o valor padrão será Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
marginRight |
A margem direita da página da seção. Se não for definido, o valor padrão será Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
marginLeft |
A margem esquerda da página da seção. Se não for definido, o valor padrão será Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
marginHeader |
A margem do cabeçalho da seção. Se não for definido, o valor padrão será Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
marginFooter |
A margem do rodapé da seção. Se não for definido, o valor padrão será Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
sectionType |
Apenas saída. O tipo de seção. |
defaultHeaderId |
O ID do cabeçalho padrão. Se não for definido, o valor será herdado do Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
defaultFooterId |
O ID do rodapé padrão. Se não for definido, o valor será herdado do Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
firstPageHeaderId |
O ID do cabeçalho usado apenas para a primeira página da seção. Se Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
firstPageFooterId |
O ID do rodapé usado apenas na primeira página da seção. Se Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
evenPageHeaderId |
O ID do cabeçalho usado apenas para páginas pares. Se o valor de Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
evenPageFooterId |
O ID do rodapé usado apenas para páginas pares. Se o valor de Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
useFirstPageHeaderFooter |
Indica se os IDs de cabeçalho / rodapé da primeira página devem ser usados na primeira página da seção. Se não for definido, ele vai herdar Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
pageNumberStart |
O número da página a partir da qual começar a contar o número de páginas desta seção. Se não for definido, a numeração de página vai continuar da seção anterior. Se o valor não estiver definido no primeiro Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
flipPageOrientation |
Opcional. Indica se as dimensões do Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Ao atualizar essa propriedade, é necessário definir um valor concreto. Se você não definir essa propriedade, vai receber um erro 400 de solicitação inválida. |
SectionColumnProperties
Propriedades que se aplicam à coluna de uma seção.
Representação JSON |
---|
{ "width": { object ( |
Campos | |
---|---|
width |
Apenas saída. A largura da coluna. |
paddingEnd |
O padding no final da coluna. |
ColumnSeparatorStyle
O estilo dos separadores entre colunas.
Tipos enumerados | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Um estilo de separador de colunas não especificado. |
NONE |
Não há linhas de separação entre as colunas. |
BETWEEN_EACH_COLUMN |
Renderiza uma linha separadora entre cada coluna. |
SectionType
Representa como o início da seção atual está posicionado em relação à seção anterior.
Tipos enumerados | |
---|---|
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 ( |
Campos | |
---|---|
rows |
Número de linhas na tabela. |
columns |
Número de colunas na tabela. É possível que uma tabela não seja retangular, então algumas linhas podem ter um número diferente de células. |
tableRows[] |
O conteúdo e o estilo de cada linha. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
tableStyle |
O estilo da tabela. |
TableRow
O conteúdo e o estilo de uma linha em um Table
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
Campos | |
---|---|
startIndex |
O índice de início baseado em zero desta linha, em unidades de código UTF-16. |
endIndex |
O índice final com base zero desta linha, exclusivo, em unidades de código UTF-16. |
tableCells[] |
O conteúdo e o estilo de cada célula nessa linha. É possível que uma tabela não seja retangular. Assim, algumas linhas podem ter um número de células diferente de outras na mesma tabela. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
tableRowStyle |
O estilo da linha da tabela. |
suggestedTableRowStyleChanges |
O estilo sugerido muda para esta linha, com chave pelo ID da sugestão. |
TableCell
O conteúdo e o estilo de uma célula em um Table
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Campos | |
---|---|
startIndex |
O índice inicial baseado em zero desta célula, em unidades de código UTF-16. |
endIndex |
O índice final com base zero desta célula, exclusivo, em unidades de código UTF-16. |
content[] |
O conteúdo da célula. |
tableCellStyle |
O estilo da célula. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
suggestedTableCellStyleChanges |
As mudanças sugeridas no estilo da célula da tabela, identificadas pelo ID da sugestão. |
TableCellStyle
O estilo de um TableCell
.
Os estilos de células de tabela herdados são representados como campos não definidos nesta mensagem. Um estilo de célula de tabela pode ser herdado do estilo da tabela.
Representação JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
Campos | |
---|---|
rowSpan |
O intervalo de linhas da célula. Essa propriedade é somente leitura. |
columnSpan |
O intervalo de colunas da célula. Essa propriedade é somente leitura. |
backgroundColor |
A cor de fundo da célula. |
borderLeft |
A borda esquerda da célula. |
borderRight |
A borda direita da célula. |
borderTop |
A borda superior da célula. |
borderBottom |
A borda inferior da célula. |
paddingLeft |
O padding à esquerda da célula. |
paddingRight |
O padding à direita da célula. |
paddingTop |
O padding da parte de cima da célula. |
paddingBottom |
O padding da parte de baixo da célula. |
contentAlignment |
O alinhamento do conteúdo na célula da tabela. O alinhamento padrão corresponde ao das células de tabela recém-criadas no editor do Google Docs. |
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 ( |
Campos | |
---|---|
color |
É a cor da borda. Essa cor não pode ser transparente. |
width |
É a largura da borda. |
dashStyle |
O estilo de traço da borda. |
ContentAlignment
Os tipos de alinhamento de conteúdo.
Derivado de um subconjunto dos valores do tipo simples "ST_TextAnchoringType" na seção 20.1.10.60 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 da 5ª edição do ECMA-376.
Tipos enumerados | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Um alinhamento de conteúdo não especificado. O alinhamento do conteúdo é herdado do elemento pai, se houver um. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Um alinhamento de conteúdo não compatível. |
TOP |
Um alinhamento que alinha o conteúdo à parte de cima do contêiner. Corresponde a ECMA-376 ST_TextAnchoringType "t". |
MIDDLE |
Um alinhamento que alinha o conteúdo ao meio do contêiner. Corresponde a ECMA-376 ST_TextAnchoringType "ctr". |
BOTTOM |
Um alinhamento que alinha o conteúdo à parte de baixo do contêiner. Corresponde a ECMA-376 ST_TextAnchoringType "b". |
SuggestedTableCellStyle
Uma mudança sugerida em um TableCellStyle
.
Representação JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
tableCellStyle |
Um |
tableCellStyleSuggestionState |
Uma máscara que indica quais campos do |
TableCellStyleSuggestionState
Uma máscara que indica quais campos do TableCellStyle
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", 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 |
Indica se houve uma mudança sugerida em |
columnSpanSuggested |
Indica se houve uma mudança sugerida em |
backgroundColorSuggested |
Indica se houve uma mudança sugerida em |
borderLeftSuggested |
Indica se houve uma mudança sugerida em |
borderRightSuggested |
Indica se houve uma mudança sugerida em |
borderTopSuggested |
Indica se houve uma mudança sugerida em |
borderBottomSuggested |
Indica se houve uma mudança sugerida em |
paddingLeftSuggested |
Indica se houve uma mudança sugerida em |
paddingRightSuggested |
Indica se houve uma mudança sugerida em |
paddingTopSuggested |
Indica se houve uma mudança sugerida em |
paddingBottomSuggested |
Indica se houve uma mudança sugerida em |
contentAlignmentSuggested |
Indica se houve uma mudança sugerida em |
TableRowStyle
Estilos que se aplicam a uma linha da tabela.
Representação JSON |
---|
{
"minRowHeight": {
object ( |
Campos | |
---|---|
minRowHeight |
A altura mínima da linha. A linha será renderizada no editor do Google Docs com uma altura igual ou maior que esse valor para mostrar todo o conteúdo nas células da linha. |
tableHeader |
Se a linha é um cabeçalho de tabela. |
preventOverflow |
Se a linha não pode ultrapassar os limites da página ou da coluna. |
SuggestedTableRowStyle
Uma mudança sugerida em um TableRowStyle
.
Representação JSON |
---|
{ "tableRowStyle": { object ( |
Campos | |
---|---|
tableRowStyle |
Um |
tableRowStyleSuggestionState |
Uma máscara que indica quais campos do |
TableRowStyleSuggestionState
Uma máscara que indica quais campos do TableRowStyle
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{ "minRowHeightSuggested": boolean } |
Campos | |
---|---|
minRowHeightSuggested |
Indica se houve uma mudança sugerida em |
TableStyle
Estilos que se aplicam a uma tabela.
Representação JSON |
---|
{
"tableColumnProperties": [
{
object ( |
Campos | |
---|---|
tableColumnProperties[] |
As propriedades de cada coluna. Nos Documentos, as tabelas contêm linhas, e as linhas contêm células, assim como em HTML. Portanto, as propriedades de uma linha podem ser encontradas no |
TableColumnProperties
As propriedades de uma coluna em uma tabela.
Representação JSON |
---|
{ "widthType": enum ( |
Campos | |
---|---|
widthType |
O tipo de largura da coluna. |
width |
A largura da coluna. Definido quando o |
WidthType
O tipo de largura da coluna.
Tipos enumerados | |
---|---|
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 distribuídas de maneira uniforme. A largura da coluna é determinada automaticamente e terá uma parte igual da largura restante para a tabela depois de considerar todas as colunas com larguras especificadas. |
FIXED_WIDTH |
Uma largura de coluna fixa. A propriedade [width][google.apps.docs.v1.TableColumnProperties.width contém a largura da coluna. |
TableOfContents
Um StructuralElement
que representa um sumário.
Representação JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
O conteúdo do sumário. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
Cabeçalho
Um cabeçalho de documento.
Representação JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
Campos | |
---|---|
headerId |
O ID do cabeçalho. |
content[] |
O conteúdo do cabeçalho. Os índices do conteúdo de um cabeçalho começam em zero. |
Nota de rodapé
Uma nota de rodapé do documento.
Representação JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
Campos | |
---|---|
footnoteId |
O ID da nota de rodapé. |
content[] |
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 ( |
Campos | |
---|---|
background |
O plano de fundo do documento. Os documentos não podem ter uma cor de fundo transparente. |
defaultHeaderId |
O ID do cabeçalho padrão. Se não for definido, não haverá um cabeçalho padrão. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
defaultFooterId |
O ID do rodapé padrão. Se não for definido, não haverá um rodapé padrão. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
evenPageHeaderId |
O ID do cabeçalho usado apenas para páginas pares. O valor de Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
evenPageFooterId |
O ID do rodapé usado apenas para páginas pares. O valor de Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
firstPageHeaderId |
O ID do cabeçalho usado apenas na primeira página. Se não estiver definido, não haverá um cabeçalho exclusivo para a primeira página. O valor de Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
firstPageFooterId |
O ID do rodapé usado apenas na primeira página. Se não estiver definido, não haverá um rodapé exclusivo para a primeira página. O valor de Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
useFirstPageHeaderFooter |
Indica se os IDs de cabeçalho / rodapé da primeira página devem ser usados na primeira página. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
useEvenPageHeaderFooter |
Indica se os IDs de cabeçalho / rodapé de página par devem ser usados para as páginas pares. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
pageNumberStart |
O número da página a partir da qual começar a contar o número de páginas. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
marginTop |
A margem superior da página. Atualizar a margem superior da página no estilo do documento limpa a margem superior da página em todos os estilos de seção. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
marginBottom |
A margem inferior da página. Atualizar a margem inferior da página no estilo do documento limpa a margem inferior da página em todos os estilos de seção. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
marginRight |
A margem direita da página. Atualizar a margem direita na página do estilo do documento limpa a margem direita em todos os estilos de seção. Isso também pode fazer com que as colunas sejam redimensionadas em todas as seções. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
marginLeft |
A margem da página à esquerda. Atualizar a margem da página à esquerda no estilo do documento limpa a margem da página à esquerda em todos os estilos de seção. Isso também pode fazer com que as colunas sejam redimensionadas em todas as seções. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
pageSize |
O tamanho de uma página no documento. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
marginHeader |
A quantidade de espaço entre a parte de cima da página e o conteúdo do cabeçalho. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
marginFooter |
A quantidade de espaço entre a parte de baixo da página e o conteúdo do rodapé. Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
useCustomHeaderFooterMargins |
Indica se DocumentStyle Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for Essa propriedade é somente leitura. |
flipPageOrientation |
Opcional. Indica se as dimensões do Se [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] for |
documentFormat |
Especifica configurações de formato no nível do documento, como o modo do documento (com ou sem páginas). |
Contexto
Representa o plano de fundo de um documento.
Representação JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
A cor do plano de fundo. |
Tamanho
Uma largura e uma altura.
Representação JSON |
---|
{ "height": { object ( |
Campos | |
---|---|
height |
A altura do objeto. |
width |
A largura do objeto. |
DocumentFormat
Representa configurações de formato no nível do documento.
Representação JSON |
---|
{
"documentMode": enum ( |
Campos | |
---|---|
documentMode |
Se o documento tem páginas ou não. |
DocumentMode
Se o documento tem páginas ou não.
Tipos enumerados | |
---|---|
DOCUMENT_MODE_UNSPECIFIED |
O modo de documento não foi especificado. |
PAGES |
O documento tem páginas. |
PAGELESS |
O documento não tem páginas. |
SuggestedDocumentStyle
Uma mudança sugerida no DocumentStyle
.
Representação JSON |
---|
{ "documentStyle": { object ( |
Campos | |
---|---|
documentStyle |
Um |
documentStyleSuggestionState |
Uma máscara que indica quais campos do |
DocumentStyleSuggestionState
Uma máscara que indica quais campos do DocumentStyle
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{ "backgroundSuggestionState": { object ( |
Campos | |
---|---|
backgroundSuggestionState |
Uma máscara que indica quais campos em |
defaultHeaderIdSuggested |
Indica se houve uma mudança sugerida em |
defaultFooterIdSuggested |
Indica se houve uma mudança sugerida em |
evenPageHeaderIdSuggested |
Indica se houve uma mudança sugerida em |
evenPageFooterIdSuggested |
Indica se houve uma mudança sugerida em |
firstPageHeaderIdSuggested |
Indica se houve uma mudança sugerida em |
firstPageFooterIdSuggested |
Indica se houve uma mudança sugerida em |
useFirstPageHeaderFooterSuggested |
Indica se houve uma mudança sugerida em |
useEvenPageHeaderFooterSuggested |
Indica se houve uma mudança sugerida em |
pageNumberStartSuggested |
Indica se houve uma mudança sugerida em |
marginTopSuggested |
Indica se houve uma mudança sugerida em |
marginBottomSuggested |
Indica se houve uma mudança sugerida em |
marginRightSuggested |
Indica se houve uma mudança sugerida em |
marginLeftSuggested |
Indica se houve uma mudança sugerida em |
pageSizeSuggestionState |
Uma máscara que indica quais dos campos em [size] [google.apps.docs.v1.DocumentStyle.size] foram alterados nesta sugestão. |
marginHeaderSuggested |
Indica se houve uma mudança sugerida em |
marginFooterSuggested |
Indica se houve uma mudança sugerida em |
useCustomHeaderFooterMarginsSuggested |
Indica se houve uma mudança sugerida em |
flipPageOrientationSuggested |
Opcional. Indica se houve uma mudança sugerida em |
BackgroundSuggestionState
Uma máscara que indica quais campos do Background
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", o Backgound
tem um novo valor sugerido.
Representação JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica se a cor de plano de fundo atual foi modificada nesta sugestão. |
SizeSuggestionState
Uma máscara que indica quais campos do Size
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", o Size
tem um novo valor sugerido.
Representação JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Campos | |
---|---|
heightSuggested |
Indica se houve uma mudança sugerida em |
widthSuggested |
Indica se houve uma mudança sugerida em |
NamedStyles
Os estilos nomeados. Os parágrafos do documento podem herdar o TextStyle
e o ParagraphStyle
desses estilos nomeados.
Representação JSON |
---|
{
"styles": [
{
object ( |
Campos | |
---|---|
styles[] |
Os estilos nomeados. Há uma entrada para cada um dos |
NamedStyle
Um estilo nomeado. Os parágrafos do documento podem herdar TextStyle
e ParagraphStyle
desse estilo nomeado quando têm o mesmo tipo de estilo nomeado.
Representação JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
namedStyleType |
O tipo desse estilo nomeado. |
textStyle |
O estilo de texto desse estilo nomeado. |
paragraphStyle |
O estilo de parágrafo desse estilo nomeado. |
SuggestedNamedStyles
Uma mudança sugerida no NamedStyles
.
Representação JSON |
---|
{ "namedStyles": { object ( |
Campos | |
---|---|
namedStyles |
Um |
namedStylesSuggestionState |
Uma máscara que indica quais campos do |
NamedStylesSuggestionState
O estado de sugestão de uma mensagem NamedStyles
.
Representação JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
Campos | |
---|---|
stylesSuggestionStates[] |
Uma máscara que indica quais campos do A ordem desses estados de sugestão de estilo nomeado corresponde à ordem do estilo nomeado correspondente na sugestão |
NamedStyleSuggestionState
Um estado de sugestão de uma mensagem NamedStyle
.
Representação JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
namedStyleType |
O tipo de estilo nomeado a que este estado de sugestão corresponde. Esse campo é fornecido como uma conveniência para corresponder o NamedStyleSuggestionState com o |
textStyleSuggestionState |
Uma máscara que indica quais campos em |
paragraphStyleSuggestionState |
Uma máscara que indica quais campos em |
Lista
Uma lista representa os atributos de lista de um grupo de parágrafos que pertencem à mesma lista. Um parágrafo que faz parte de uma lista tem uma referência ao ID dela no bullet
.
Representação JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
As propriedades da lista. |
suggestedListPropertiesChanges |
As mudanças sugeridas nas propriedades da lista, identificadas pelo ID da sugestão. |
suggestedInsertionId |
O ID de inserção sugerido. Se estiver vazio, não será uma inserção sugerida. |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas dessa lista. |
ListProperties
As propriedades de um list
que descrevem a aparência dos marcadores pertencentes a parágrafos associados a uma lista.
Representação JSON |
---|
{
"nestingLevels": [
{
object ( |
Campos | |
---|---|
nestingLevels[] |
Descreve as propriedades dos marcadores no nível associado. Uma lista tem no máximo nove níveis de aninhamento, sendo o nível 0 o mais alto e o nível 8 o mais aninhado. Os níveis de aninhamento são retornados em ordem crescente, com o menos aninhado sendo retornado primeiro. |
NestingLevel
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 ( |
Campos | |
---|---|
bulletAlignment |
O alinhamento do marcador no espaço reservado para renderização. |
glyphFormat |
A string de formato usada por marcadores neste nível de aninhamento. O formato do glifo contém um ou mais marcadores de posição, que são substituídos pelos valores adequados dependendo do Por exemplo, o formato de glifo
O formato do glifo pode conter marcadores de posição para o nível de aninhamento atual e para os níveis de aninhamento principais. Por exemplo, uma lista pode ter um formato de glifo
Para níveis de aninhamento ordenados, a string que substitui um marcador de posição no formato de glifo de um determinado parágrafo depende da ordem dele na lista. |
indentFirstLine |
A quantidade de recuo da primeira linha dos parágrafos neste nível de aninhamento. |
indentStart |
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 do conteúdo do parágrafo. |
textStyle |
O estilo de texto dos marcadores neste nível de aninhamento. |
startNumber |
O número do primeiro item da lista neste nível de aninhamento. Um valor de 0 é tratado como um valor de 1 para listas com letras e números romanos. Para valores 0 e 1, as listas com letras e números romanos vão começar em Esse valor é ignorado para níveis de aninhamento com glifos não ordenados. |
Campo de união glyph_kind . O tipo de glifo usado por marcadores. Isso define o glifo de marcador que substitui os marcadores de posição no glyph_format . glyph_kind pode ser apenas de um dos tipos a seguir: |
|
glyphType |
O tipo de glifo usado por marcadores quando os parágrafos nesse nível de aninhamento são ordenados. O tipo de glifo determina o tipo usado para substituir os marcadores de posição no |
glyphSymbol |
Um símbolo de glifo personalizado usado por marcadores quando os parágrafos nesse nível de aninhamento não estão ordenados. O símbolo de glifo substitui marcadores de posição no |
BulletAlignment
Os tipos de alinhamento de um marcador.
Tipos enumerados | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
O alinhamento do marcador não foi especificado. |
START |
O marcador é alinhado ao início do espaço alocado para renderização. Alinhado à esquerda para texto LTR e à direita para outros casos. |
CENTER |
O marcador é alinhado ao centro do espaço alocado para renderização. |
END |
O marcador é alinhado ao final do espaço reservado para renderização. Alinhado à direita para texto LTR e à esquerda para outros casos. |
GlyphType
Os tipos de glifos usados por marcadores quando os parágrafos nesse nível de aninhamento são ordenados.
Tipos enumerados | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
O tipo de glifo não foi especificado ou não tem suporte. |
NONE |
Uma string vazia. |
DECIMAL |
Um número, como 1 , 2 ou 3 . |
ZERO_DECIMAL |
Um número em que os números de um único dígito são precedidos por 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 em maiúsculas, como I , II ou III . |
ROMAN |
Um número romano em letras minúsculas, como i , ii ou iii . |
SuggestedListProperties
Uma mudança sugerida em ListProperties
.
Representação JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Um |
listPropertiesSuggestionState |
Uma máscara que indica quais campos do |
ListPropertiesSuggestionState
Uma máscara que indica quais campos do ListProperties
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Campos | |
---|---|
nestingLevelsSuggestionStates[] |
Uma máscara que indica quais campos do As sugestões de estado de nível de aninhamento são retornadas em ordem crescente do nível de aninhamento, sendo o menos aninhado retornado primeiro. |
NestingLevelSuggestionState
Uma máscara que indica quais campos do NestingLevel
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
bulletAlignmentSuggested |
Indica se houve uma mudança sugerida em |
glyphTypeSuggested |
Indica se houve uma mudança sugerida em |
glyphFormatSuggested |
Indica se houve uma mudança sugerida em |
glyphSymbolSuggested |
Indica se houve uma mudança sugerida em |
indentFirstLineSuggested |
Indica se houve uma mudança sugerida em |
indentStartSuggested |
Indica se houve uma mudança sugerida em |
textStyleSuggestionState |
Uma máscara que indica quais campos em |
startNumberSuggested |
Indica se houve uma mudança sugerida em |
NamedRanges
Uma coleção de todos os NamedRange
s no documento que compartilham um determinado nome.
Representação JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Campos | |
---|---|
name |
O nome que todos os |
namedRanges[] |
Os |
NamedRange
Uma coleção de Range
s 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 o 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 ID exclusivo.
Um intervalo nomeado é criado com um único Range
, e o conteúdo inserido dentro dele geralmente expande esse intervalo. No entanto, algumas mudanças no documento podem dividir o intervalo em vários.
Os intervalos nomeados não são particulares. Todos os aplicativos e colaboradores que têm acesso ao documento podem ver os intervalos nomeados.
Representação JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Campos | |
---|---|
namedRangeId |
O ID do intervalo nomeado. |
name |
O nome do intervalo nomeado. |
ranges[] |
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, "tabId": string } |
Campos | |
---|---|
segmentId |
O ID do cabeçalho, rodapé ou nota de rodapé em que esse intervalo está contido. Um ID de segmento vazio significa o corpo do documento. |
startIndex |
O índice inicial baseado em zero desse intervalo, em unidades de código UTF-16. Em todos os usos atuais, é necessário fornecer um índice inicial. Esse campo é um Int32Value para acomodar casos de uso futuros com intervalos abertos. |
endIndex |
O índice final com base zero desse intervalo, exclusivo, em unidades de código UTF-16. Em todos os usos atuais, um índice final precisa ser fornecido. Esse campo é um Int32Value para acomodar casos de uso futuros com intervalos abertos. |
tabId |
A guia que contém esse intervalo. Quando omitido, a solicitação se aplica à primeira guia. Em um documento com uma única guia:
Em um documento com várias guias:
|
InlineObject
Um objeto que aparece inline com o texto. Um InlineObject contém um EmbeddedObject
, como uma imagem.
Representação JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
Campos | |
---|---|
objectId |
O ID desse objeto inline. Pode ser usado para atualizar as propriedades de um objeto. |
inlineObjectProperties |
As propriedades desse objeto inline. |
suggestedInlineObjectPropertiesChanges |
As mudanças sugeridas nas propriedades do objeto inline, com chave pelo ID da sugestão. |
suggestedInsertionId |
O ID de inserção sugerido. Se estiver vazio, não será uma inserção sugerida. |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
InlineObjectProperties
Propriedades de um InlineObject
.
Representação JSON |
---|
{
"embeddedObject": {
object ( |
Campos | |
---|---|
embeddedObject |
O objeto incorporado deste objeto inline. |
EmbeddedObject
Um objeto incorporado no documento.
Representação JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Campos | |
---|---|
title |
O título do objeto incorporado. Os elementos |
description |
A descrição do objeto incorporado. Os elementos |
embeddedObjectBorder |
A borda do objeto incorporado. |
size |
O tamanho visível da imagem após o corte. |
marginTop |
A margem superior do objeto incorporado. |
marginBottom |
A margem inferior do objeto incorporado. |
marginRight |
A margem direita do objeto incorporado. |
marginLeft |
A margem esquerda do objeto incorporado. |
linkedContentReference |
Uma referência ao conteúdo da fonte externa vinculada. Por exemplo, ele contém uma referência ao gráfico de origem das Planilhas Google quando o objeto incorporado é um gráfico vinculado. Se não estiver 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 |
As propriedades de um desenho incorporado. |
imageProperties |
As propriedades de uma imagem. |
EmbeddedDrawingProperties
Esse tipo não tem campos.
As propriedades de um desenho incorporado e usadas para diferenciar o tipo de objeto. Um desenho incorporado é criado e editado em um documento. Detalhes extensos não são aceitos.
ImageProperties
As propriedades de uma imagem.
Representação JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
Campos | |
---|---|
contentUri |
Um URI para a imagem com um ciclo de vida 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 mudarem. |
sourceUri |
O URI de origem é o URI usado para inserir a imagem. O URI de origem pode estar vazio. |
brightness |
O efeito de brilho da imagem. O valor precisa estar no intervalo [-1,0, 1,0], em que 0 significa nenhum efeito. |
contrast |
O efeito de contraste da imagem. O valor precisa estar no intervalo [-1,0, 1,0], em que 0 significa nenhum efeito. |
transparency |
O efeito de transparência da imagem. O valor precisa estar no intervalo [0,0, 1,0], em que 0 significa nenhum efeito e 1 significa transparente. |
cropProperties |
As propriedades de corte da imagem. |
angle |
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 usando 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 0, a imagem não será cortada.
Representação JSON |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
Campos | |
---|---|
offsetLeft |
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 |
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 |
O deslocamento especifica a distância entre a borda de cima do retângulo de corte e a borda de cima do conteúdo original como uma fração da altura do conteúdo original. |
offsetBottom |
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 |
O ângulo de rotação no sentido horário do retângulo de corte em torno do centro, em radianos. A rotação é aplicada depois dos deslocamentos. |
EmbeddedObjectBorder
Uma borda ao redor de um EmbeddedObject
.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
É a cor da borda. |
width |
É a largura da borda. |
dashStyle |
O estilo de traço da borda. |
propertyState |
O estado da propriedade de borda. |
PropertyState
Os estados possíveis de uma propriedade.
Tipos enumerados | |
---|---|
RENDERED |
Se o estado de uma propriedade for RENDERED, o elemento 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 externa vinculada.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união reference . A referência específica do tipo de conteúdo vinculado. reference pode ser apenas de um dos tipos a seguir: |
|
sheetsChartReference |
Uma referência ao gráfico vinculado. |
SheetsChartReference
Uma referência a um gráfico vinculado incorporado das Planilhas Google.
Representação JSON |
---|
{ "spreadsheetId": string, "chartId": integer } |
Campos | |
---|---|
spreadsheetId |
O ID da planilha Google que contém o gráfico de origem. |
chartId |
O ID do gráfico específico na planilha Google incorporada. |
SuggestedInlineObjectProperties
Uma mudança sugerida em InlineObjectProperties
.
Representação JSON |
---|
{ "inlineObjectProperties": { object ( |
Campos | |
---|---|
inlineObjectProperties |
Um |
inlineObjectPropertiesSuggestionState |
Uma máscara que indica quais campos do |
InlineObjectPropertiesSuggestionState
Uma máscara que indica quais campos do InlineObjectProperties
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Campos | |
---|---|
embeddedObjectSuggestionState |
Uma máscara que indica quais campos em |
EmbeddedObjectSuggestionState
Uma máscara que indica quais campos do EmbeddedObject
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Campos | |
---|---|
embeddedDrawingPropertiesSuggestionState |
Uma máscara que indica quais campos em |
imagePropertiesSuggestionState |
Uma máscara que indica quais campos em |
titleSuggested |
Indica se houve uma mudança sugerida em |
descriptionSuggested |
Indica se houve uma mudança sugerida em |
embeddedObjectBorderSuggestionState |
Uma máscara que indica quais campos em |
sizeSuggestionState |
Uma máscara que indica quais campos em |
marginLeftSuggested |
Indica se houve uma mudança sugerida em |
marginRightSuggested |
Indica se houve uma mudança sugerida em |
marginTopSuggested |
Indica se houve uma mudança sugerida em |
marginBottomSuggested |
Indica se houve uma mudança sugerida em |
linkedContentReferenceSuggestionState |
Uma máscara que indica quais campos em |
EmbeddedDrawingPropertiesSuggestionState
Esse tipo não tem campos.
Uma máscara que indica quais campos do EmbeddedDrawingProperties
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
ImagePropertiesSuggestionState
Uma máscara que indica quais campos do ImageProperties
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Campos | |
---|---|
contentUriSuggested |
Indica se houve uma mudança sugerida em |
sourceUriSuggested |
Indica se houve uma mudança sugerida em [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
Indica se houve uma mudança sugerida em [brilho] [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested |
Indica se houve uma mudança sugerida no [contraste] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
Indica se houve uma mudança sugerida em [transparência] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
Uma máscara que indica quais campos em |
angleSuggested |
Indica se houve uma mudança sugerida em [angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
CropPropertiesSuggestionState
Uma máscara que indica quais campos do CropProperties
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Campos | |
---|---|
offsetLeftSuggested |
Indica se houve uma mudança sugerida em |
offsetRightSuggested |
Indica se houve uma mudança sugerida em |
offsetTopSuggested |
Indica se houve uma mudança sugerida em |
offsetBottomSuggested |
Indica se houve uma mudança sugerida em |
angleSuggested |
Indica se houve uma mudança sugerida em |
EmbeddedObjectBorderSuggestionState
Uma máscara que indica quais campos do EmbeddedObjectBorder
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
Campos | |
---|---|
colorSuggested |
Indica se houve uma mudança sugerida em [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
Indica se houve uma mudança sugerida em [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
Indica se houve uma mudança sugerida em [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested |
Indica se houve uma mudança sugerida em [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
Uma máscara que indica quais campos do LinkedContentReference
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Campos | |
---|---|
sheetsChartReferenceSuggestionState |
Uma máscara que indica quais campos em |
SheetsChartReferenceSuggestionState
Uma máscara que indica quais campos do SheetsChartReference
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Campos | |
---|---|
spreadsheetIdSuggested |
Indica se houve uma mudança sugerida em |
chartIdSuggested |
Indica se houve uma mudança sugerida em |
PositionedObject
Um objeto vinculado a um 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 ( |
Campos | |
---|---|
objectId |
O ID desse objeto posicionado. |
positionedObjectProperties |
As propriedades desse objeto posicionado. |
suggestedPositionedObjectPropertiesChanges |
As mudanças sugeridas nas propriedades do objeto posicionado, com chave pelo ID da sugestão. |
suggestedInsertionId |
O ID de inserção sugerido. Se estiver vazio, não será uma inserção sugerida. |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
PositionedObjectProperties
Propriedades de um PositionedObject
.
Representação JSON |
---|
{ "positioning": { object ( |
Campos | |
---|---|
positioning |
O posicionamento desse objeto em relação à nova linha do |
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
a que está vinculado.
Representação JSON |
---|
{ "layout": enum ( |
Campos | |
---|---|
layout |
O layout do objeto posicionado. |
leftOffset |
O deslocamento da borda esquerda do objeto posicionado em relação ao início do |
topOffset |
O deslocamento da borda superior do objeto posicionado em relação ao início do |
PositionedObjectLayout
Os possíveis layouts de um [PositionedObject][google.aps.docs.v1.PositionedObject].
Tipos enumerados | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED |
O layout não foi especificado. |
WRAP_TEXT |
O texto envolve o objeto posicionado. |
BREAK_LEFT |
Quebra o texto para que o objeto posicionado fique à esquerda e o texto à direita. |
BREAK_RIGHT |
Quebra o texto para que o objeto posicionado fique à direita e o texto à esquerda. |
BREAK_LEFT_RIGHT |
Quebra o texto para 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 mudança sugerida em PositionedObjectProperties
.
Representação JSON |
---|
{ "positionedObjectProperties": { object ( |
Campos | |
---|---|
positionedObjectProperties |
Um |
positionedObjectPropertiesSuggestionState |
Uma máscara que indica quais campos do |
PositionedObjectPropertiesSuggestionState
Uma máscara que indica quais campos do PositionedObjectProperties
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{ "positioningSuggestionState": { object ( |
Campos | |
---|---|
positioningSuggestionState |
Uma máscara que indica quais campos em |
embeddedObjectSuggestionState |
Uma máscara que indica quais campos em |
PositionedObjectPositioningSuggestionState
Uma máscara que indica quais campos do PositionedObjectPositioning
de base foram alterados nesta sugestão. Para qualquer campo definido como "true", há um novo valor sugerido.
Representação JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
Campos | |
---|---|
layoutSuggested |
Indica se houve uma mudança sugerida em |
leftOffsetSuggested |
Indica se houve uma mudança sugerida em |
topOffsetSuggested |
Indica se houve uma mudança sugerida em |
SuggestionsViewMode
O modo de visualização de sugestões aplicado ao documento que indica como as mudanças sugeridas são representadas. Ele oferece opções para ler o documento com todas as sugestões inline, aceitas ou rejeitadas.
Tipos enumerados | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
O SuggestionsViewMode aplicado ao documento retornado depende do nível de acesso atual do usuário. Se o usuário tiver apenas acesso de leitura, PREVIEW_WITHOUT_SUGGESTIONS será aplicado. Caso contrário, SUGGESTIONS_INLINE será aplicado. Esse é o modo de visualização padrão das sugestões. |
SUGGESTIONS_INLINE |
O documento retornado tem sugestões inline. As mudanças sugeridas serão diferenciadas do conteúdo base no documento. As solicitações para recuperar um documento usando esse modo vão retornar um erro 403 se o usuário não tiver permissão para ver as mudanças sugeridas. |
PREVIEW_SUGGESTIONS_ACCEPTED |
O documento retornado é uma prévia com todas as mudanças sugeridas aceitas. As solicitações para recuperar um documento usando esse modo vão retornar um erro 403 se o usuário não tiver permissão para ver as mudanças sugeridas. |
PREVIEW_WITHOUT_SUGGESTIONS |
O documento retornado é uma prévia com todas as mudanças sugeridas rejeitadas, se houver alguma sugestão no documento. |
Métodos |
|
---|---|
|
Aplica uma ou mais atualizações ao documento. |
|
Cria um documento em branco usando o título fornecido na solicitação. |
|
Recebe a versão mais recente do documento especificado. |