REST Resource: documents

Recurso: Document

Um documento do Documentos Google.

Representação JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "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)
    },
    ...
  },
  "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.
tabs[]

object (Tab)

Guias que fazem parte de um documento.

As guias podem conter guias filhas, uma guia aninhada em outra. As guias filhas são representadas pelo campo Tab.childTabs.
revisionId

string

Apenas saída. O ID da 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 vai se comportar se o documento tiver sido editado desde essa revisão. Só é preenchido 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 tem a garantia de ser válido apenas por 24 horas após 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 terá sido alterado. Por outro lado, um código 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

enum (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 SUGGESTIONS_INLINE.
body

object (Body)

Apenas saída. O corpo principal do documento.

Campo legado: em vez disso, use Document.tabs.documentTab.body, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não for definido, este campo conterá informações sobre a primeira guia no documento.
headers

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

Apenas saída. Os cabeçalhos no documento, codificados por ID de cabeçalho.

Campo legado: em vez disso, use Document.tabs.documentTab.headers, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia no documento.
footers

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

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

Campo legado: em vez disso, use Document.tabs.documentTab.footers, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não for definido, este campo conterá informações sobre a primeira guia no documento.
footnotes

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

Apenas saída. As notas de rodapé no documento, com chave de ID.

Campo legado: em vez disso, use Document.tabs.documentTab.footnotes, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia no documento.
documentStyle

object (DocumentStyle)

Apenas saída. O estilo do documento.

Campo legado: em vez disso, use Document.tabs.documentTab.documentStyle, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent é definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia no documento.
suggestedDocumentStyleChanges

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

Apenas saída. As alterações sugeridas para o estilo do documento, codificadas por ID de sugestão.

Campo legado: em vez disso, use Document.tabs.documentTab.suggestedDocumentStyleChanges, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia no documento.
namedStyles

object (NamedStyles)

Apenas saída. Os estilos nomeados do documento.

Campo legado: em vez disso, use Document.tabs.documentTab.namedStyles, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia no documento.
suggestedNamedStylesChanges

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

Apenas saída. As mudanças sugeridas nos estilos nomeados do documento, com chave de ID de sugestão.

Campo legado: em vez disso, use Document.tabs.documentTab.suggestedNamedStylesChanges, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não for definido, este campo conterá informações sobre a primeira guia no documento.
lists

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

Apenas saída. As listas no documento, codificadas por ID de lista.

Campo legado: em vez disso, use Document.tabs.documentTab.lists, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia no documento.
namedRanges

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

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

Campo legado: em vez disso, use Document.tabs.documentTab.namedRanges, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia no documento.
inlineObjects

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

Apenas saída. Os objetos inline no documento, com chave de ID do objeto.

Campo legado: em vez disso, use Document.tabs.documentTab.inlineObjects, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não for definido, este campo conterá informações sobre a primeira guia no documento.
positionedObjects

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

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

Campo legado: em vez disso, use Document.tabs.documentTab.positionedObjects, que expõe o conteúdo real do documento de todas as guias quando o parâmetro includeTabsContent está definido como true. Se false ou não definido, esse campo contém informações sobre a primeira guia no documento.

Tab

Uma guia em um documento.

Representação JSON 
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
Campos
tabProperties

object (TabProperties)

As propriedades da guia, como ID e título.
childTabs[]

object (Tab)

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

object (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

string

Apenas saída. O ID da guia. Não é possível mudar esse campo.
title

string

O nome da guia visível para o usuário.
parentTabId

string

Opcional. O ID da guia pai. Vazia quando a guia atual é de nível raiz, ou seja, não tem pais.
index

integer

O índice baseado em zero da guia dentro do pai.
nestingLevel

integer

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 (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)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Campos
body

object (Body)

O corpo principal da guia do documento.
headers

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

Os cabeçalhos na guia do documento, codificados por ID de cabeçalho.
footers

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

Os rodapés na guia do documento, codificados por ID.
footnotes

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

As notas de rodapé na guia do documento, com chave de ID.
documentStyle

object (DocumentStyle)

O estilo da guia do documento.
suggestedDocumentStyleChanges

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

As mudanças sugeridas no estilo da guia do documento, com chave de ID de sugestão.
namedStyles

object (NamedStyles)

Os estilos nomeados da guia do documento.
suggestedNamedStylesChanges

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

As mudanças sugeridas nos estilos nomeados da guia do documento, com chave de ID de sugestão.
lists

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

As listas na guia "Documento", com chave de ID da lista.
namedRanges

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

Os intervalos nomeados na guia do documento, com chave de nome.
inlineObjects

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

Os objetos inline na guia do documento, com chave de ID do objeto.
positionedObjects

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

Os objetos posicionados na guia do documento, com chave de ID do objeto.

Corpo

O corpo do documento.

O corpo geralmente contém o conteúdo completo 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.

StructuralElement

Um StructuralElement descreve o conteúdo que estrutura 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 de início com base em zero deste elemento estrutural, em unidades de código UTF-16.
endIndex

integer

O índice final com base em 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

object (Paragraph)

Um tipo de parágrafo de elemento estrutural.
sectionBreak

object (SectionBreak)

Um tipo de elemento estrutural de separação de seções.
table

object (Table)

Um tipo de tabela de elemento estrutural.
tableOfContents

object (TableOfContents)

Um tipo de índice do elemento estrutural.

Parágrafo

Um StructuralElement que representa um parágrafo. Um parágrafo é um intervalo de conteúdo encerrado com 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 partes componentes.
paragraphStyle

object (ParagraphStyle)

O estilo deste parágrafo.
suggestedParagraphStyleChanges

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

O estilo do parágrafo sugerido muda para este parágrafo, com chave de ID de sugestão.
bullet

object (Bullet)

O marcador de texto 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 mudanças sugeridas no 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, com chave de ID de sugestão.

ParagraphElement

Um ParagraphElement descreve o conteúdo em um 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 baseado em zero desse elemento de parágrafo, em unidades de código UTF-16.
endIndex

integer

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

object (TextRun)

Um elemento de parágrafo de texto corrido.
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 de nota de rodapé.
horizontalRule

object (HorizontalRule)

Um elemento de parágrafo de linha horizontal.
equation

object (Equation)

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

object (InlineObjectElement)

Um elemento de parágrafo de objeto inline.
person

object (Person)

Um elemento de parágrafo que faz referência a uma pessoa ou endereço de e-mail.

TextRun

Uma ParagraphElement que representa um todo de texto 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 que não são de texto na execução são substituídos pelo caractere Unicode U+E907.
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Um TextRun pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, 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 é alterado para essa execução, codificado 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 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 do estilo de tabela.

Se o estilo de texto não for herdado de um pai, a reversão dos campos vai reverter o estilo para um valor correspondente aos padrões no editor de 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

Se o texto está ou não renderizado em negrito.
italic

boolean

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

boolean

Se o texto está sublinhado ou não.
strikethrough

boolean

Se o texto está tachado ou não.
smallCaps

boolean

Se o texto está em letras maiúsculas ou minúsculas.
backgroundColor

object (OptionalColor)

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

object (OptionalColor)

A cor do primeiro plano do texto. Se definido, a cor é 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 o peso renderizado do texto.

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

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

Se weightedFontFamily for definido, weightedFontFamily#fontFamily também precisará 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 em relação à 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 mudanças nesse campo não afetam o fontSize.

OptionalColor

Uma cor que pode ser totalmente opaca ou totalmente transparente.

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

object (Color)

Se definido, será usado como uma cor opaca. Se não for definido, isso representa uma cor transparente.

Cor

Uma cor sólida.

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

object (RgbColor)

O valor da cor RGB.

RgbColor

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.

WeightedFontFamily

Representa uma família de fontes e a espessura 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 uma do menu "Fonte" nos Documentos ou no 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 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 desativados.

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

A espessura da fonte é apenas um componente da espessura renderizada. Uma combinação de weight e o valor bold resolvido do estilo de texto determina a espessura renderizada, após contabilizar a herança:

  • Se o texto estiver em negrito e o peso for menor que 400, o peso renderizado será 400.
  • Se o texto estiver em negrito e a espessura for maior ou igual a 400, mas menor que 700, a espessura renderizada será 700.
  • Se o peso for maior ou igual a 700, o peso renderizado será igual ao peso.
  • Se o texto não estiver em negrito, o peso renderizado será igual ao peso.

BaselineOffset

As maneiras como o texto pode ser deslocado verticalmente da posição normal.

Enums
BASELINE_OFFSET_UNSPECIFIED O deslocamento da linha de base do texto é herdado do elemento pai.
NONE O texto não é deslocado verticalmente.
SUPERSCRIPT O texto é deslocado verticalmente para cima (sobrescrito).
SUBSCRIPT O texto é deslocado verticalmente para baixo (subscrito).

SuggestedTextStyle

Uma mudança sugerida em 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 saber quais campos mudaram e os novos valores deles.
textStyleSuggestionState

object (TextStyleSuggestionState)

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

TextStyleSuggestionState

Uma máscara que indica quais dos campos na TextStyle de base foram alterados nesta 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 mudança sugerida para bold.
italicSuggested

boolean

Indica se houve uma mudança sugerida para italic.
underlineSuggested

boolean

Indica se houve uma mudança sugerida para underline.
strikethroughSuggested

boolean

Indica se houve uma mudança sugerida para strikethrough.
smallCapsSuggested

boolean

Indica se houve uma mudança sugerida para smallCaps.
backgroundColorSuggested

boolean

Indica se houve uma mudança sugerida para backgroundColor.
foregroundColorSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para fontSize.
weightedFontFamilySuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para baselineOffset.

AutoText

Um ParagraphElement representando um ponto no texto que é substituído dinamicamente por conteúdo que pode mudar com o 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. Um AutoText pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, essa não será 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 desse texto automático.
suggestedTextStyleChanges

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

O estilo de texto sugerido muda para esse AutoText, codificado por ID de sugestão.

Tipo

Os tipos de texto automático.

Enums
TYPE_UNSPECIFIED Um tipo de texto automático não especificado.
PAGE_NUMBER Digite para o texto automático que representa o número da página atual.
PAGE_COUNT Digite para o 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 seguinte comece na parte de cima 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. Um PageBreak pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, essa não será 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 quebra de página.

Assim como o conteúdo de texto, como trechos de texto e referências à nota de rodapé, o estilo do texto de uma quebra de página pode afetar o layout do conteúdo e o estilo do texto inserido ao lado dela.
suggestedTextStyleChanges

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

O estilo de texto sugerido muda para esse PageBreak, com chave de ID de sugestão.

ColumnBreak

Um ParagraphElement que representa uma quebra de coluna. Uma quebra de coluna faz com que o texto seguinte comece na parte de cima 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. Um ColumnBreak pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, 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 quebra de coluna.

Assim como o conteúdo de texto, como linhas de texto e referências de notas de rodapé, o estilo de texto de um corte 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 esse elemento, com chave de ID de sugestão.

FootnoteReference

Um ParagraphElement que representa uma referência de nota de rodapé. A 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 (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Campos
footnoteId

string

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

string

O número renderizado dessa nota de rodapé.
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Um FootnoteReference pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, 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 referência de nota de rodapé.
suggestedTextStyleChanges

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

O estilo de texto sugerido muda para esta FootnoteReference, com chave de ID de sugestão.

HorizontalRule

Uma 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 poderá ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, 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 HorizontalRule.

Assim como o conteúdo de texto, como linhas de texto e referências de notas de rodapé, o estilo de texto de uma linha horizontal pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dela.
suggestedTextStyleChanges

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

O estilo de texto sugerido muda para essa regra horizontal, com chave pelo ID de sugestão.

Equação

Uma ParagraphElement que representa uma equação.

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

string

Os IDs de inserção sugeridos. Um Equation pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, essa não será 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 do InlineObject que o elemento contém.
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Um InlineObjectElement pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, 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 linhas 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, bem como o estilo do texto inserido ao lado dele.
suggestedTextStyleChanges

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

O estilo do texto sugerido muda para esse InlineObject, com chave de ID de sugestão.

Pessoa

Uma pessoa ou um endereço de e-mail mencionado em um documento. Essas menções se comportam como um elemento único e 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 das sugestões que inserem o link dessa pessoa no documento. Um Person pode ter vários IDs de inserção se for uma mudança sugerida aninhada (uma sugestão dentro de uma sugestão feita por outro usuário, por exemplo). Se estiver vazio, o link dessa pessoa não é uma inserção sugerida.
suggestedDeletionIds[]

string

IDs de sugestões que removem o link dessa pessoa do documento. Uma Person poderá ter vários IDs 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 dessa Person.
suggestedTextStyleChanges

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

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

object (PersonProperties)

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

PersonProperties

Propriedades específicas de uma Person vinculada.

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

string

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

string

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

RichLinkProperties

Propriedades específicas de um RichLink.

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

string

Apenas saída. O título do RichLink exibido no link. Esse título corresponde ao 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 para o RichLink. Isso está sempre presente.
mimeType

string

Apenas saída. O tipo MIME do RichLink, se houver um (por exemplo, quando ele 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 elemento pai de um estilo de parágrafo depende de onde ele é 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 de parágrafo não for herdado de um pai, a reversão dos campos vai reverter o estilo para um valor correspondente aos padrões no editor de documentos.

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, o parágrafo não é 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 deste 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, porque a direção do parágrafo não é herdada.
spacingMode

enum (SpacingMode)

O modo de espaçamento do 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 anteriores e seguintes. Se não for definido, o valor será herdado do pai.

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

As bordas de parágrafo não podem ser atualizadas parcialmente. Ao mudar a borda de um parágrafo, a nova borda precisa ser especificada por completo.
borderTop

object (ParagraphBorder)

A borda na parte de cima 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 de parágrafo não podem ser atualizadas parcialmente. Ao mudar a borda de um parágrafo, a nova borda precisa ser especificada por completo.
borderBottom

object (ParagraphBorder)

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

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

As bordas de parágrafo não podem ser atualizadas parcialmente. Ao mudar a borda de um parágrafo, a nova borda precisa 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 de parágrafo não podem ser atualizadas parcialmente. Ao mudar a borda de um parágrafo, a nova borda precisa 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 de parágrafos não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda precisa ser especificada integralmente.
indentFirstLine

object (Dimension)

A quantidade de recuo da 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 no lado correspondente 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 no lado 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 das paradas de tabulação deste parágrafo. A lista de tabulações não é herdada.

Esta propriedade é somente leitura.
keepLinesTogether

boolean

Se todas as linhas do parágrafo precisam 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 precisa ser disposta 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 pai.
avoidWidowAndOrphan

boolean

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

Indica se o parágrafo atual precisa sempre começar 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 sem suporte, 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.

NamedStyleType

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 pai.
START O parágrafo é alinhado ao início da linha. Alinhado à esquerda para texto LTR. Caso contrário, alinhado à direita.
CENTER O parágrafo está centralizado.
END O parágrafo é alinhado ao final da linha. Alinhado à direita para texto LTR, à esquerda para outros tipos de texto.
JUSTIFIED O parágrafo é justificado.

ContentDirection

O conteúdo das direções 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.

SpacingMode

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

Enums
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 (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.

DashStyle

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 "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 da ECMA-376 4ª edição.

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

TabStop

Uma parada de tabulação em um parágrafo.

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

object (Dimension)

O deslocamento entre esse recuo de tabulação e a margem inicial.
alignment

enum (TabStopAlignment)

O alinhamento desse ponto de tabulação. Se não for definido, o valor padrão será START.

TabStopAlignment

O alinhamento da tabulação.

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

Sombreamento

O sombreamento de um parágrafo.

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

object (OptionalColor)

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

SuggestedParagraphStyle

Uma mudança sugerida em 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 saber quais campos mudaram e os novos valores deles.
paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

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

ParagraphStyleSuggestionState

Uma máscara que indica quais 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 mudança sugerida para headingId.
namedStyleTypeSuggested

boolean

Indica se houve uma mudança sugerida para namedStyleType.
alignmentSuggested

boolean

Indica se houve uma mudança sugerida para alignment.
lineSpacingSuggested

boolean

Indica se houve uma mudança sugerida para lineSpacing.
directionSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para spacingMode.
spaceAboveSuggested

boolean

Indica se houve uma mudança sugerida para spaceAbove.
spaceBelowSuggested

boolean

Indica se houve uma mudança sugerida para spaceBelow.
borderBetweenSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para borderTop.
borderBottomSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para borderLeft.
borderRightSuggested

boolean

Indica se houve uma mudança sugerida para borderRight.
indentFirstLineSuggested

boolean

Indica se houve uma mudança 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 mudança sugerida para keepLinesTogether.
keepWithNextSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para avoidWidowAndOrphan.
shadingSuggestionState

object (ShadingSuggestionState)

Uma máscara que indica quais dos campos em 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 Shading de base foram alterados na mudança sugerida. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.

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

boolean

Indica se houve uma mudança sugerida no 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 a que 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.

SuggestedBullet

Uma mudança sugerida em 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.
bulletSuggestionState

object (BulletSuggestionState)

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

BulletSuggestionState

Uma máscara que indica quais dos campos na Bullet de base foram alterados nesta 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 mudança sugerida no listId.
nestingLevelSuggested

boolean

Indica se houve uma mudança sugerida no nestingLevel.
textStyleSuggestionState

object (TextStyleSuggestionState)

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

ObjectReferences

Uma coleção de IDs de objetos.

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

string

Os IDs dos objetos.

SectionBreak

Uma 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 de seção é aplicado à seção após a quebra.

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

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

string

Os IDs de inserção sugeridos. Um SectionBreak pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, 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 esse intervalo.

SectionStyle

O estilo aplicado 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,
  "flipPageOrientation": boolean
}
Campos
columnProperties[]

object (SectionColumnProperties)

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. Desfazer a definição dessa propriedade vai 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 houver uma coluna na seção.

Ao atualizar essa propriedade, é necessário definir um valor concreto. Desfazer a definição dessa 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 essa propriedade, é necessário definir um valor concreto. Desfazer a definição dessa propriedade resulta em um erro 400 de solicitação inválida.
marginTop

object (Dimension)

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

Ao atualizar essa propriedade, é necessário definir um valor concreto. Desfazer a definição dessa propriedade resulta em um erro 400 de solicitação inválida.
marginBottom

object (Dimension)

Margem inferior da página da seção. Se não for definido, o valor padrão será marginBottom do DocumentStyle.

Ao atualizar essa propriedade, é necessário definir um valor concreto. Desfazer a definição dessa propriedade resulta em um erro 400 de solicitação inválida.
marginRight

object (Dimension)

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

Ao atualizar essa propriedade, é necessário definir um valor concreto. Desfazer a definição dessa propriedade resulta em um erro 400 de solicitação inválida.
marginLeft

object (Dimension)

Margem esquerda da página da seção. Se não for definido, o valor padrão será marginLeft do DocumentStyle. Atualizar a margem esquerda faz com que as colunas nesta seção sejam redimensionadas. Como a margem afeta a largura da coluna, ela é aplicada antes das propriedades da coluna.

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

object (Dimension)

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

Ao atualizar essa 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 herda o SectionStyle SectionBreak's anterior. Se o valor não for definido na primeira SectionBreak, ele vai herdar o 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 vai usar o defaultHeaderId. Se não for definido, o valor herda o SectionStyle SectionBreak's anterior. Se o valor não for definido na primeira SectionBreak, ele vai herdar o firstPageHeaderId do DocumentStyle.

Esta propriedade é somente leitura.
firstPageFooterId

string

O ID do rodapé usado apenas para a primeira página da seção. Se useFirstPageHeaderFooter for verdadeiro, esse valor será usado para o rodapé na primeira página da seção. Se for falso, o rodapé na primeira página da seção vai usar o defaultFooterId. Se não for definido, o valor será herdado do sectionStyle SectionBreak's anterior. Se o valor não for definido na primeira SectionBreak, ele vai herdar o firstPageFooterId 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, esse valor será usado para os cabeçalhos nas páginas pares da seção. Se for falso, os cabeçalhos nas páginas pares vão usar o defaultHeaderId. Se não for definido, o valor herda o SectionStyle SectionBreak's anterior. Se o valor não for definido na primeira SeçãoBreak, ele será herdado do evenPageHeaderId do DocumentStyle.

Esta propriedade é somente leitura.
evenPageFooterId

string

O ID do rodapé usado apenas para páginas pares. Se o valor de useEvenPageHeaderFooter do DocumentStyle for verdadeiro, esse valor será usado para os rodapés nas páginas pares da seção. Se for falso, os rodapés em páginas pares vão usar o defaultFooterId. Se não for definido, o valor herda o SectionStyle SectionBreak's anterior. Se o valor não for definido na primeira SectionBreak, ele vai herdar o evenPageFooterId do DocumentStyle.

Esta propriedade é somente leitura.
useFirstPageHeaderFooter

boolean

Indica se os IDs de cabeçalho / rodapé da primeira página devem ser usados para a primeira página da seção. Se não for definido, ele herda o useFirstPageHeaderFooter do DocumentStyle para a primeira seção. Se o valor não for definido para setores subsequentes, ele será interpretado como falso.

Ao atualizar essa propriedade, é necessário definir um valor concreto. Desfazer a definição dessa propriedade resulta em um erro 400 de solicitação inválida.
pageNumberStart

integer

O número da página a partir do qual começar a contagem do número de páginas dessa seção. Se não for definido, a numeração de páginas continua da seção anterior. Se o valor não estiver definido na primeira SectionBreak, consulte a pageNumberStart do DocumentStyle.

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

boolean

Opcional. Indica se as dimensões de pageSize do DocumentStyle serão invertidas para essa seção, o que permite mudar a orientação da página entre retrato e paisagem. Se não for definido, o valor herda o flipPageOrientation do DocumentStyle.

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

SectionColumnProperties

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 de separadores de coluna entre as colunas.

Enums
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 de separação 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.

Uma tabela pode não ser retangular, então algumas linhas podem ter um número diferente de células.
tableRows[]

object (TableRow)

O conteúdo e o estilo de cada linha.
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Um Table pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, 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 um 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 de início baseado em zero desta linha, em unidades de código UTF-16.
endIndex

integer

O índice final com base em zero desta linha, 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 uma tabela não seja retangular. Por isso, algumas linhas podem ter um número diferente de células em relação a outras linhas na mesma tabela.
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Uma TableRow poderá ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, 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, com chave de ID de 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 de início baseado em zero dessa célula, em unidades de código UTF-16.
endIndex

integer

O índice final baseado em zero desta 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. Um TableCell pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, essa não será 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 por ID de sugestão.

TableCellStyle

O estilo de uma TableCell.

Os estilos de célula de tabela herdados são representados como campos não definidos nesta mensagem. Um estilo de célula de tabela pode herdar o 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 intervalo de linhas da célula.

Esta propriedade é somente leitura.
columnSpan

integer

A extensão da coluna da célula.

Esta propriedade é somente leitura.
backgroundColor

object (OptionalColor)

A cor 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 da parte de baixo da célula.
contentAlignment

enum (ContentAlignment)

O alinhamento do conteúdo na célula da tabela. O alinhamento padrão corresponde ao alinhamento das células de 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 a borda de uma 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.

Essa cor não pode ser transparente.
width

object (Dimension)

A largura da borda.
dashStyle

enum (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.59 de "Office Open XML File Formats - Fundamentals and Markup Language Reference", parte 1 da ECMA-376 4ª edição.

Enums
CONTENT_ALIGNMENT_UNSPECIFIED Um alinhamento de conteúdo não especificado. O alinhamento do conteúdo é herdado do pai, se existir.
CONTENT_ALIGNMENT_UNSUPPORTED Um alinhamento de conteúdo não aceito.
TOP Alinha o conteúdo à parte de cima do suporte. Corresponde a "t" do ECMA-376 ST_TextAnchoringType.
MIDDLE Alinha o conteúdo ao centro do suporte. Corresponde a ECMA-376 ST_TextAnchoringType "ctr".
BOTTOM Alinha o conteúdo à parte de baixo do suporte. Corresponde a ECMA-376 ST_TextAnchoringType 'b'.

SuggestedTableCellStyle

Uma mudança sugerida em 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 saber quais campos mudaram e os novos valores deles.
tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

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

TableCellStyleSuggestionState

Uma máscara que indica quais dos campos na TableCellStyle de base foram alterados nesta 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 mudança sugerida para rowSpan.
columnSpanSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para backgroundColor.
borderLeftSuggested

boolean

Indica se houve uma mudança sugerida para borderLeft.
borderRightSuggested

boolean

Indica se houve uma mudança sugerida para borderRight.
borderTopSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para borderBottom.
paddingLeftSuggested

boolean

Indica se houve uma mudança sugerida para paddingLeft.
paddingRightSuggested

boolean

Indica se houve uma mudança sugerida para paddingRight.
paddingTopSuggested

boolean

Indica se houve uma mudança sugerida para paddingTop.
paddingBottomSuggested

boolean

Indica se houve uma mudança sugerida para paddingBottom.
contentAlignmentSuggested

boolean

Indica se houve uma mudança sugerida para contentAlignment.

TableRowStyle

Estilos aplicados a uma linha de 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 mostrar 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 transbordar os limites da página ou da coluna.

SuggestedTableRowStyle

Uma mudança sugerida em 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.
tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

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

TableRowStyleSuggestionState

Uma máscara que indica quais dos campos na TableRowStyle de base foram alterados nesta 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 mudança sugerida para minRowHeight.

TableStyle

Estilos aplicados a uma tabela.

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

object (TableColumnProperties)

As propriedades de cada coluna.

Nos Documentos, as tabelas contêm linhas, e as linhas contêm células, semelhante ao HTML. Portanto, as propriedades de uma linha podem ser encontradas na tableRowStyle dela.

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. Defina quando o widthType da coluna for FIXED_WIDTH.

WidthType

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 distribuídas de maneira uniforme.

A largura da coluna é determinada automaticamente e terá uma parte igual da largura restante da tabela depois de considerar todas as colunas com larguras especificadas.
FIXED_WIDTH Uma largura de coluna fixa. A propriedade [largura][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 (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Campos
content[]

object (StructuralElement)

O conteúdo do sumário.
suggestedInsertionIds[]

string

Os IDs de inserção sugeridos. Um TableOfContents pode ter vários IDs de inserção se for uma mudança sugerida aninhada. Se estiver vazio, essa não será 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,
  "flipPageOrientation": boolean
}
Campos
background

object (Background)

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

string

O ID do cabeçalho padrão. Se ela não for definida, não haverá um 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 este valor será usado para o cabeçalho em páginas pares. Se ela for deixada sem definição, não haverá um cabeçalho de página par.

Esta propriedade é somente leitura.
evenPageFooterId

string

O ID do rodapé usado apenas para páginas pares. O valor de useEvenPageHeaderFooter determina se é necessário usar o defaultFooterId ou esse valor para o rodapé em páginas pares. Se não for definido, não haverá um rodapé de página par.

Esta propriedade é somente leitura.
firstPageHeaderId

string

O ID do cabeçalho usado apenas para a primeira página. Se não for definido, não existirá um cabeçalho exclusivo para a primeira página. O valor de useFirstPageHeaderFooter determina se o defaultHeaderId ou este valor será usado para o cabeçalho na primeira página. Se ela for deixada sem definição, não haverá um cabeçalho na primeira página.

Esta propriedade é somente leitura.
firstPageFooterId

string

O ID do rodapé usado apenas para a primeira página. Se não for definido, um rodapé exclusivo para a primeira página não vai existir. O valor de useFirstPageHeaderFooter determina se o defaultFooterId ou este valor será usado para o rodapé na primeira página. Se não for definido, não haverá rodapé na primeira página.

Esta propriedade é somente leitura.
useFirstPageHeaderFooter

boolean

Indica se os IDs de cabeçalho / rodapé da primeira página devem ser usados para a primeira página.
useEvenPageHeaderFooter

boolean

Indica se os IDs de cabeçalho / rodapé de páginas pares devem ser usados para as páginas pares.
pageNumberStart

integer

O número da página a partir do qual começar a contagem.
marginTop

object (Dimension)

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

object (Dimension)

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

object (Dimension)

Margem direita da página.

Atualizar a margem direita da página no estilo do documento limpa a margem direita da página 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)

Margem esquerda da página.

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

object (Size)

O tamanho de uma página no documento.
marginHeader

object (Dimension)

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

boolean

Opcional. Indica se as dimensões do pageSize serão invertidas, o que permite mudar a orientação da página entre retrato e paisagem.

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

Indica a largura e a 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.

SuggestedDocumentStyle

Uma mudança sugerida no 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 saber quais campos mudaram e os novos valores deles.
documentStyleSuggestionState

object (DocumentStyleSuggestionState)

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

DocumentStyleSuggestionState

Uma máscara que indica quais dos campos na DocumentStyle de base foram alterados nesta 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,
  "flipPageOrientationSuggested": boolean
}
Campos
backgroundSuggestionState

object (BackgroundSuggestionState)

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

boolean

Indica se houve uma mudança sugerida para defaultHeaderId.
evenPageHeaderIdSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para evenPageFooterId.
firstPageHeaderIdSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para firstPageFooterId.
useFirstPageHeaderFooterSuggested

boolean

Indica se houve uma alteração sugerida para useFirstPageHeaderFooter.
useEvenPageHeaderFooterSuggested

boolean

Indica se houve uma mudança sugerida para useEvenPageHeaderFooter.
pageNumberStartSuggested

boolean

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

boolean

Indica se houve uma mudança sugerida para marginTop.
marginBottomSuggested

boolean

Indica se houve uma mudança sugerida para marginBottom.
marginRightSuggested

boolean

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

boolean

Indica se houve uma mudança 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 mudança sugerida para marginHeader.
flipPageOrientationSuggested

boolean

Opcional. Indica se houve uma alteração sugerida para flipPageOrientation.

BackgroundSuggestionState

Uma máscara que indica quais dos campos na Background de base foram alterados nesta 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 de plano de fundo atual foi modificada nesta sugestão.

SizeSuggestionState

Uma máscara que indica quais dos campos na Size de base foram alterados nesta 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 mudança sugerida para height.
widthSuggested

boolean

Indica se houve uma mudança sugerida para width.

NamedStyles

Os estilos nomeados. Os parágrafos no 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 um dos named style types possíveis.

NamedStyle

Um estilo com nome. 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.

SuggestedNamedStyles

Uma mudança sugerida no 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.
namedStylesSuggestionState

object (NamedStylesSuggestionState)

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

NamedStylesSuggestionState

O estado da sugestão de uma mensagem NamedStyles.

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

object (NamedStyleSuggestionState)

Uma máscara que indica quais campos no NamedStyle correspondente em styles foram mudados 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 esse estado de sugestão corresponde.

Esse campo é fornecido para facilitar a correspondência de NamedStyleSuggestionState com o NamedStyle correspondente.
textStyleSuggestionState

object (TextStyleSuggestionState)

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

object (ParagraphStyleSuggestionState)

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

Lista

Uma lista representa os atributos de 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 no 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 mudanças sugeridas para as propriedades da lista, codificadas por ID de sugestão.
suggestedInsertionId

string

O ID de inserção sugerido. Se estiver vazio, não é uma inserção sugerida.
suggestedDeletionIds[]

string

Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusões para essa 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 (NestingLevel)
    }
  ]
}
Campos
nestingLevels[]

object (NestingLevel)

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 correspondente ao nível superior e o nível 8 correspondente ao nível mais aninhado. Os níveis de aninhamento são retornados em ordem crescente, com o menos aninhado 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 (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 no espaço alocado para renderizar o marcador.
glyphFormat

string

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

O formato de glifo contém um ou mais marcadores de posição, que são substituídos pelos valores apropriados, dependendo do glyphType ou do glyphSymbol. Os marcadores de posição seguem o padrão %[nestingLevel]. Além disso, os marcadores de posição 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 vai substituir o marcador pelo glifo correspondente para o nível de aninhamento 0, seguido por um ponto como sufixo. Portanto, uma lista com um tipo de glifo UPPER_ALPHA e um 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 para o nível de aninhamento atual, bem como marcadores para níveis de aninhamento pai. 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 nível de aninhamento 1. Supondo que os dois níveis de aninhamento tenham tipos de glifo DECIMAL, isso resultaria em uma lista com glifos renderizados.

1.

2.

2.1.

2.2.

3.

Para níveis aninhados ordenados, a string que substitui um marcador de posição 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 de parágrafos nesse 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 do 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 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 de 0 e 1, as listas de letras e algarismos romanos começam em a e i, respectivamente.

Esse valor é ignorado para níveis aninhados 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

enum (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 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 vai substituir o marcador de posição %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 nesse nível de aninhamento não são ordenados.

O símbolo do glifo substitui os marcadores de posição no glyphFormat. Por exemplo, se o glyphSymbol for o círculo sólido correspondente ao ponto de código Unicode U+25cf e o glyphFormat for %0, o glifo renderizado será o círculo sólido.

BulletAlignment

Os tipos de alinhamento para 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 renderizar o marcador. Alinhar à esquerda para texto LTR, à direita para outros tipos de texto.
CENTER O marcador é alinhado ao centro do espaço alocado para renderização.
END O marcador é alinhado ao final do espaço alocado para renderização. Alinhado à direita para texto LTR, à esquerda para outros tipos de texto.

GlyphType

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

Enums
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 dígitos são prefixados com um zero, como 01, 02 ou 03. Números com mais de um dígito não são prefixados com 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 número romano minúsculo, como i, ii ou iii.

SuggestedListProperties

Uma mudança 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.
listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

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

ListPropertiesSuggestionState

Uma máscara que indica quais dos campos na ListProperties de base foram alterados nesta 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 dos campos na NestingLevel correspondente em nestingLevels foram alterados nesta sugestão.

Os estados de sugestão do 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 NestingLevel de base foram alterados nesta 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 mudança sugerida para bulletAlignment.
glyphTypeSuggested

boolean

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

boolean

Indica se houve uma mudança 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 mudança sugerida para indentStart.
textStyleSuggestionState

object (TextStyleSuggestionState)

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

boolean

Indica se houve uma mudança sugerida para startNumber.

NamedRanges

Uma coleção de todos os 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.

NamedRange

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 rótulo arbitrário definido pelo usuário para que o conteúdo possa ser lido ou editado mais tarde de forma programática. 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 em um intervalo nomeado geralmente expande esse intervalo. No entanto, algumas mudanças no documento 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 os 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 este intervalo nomeado.

Intervalo

Especifica um intervalo contíguo de texto.

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

string

O ID do cabeçalho, rodapé ou nota de rodapé em que o intervalo está contido. Um ID de segmento vazio significa o corpo do documento.
startIndex

integer

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

integer

O índice final com base em zero deste 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 casos de uso futuros com intervalos abertos.
tabId

string

A guia que contém esse intervalo. Se omitido, o pedido é aplicado à primeira guia.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a solicitação se aplica à guia única.

Em um documento com várias guias:

  • Se fornecido, a solicitação se aplica à guia especificada.

  • Se omitido, a solicitação se aplica à primeira guia do documento.

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 (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Campos
objectId

string

O ID desse objeto inline. Pode ser usado para atualizar as propriedades de um objeto.
inlineObjectProperties

object (InlineObjectProperties)

As propriedades desse objeto inline.
suggestedInlineObjectPropertiesChanges

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

As mudanças sugeridas nas propriedades do objeto inline, com chave pelo ID da sugestão.
suggestedInsertionId

string

O ID de inserção sugerido. Se estiver vazio, 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.

InlineObjectProperties

Propriedades de um InlineObject.

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

object (EmbeddedObject)

O objeto incorporado a esse objeto inline.

EmbeddedObject

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. O title e o description são combinados para mostrar o texto alternativo.
description

string

A descrição do objeto incorporado. O title e o description são combinados para mostrar 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)

Margem inferior do objeto incorporado.
marginRight

object (Dimension)

Margem direita do objeto incorporado.
marginLeft

object (Dimension)

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 de origem das Planilhas Google quando o objeto incorporado é 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

Esse tipo não tem campos.

As propriedades de um desenho incorporado e usadas para diferenciar o tipo de objeto. Um desenho incorporado é aquele que é criado e editado em um documento. Não é possível incluir muitos detalhes.

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 um tempo 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

string

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 precisa estar no intervalo [-1,0, 1,0], em que 0 significa nenhum efeito.
contrast

number

O efeito de contraste da imagem. O valor precisa estar no intervalo [-1,0, 1,0], em que 0 significa nenhum efeito.
transparency

number

O efeito de transparência da imagem. O valor deve estar no intervalo [0,0, 1,0], em que 0 significa nenhum 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 de limite original da imagem.
  • Se todos os deslocamentos e o ângulo 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

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 da borda direita do retângulo de corte em relação à 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 em torno do centro, em radianos. A rotação é aplicada após os deslocamentos.

EmbeddedObjectBorder

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.

PropertyState

Os estados possíveis de uma propriedade.

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

SheetsChartReference

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

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

string

O ID da planilha do Google Planilhas que contém o gráfico de origem.
chartId

integer

O ID do gráfico específico na planilha do Planilhas Google incorporado.

SuggestedInlineObjectProperties

Uma mudança 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 saber quais campos mudaram e os novos valores deles.
inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

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

InlineObjectPropertiesSuggestionState

Uma máscara que indica quais 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 em embeddedObject foram alterados nessa sugestão.

EmbeddedObjectSuggestionState

Uma máscara que indica quais 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 dos campos em embeddedDrawingProperties foram alterados nesta sugestão.
imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

Uma máscara que indica quais dos campos em 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 dos campos em embeddedObjectBorder foram alterados nesta sugestão.
sizeSuggestionState

object (SizeSuggestionState)

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

boolean

Indica se houve uma mudança sugerida para marginLeft.
marginRightSuggested

boolean

Indica se houve uma mudança sugerida para marginRight.
marginTopSuggested

boolean

Indica se houve uma mudança sugerida para marginTop.
marginBottomSuggested

boolean

Indica se houve uma mudança sugerida para marginBottom.
linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

Uma máscara que indica quais campos em linkedContentReference foram alterados nessa sugestão.

EmbeddedDrawingPropertiesSuggestionState

Esse tipo não tem campos.

Uma máscara que indica quais 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 ImageProperties de base foram alterados nesta 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 mudança sugerida para contentUri.
sourceUriSuggested

boolean

Indica se houve uma mudança sugerida em [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].
brightnessSuggested

boolean

Indica se houve uma mudança sugerida em [brightness] [google.apps.docs.v1.EmbeddedObject.brightness].
contrastSuggested

boolean

Indica se houve uma mudança sugerida em [contrast] [google.apps.docs.v1.EmbeddedObject.contrast].
transparencySuggested

boolean

Indica se houve uma mudança sugerida em [transparency] [google.apps.docs.v1.EmbeddedObject.transparency].
cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

Uma máscara que indica quais dos campos em 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 CropProperties de base foram alterados nesta 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 mudança sugerida para offsetLeft.
offsetRightSuggested

boolean

Indica se houve uma mudança sugerida para offsetRight.
offsetTopSuggested

boolean

Indica se houve uma mudança sugerida para offsetTop.
offsetBottomSuggested

boolean

Indica se houve uma mudança sugerida para offsetBottom.
angleSuggested

boolean

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

EmbeddedObjectBorderSuggestionState

Uma máscara que indica quais 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 mudança sugerida em [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 mudança sugerida em [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 LinkedContentReference de base foram alterados nesta 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 dos campos em sheetsChartReference foram alterados nesta sugestão.

SheetsChartReferenceSuggestionState

Uma máscara que indica quais 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 mudança sugerida para spreadsheetId.
chartIdSuggested

boolean

Indica se houve uma mudança sugerida para chartId.

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 (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Campos
objectId

string

O ID desse objeto posicionado.
positionedObjectProperties

object (PositionedObjectProperties)

As propriedades desse objeto posicionado.
suggestedPositionedObjectPropertiesChanges

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

As mudanças sugeridas nas propriedades do objeto posicionado, com chave pelo ID da sugestão.
suggestedInsertionId

string

O ID de inserção sugerido. Se estiver vazio, essa não será 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 um PositionedObject.

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

object (PositionedObjectPositioning)

O posicionamento desse objeto em relação ao novo parágrafo do 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 desse 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. A posição exata do objeto pode depender de outros conteúdos no documento e do estilo dele.
topOffset

object (Dimension)

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

PositionedObjectLayout

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 é agrupado em torno do objeto posicionado.
BREAK_LEFT Quebra o texto de modo que o objeto posicionado fique à esquerda e o texto à direita.
BREAK_RIGHT Interrompe o texto de modo 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 fica atrás do texto.

SuggestedPositionedObjectProperties

Uma mudança 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 saber quais campos mudaram e os novos valores deles.
positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

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

PositionedObjectPropertiesSuggestionState

Uma máscara que indica quais dos campos na PositionedObjectProperties de base foram alterados nesta 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 em positioning foram alterados nessa sugestão.
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

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

PositionedObjectPositioningSuggestionState

Uma máscara que indica quais dos campos na PositionedObjectPositioning de base foram alterados nesta 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.

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.

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 tiver apenas acesso de leitura, PREVIEW_WITHOUT_SUGGESTIONS será aplicado. Caso contrário, SUGGESTIONS_INLINE será aplicado. Esse é 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 esse modo vão retornar um erro 403 se o usuário não tiver permissão para visualizar as mudanças sugeridas.
PREVIEW_SUGGESTIONS_ACCEPTED

O documento retornado é uma visualização 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 visualizar as mudanças sugeridas.
PREVIEW_WITHOUT_SUGGESTIONS O documento retornado é uma visualização com todas as mudanças sugeridas rejeitadas, se houver alguma.

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

 Recebe a versão mais recente do documento especificado.