- Recurso: Document
- Guia
- TabProperties
- DocumentTab
- Body
- StructuralElement
- Paragraph
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- Color
- RgbColor
- Dimensão
- Unidade
- WeightedFontFamily
- BaselineOffset
- Link
- BookmarkLink
- HeadingLink
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- Tipo
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- Equação
- InlineObjectElement
- Pessoa
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- Alinhamento
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- Sombra
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Marcador
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- Table
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- Cabeçalho
- Rodapé
- Nota de rodapé
- DocumentStyle
- Contexto
- Tamanho
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Lista
- ListProperties
- NestingLevel
- BulletAlignment
- GlyphType
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- Intervalo
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- Métodos
Recurso: Document
Um documento do Google Docs.
Representação JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
Campos | |
---|---|
documentId |
Apenas saída. O ID do documento. |
title |
O título do documento. |
tabs[] |
Guias que fazem parte de um documento. As guias podem conter guias secundárias, que são aninhadas dentro de outra. As guias filhas são representadas pelo campo |
revisionId |
Apenas saída. O ID da revisão do documento. Pode ser usado em solicitações de atualização para especificar a qual revisão de um documento aplicar atualizações e como a solicitação deverá 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. O ID de revisão retornado só é válido por 24 horas após o retorno e não pode ser compartilhado entre usuários. Se o ID da revisão não mudar entre as chamadas, o documento não 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 |
Apenas saída. O modo de visualização de sugestões aplicado ao documento. Observação: quando você edita um documento, as alterações precisam ser feitas com base em um documento com |
body |
Apenas saída. O corpo principal do documento. Campo legado: em vez disso, use |
headers |
Apenas saída. Os cabeçalhos no documento, codificados por ID do cabeçalho. Campo legado: em vez disso, use |
footers |
Apenas saída. Os rodapés no documento, codificados pelo ID do rodapé. Campo legado: em vez disso, use |
footnotes |
Apenas saída. As notas de rodapé no documento, codificadas por ID da nota de rodapé. Campo legado: em vez disso, use |
documentStyle |
Apenas saída. O estilo do documento. Campo legado: em vez disso, use |
suggestedDocumentStyleChanges |
Apenas saída. As mudanças sugeridas no estilo do documento, com chave de ID de sugestão. Campo legado: em vez disso, use |
namedStyles |
Apenas saída. Os estilos nomeados do documento. Campo legado: em vez disso, use |
suggestedNamedStylesChanges |
Apenas saída. As mudanças sugeridas nos estilos nomeados do documento, com chave de ID de sugestão. Campo legado: em vez disso, use |
lists |
Apenas saída. As listas no documento, codificadas por ID da lista. Campo legado: em vez disso, use |
namedRanges |
Apenas saída. Os intervalos nomeados no documento, codificados por nome. Campo legado: em vez disso, use |
inlineObjects |
Apenas saída. Os objetos inline no documento, com chave de ID do objeto. Campo legado: em vez disso, use |
positionedObjects |
Apenas saída. Os objetos posicionados no documento, codificados pelo ID do objeto. Campo legado: em vez disso, use |
Tab
Uma guia em um documento.
Representação JSON |
---|
{ "tabProperties": { object ( |
Campos | |
---|---|
tabProperties |
As propriedades da guia, como ID e título. |
childTabs[] |
As guias filhas aninhadas nessa guia. |
Campo de união content . O conteúdo da guia. content pode ser apenas de um dos tipos a seguir: |
|
documentTab |
Uma guia com o conteúdo do documento, como texto e imagens. |
TabProperties
Propriedades de uma guia.
Representação JSON |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
Campos | |
---|---|
tabId |
Apenas saída. O ID da guia. Não é possível alterar esse campo. |
title |
O nome da guia visível para o usuário. |
parentTabId |
Opcional. O ID da guia principal. Vazia quando a guia atual é de nível raiz, ou seja, não tem pais. |
index |
O índice baseado em zero da guia dentro do pai. |
nestingLevel |
Apenas saída. A profundidade da guia no documento. As guias no nível raiz começam em 0. |
DocumentTab
Uma guia com o conteúdo do documento.
Representação JSON |
---|
{ "body": { object ( |
Campos | |
---|---|
body |
O corpo principal da guia do documento. |
headers |
Os cabeçalhos na guia do documento, codificados por ID de cabeçalho. |
footers |
Os rodapés na guia do documento, codificados pelo ID do rodapé. |
footnotes |
As notas de rodapé na guia do documento, codificadas por ID da nota de rodapé. |
documentStyle |
O estilo da guia do documento. |
suggestedDocumentStyleChanges |
As alterações sugeridas para o estilo da guia do documento, codificadas por ID de sugestão. |
namedStyles |
Os estilos nomeados da guia do documento. |
suggestedNamedStylesChanges |
As alterações sugeridas para os estilos nomeados da guia do documento, codificadas por ID de sugestão. |
lists |
As listas na guia "Documento", com chave de ID da lista. |
namedRanges |
Os intervalos nomeados na guia do documento, codificados por nome. |
inlineObjects |
Os objetos inline na guia do documento, codificados por ID do objeto. |
positionedObjects |
Os objetos posicionados na guia do documento, codificados pelo 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 ( |
Campos | |
---|---|
content[] |
O conteúdo do corpo. Os índices para o conteúdo do corpo começam em zero. |
StructuralElement
Um StructuralElement descreve o conteúdo que fornece estrutura ao documento.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
O índice inicial baseado em zero desse elemento estrutural, em unidades de código UTF-16. |
endIndex |
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 |
Um tipo de parágrafo de elemento estrutural. |
sectionBreak |
Um tipo de quebra de seção de elemento estrutural. |
table |
Um tipo de tabela de elemento estrutural. |
tableOfContents |
Um tipo de índice do elemento estrutural. |
Parágrafo
Uma 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 ( |
Campos | |
---|---|
elements[] |
O conteúdo do parágrafo, dividido nas partes componentes. |
paragraphStyle |
O estilo deste parágrafo. |
suggestedParagraphStyleChanges |
O estilo do parágrafo sugerido muda para este parágrafo, com chave de ID de sugestão. |
bullet |
O marcador de texto para este parágrafo. Se não estiver presente, o parágrafo não pertence a uma lista. |
suggestedBulletChanges |
As mudanças sugeridas no marcador deste parágrafo. |
positionedObjectIds[] |
Os IDs dos objetos posicionados vinculados a esse parágrafo. |
suggestedPositionedObjectIds |
Os IDs dos objetos posicionados sugeridos para serem anexados a este parágrafo, codificados por ID de sugestão. |
ParagraphElement
Um ParagraphElement descreve o conteúdo em um Paragraph
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
O índice inicial baseado em zero desse elemento de parágrafo, em unidades de código UTF-16. |
endIndex |
O índice final de base zero desse elemento de parágrafo, exclusivo, em unidades de código UTF-16. |
Campo de união content . O conteúdo do elemento de parágrafo. content pode ser apenas de um dos tipos a seguir: |
|
textRun |
Um elemento de parágrafo de texto corrido. |
autoText |
Um elemento de parágrafo de texto automático. |
pageBreak |
Um elemento de parágrafo de quebra de página. |
columnBreak |
Um elemento de parágrafo de quebra de coluna. |
footnoteReference |
Um elemento de parágrafo de referência de nota de rodapé. |
horizontalRule |
Um elemento de parágrafo de linha horizontal. |
equation |
Um elemento de parágrafo de equação. |
inlineObjectElement |
Um elemento de parágrafo de objeto inline. |
person |
Um elemento de parágrafo que vincula a uma pessoa ou a um endereço de e-mail. |
richLink |
Um elemento de parágrafo que vincula a um recurso do Google, como um arquivo no Google Drive, um vídeo do YouTube ou um evento da Agenda. |
TextRun
Um ParagraphElement
que representa uma sequência de texto com o mesmo estilo.
Representação JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
content |
O texto dessa execução. Todos os elementos não textuais na execução são substituídos pelo caractere Unicode U+E907. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
textStyle |
O estilo de texto desta execução. |
suggestedTextStyleChanges |
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 pai de um estilo de texto depende de onde o estilo está definido:
- O TextStyle do texto em uma
Paragraph
é herdado donamed style type
correspondente do parágrafo. - O TextStyle em uma
named style
é herdado do estilo nomeadonormal text
. - O TextStyle do estilo nomeado
normal text
é herdado do estilo de texto padrão no Editor de arquivos Google. - O TextStyle em um elemento
Paragraph
contido em uma tabela pode herdar o estilo de texto do estilo da tabela.
Se o estilo de texto não for herdado de um elemento pai, desfazer a configuração dos campos reverterá o estilo para um valor correspondente aos padrões no editor do Documentos.
Representação JSON |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
Campos | |
---|---|
bold |
Se o texto está ou não renderizado em negrito. |
italic |
Se o texto está em itálico ou não. |
underline |
Se o texto está sublinhado ou não. |
strikethrough |
Se o texto está tachado ou não. |
smallCaps |
Se o texto está ou não em letras maiúsculas minúsculas. |
backgroundColor |
A cor de fundo do texto. Se definida, a cor será RGB ou transparente, dependendo do campo |
foregroundColor |
A cor do primeiro plano do texto. Se definida, a cor será RGB ou transparente, dependendo do campo |
fontSize |
O tamanho da fonte do texto. |
weightedFontFamily |
A família de fontes e o peso renderizado do texto. Se uma solicitação de atualização especificar valores para Se Se |
baselineOffset |
O deslocamento vertical do texto em relação à posição normal. O texto com deslocamentos de valor de referência |
link |
O destino do hiperlink do texto. Se ela for deixada sem definição, não haverá link. Os links não são herdados do texto pai. Mudar o link em uma solicitação de atualização causa outras mudanças no estilo de texto do intervalo:
|
OptionalColor
Uma cor que pode ser totalmente opaca ou totalmente transparente.
Representação JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Se definido, será usado como uma cor opaca. Se não for definido, isso representa uma cor transparente. |
Cor
Uma cor sólida.
Representação JSON |
---|
{
"rgbColor": {
object ( |
Campos | |
---|---|
rgbColor |
O valor de cor RGB. |
RgbColor
Uma cor RGB.
Representação JSON |
---|
{ "red": number, "green": number, "blue": number } |
Campos | |
---|---|
red |
O componente vermelho da cor, de 0,0 a 1,0. |
green |
O componente verde da cor, de 0,0 a 1,0. |
blue |
O componente azul da cor, de 0,0 a 1,0. |
Dimensão
Uma magnitude em uma única direção nas unidades especificadas.
Representação JSON |
---|
{
"magnitude": number,
"unit": enum ( |
Campos | |
---|---|
magnitude |
A magnitude. |
unit |
As unidades de magnitude. |
Unidade
Unidades de medida.
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 |
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 |
weight |
A espessura da fonte. Esse campo pode ter qualquer valor que seja um múltiplo de O valor padrão é A espessura da fonte compõe apenas um componente da espessura da fonte renderizada. Uma combinação de
|
BaselineOffset
As maneiras pelas quais o texto pode ser deslocado verticalmente da sua posição normal.
Enums | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
O deslocamento do valor de referência do texto é herdado do pai. |
NONE |
O texto não está deslocado verticalmente. |
SUPERSCRIPT |
O texto é deslocado verticalmente para cima (sobrescrito). |
SUBSCRIPT |
O texto é deslocado verticalmente para baixo (subscrito). |
Link
Uma referência a outra parte de um documento ou a um recurso de URL externo.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união destination . O destino do link. destination pode ser apenas de um dos tipos a seguir: |
|
url |
Um URL externo. |
tabId |
O ID de uma guia neste documento. |
bookmark |
Um marcador neste documento. Em documentos com uma única guia, os links para favoritos nessa guia continuam retornando |
heading |
Um título neste documento. Em documentos com uma única guia, os links para títulos nessa guia continuam a retornar |
bookmarkId |
O ID de um favorito no documento. Campo legado: em vez disso, defina Se esse campo for usado em uma solicitação de gravação, a marcação será considerada do ID da guia especificado na solicitação. Se um ID de guia não for especificado na solicitação, ele será considerado da primeira guia no documento. |
headingId |
O ID de um título neste documento. Campo legado: em vez disso, defina Se esse campo for usado em uma solicitação de gravação, o cabeçalho será considerado do ID da guia especificado na solicitação. Se um ID de guia não for especificado na solicitação, ele será considerado da primeira guia no documento. |
BookmarkLink
Uma referência a um favorito neste documento.
Representação JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
O ID de um favorito no documento. |
tabId |
O ID da guia que contém essa marcação. |
HeadingLink
Uma referência a um título neste documento.
Representação JSON |
---|
{ "id": string, "tabId": string } |
Campos | |
---|---|
id |
O ID de um título neste documento. |
tabId |
O ID da guia que contém o cabeçalho. |
SuggestedTextStyle
Uma mudança sugerida para TextStyle
.
Representação JSON |
---|
{ "textStyle": { object ( |
Campos | |
---|---|
textStyle |
Um |
textStyleSuggestionState |
Uma máscara que indica quais dos campos na |
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 |
Indica se houve uma alteração sugerida para |
italicSuggested |
Indica se houve uma alteração sugerida para |
underlineSuggested |
Indica se houve uma mudança sugerida para |
strikethroughSuggested |
Indica se houve uma alteração sugerida para |
smallCapsSuggested |
Indica se houve uma mudança sugerida para |
backgroundColorSuggested |
Indica se houve uma alteração sugerida para |
foregroundColorSuggested |
Indica se houve uma alteração sugerida para |
fontSizeSuggested |
Indica se houve uma alteração sugerida para |
weightedFontFamilySuggested |
Indica se houve uma alteração sugerida para |
baselineOffsetSuggested |
Indica se houve uma alteração sugerida para |
linkSuggested |
Indica se houve uma mudança sugerida para |
Texto automático
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 ( |
Campos | |
---|---|
type |
O tipo do texto automático. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
textStyle |
O estilo deste AutoText. |
suggestedTextStyleChanges |
O estilo do texto sugerido muda para esse texto automático, com chave de 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 ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
textStyle |
O estilo de texto desta 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 |
O estilo de texto sugerido muda para essa quebra de página, codificada pelo ID da 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 ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
textStyle |
O estilo de texto desse ColumnBreak. 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 |
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é. Uma referência da nota de rodapé é o conteúdo in-line renderizado com um número e é usada para identificar a nota.
Representação JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
footnoteId |
O ID do |
footnoteNumber |
O número renderizado desta nota de rodapé. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
textStyle |
O estilo de texto desta FootnoteReference. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para este FootnoteReference, codificado por ID de sugestão. |
HorizontalRule
Uma ParagraphElement
que representa uma linha horizontal.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
textStyle |
O estilo de texto dessa 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 |
O estilo de texto sugerido muda para essa HorizontalRule, codificado pelo ID da sugestão. |
Equação
Uma ParagraphElement
que representa uma equação.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não 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 ( |
Campos | |
---|---|
inlineObjectId |
O ID da |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
textStyle |
O estilo de texto desse InlineObjectElement. Assim como o conteúdo de texto, como trechos de texto e referências à nota de rodapé, o estilo do texto de um elemento de objeto inline pode afetar o layout do conteúdo e o estilo do texto inserido ao lado dele. |
suggestedTextStyleChanges |
O estilo do texto sugerido muda para esse InlineObject, com chave de ID de sugestão. |
Pessoa
Uma pessoa ou 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 ( |
Campos | |
---|---|
personId |
Apenas saída. O ID exclusivo desse link. |
suggestedInsertionIds[] |
IDs das sugestões que inserem o link dessa pessoa no documento. Um |
suggestedDeletionIds[] |
IDs de sugestões que removem o link dessa pessoa do documento. Um |
textStyle |
O estilo de texto desta |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para |
personProperties |
Apenas saída. As propriedades desse |
PersonProperties
Propriedades específicas de um Person
vinculado.
Representação JSON |
---|
{ "name": string, "email": string } |
Campos | |
---|---|
name |
Apenas saída. O nome da pessoa, se for exibido no texto do link em vez do endereço de e-mail da pessoa. |
email |
Apenas saída. O endereço de e-mail vinculado a este |
RichLink
Um link para um recurso do Google (como um arquivo no Drive, um vídeo do YouTube ou um evento do Agenda).
Representação JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
richLinkId |
Apenas saída. O ID deste link. |
suggestedInsertionIds[] |
IDs de sugestões que inserem esse link no documento. Um |
suggestedDeletionIds[] |
IDs de sugestões que removem esse link do documento. Uma |
textStyle |
O estilo de texto dessa |
suggestedTextStyleChanges |
O estilo do texto sugerido muda para |
richLinkProperties |
Apenas saída. As propriedades desse |
RichLinkProperties
Propriedades específicas de um RichLink
.
Representação JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
Campos | |
---|---|
title |
Apenas saída. O título do |
uri |
Apenas saída. O URI da |
mimeType |
Apenas saída. O tipo MIME do |
ParagraphStyle
Estilos que se aplicam a um parágrafo inteiro.
Os estilos de parágrafo herdados são representados como campos não definidos nesta mensagem. O pai de um estilo de parágrafo depende de onde ele está definido:
- O ParagraphStyle em um
Paragraph
é herdado donamed style type
correspondente do parágrafo. - O ParagraphStyle em um
named style
herda do estilo nomeadonormal text
. - O ParagraphStyle do estilo nomeado
normal text
herda do estilo de parágrafo padrão no editor do Documentos. - O ParagraphStyle em um elemento
Paragraph
contido em uma tabela pode herdar o estilo de parágrafo do estilo da tabela.
Se o estilo de parágrafo não for herdado de um elemento pai, desfazer a configuração dos campos o reverterá para um valor correspondente aos padrões no editor do Documentos.
Representação JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Campos | |
---|---|
headingId |
O ID do cabeçalho do parágrafo. Se estiver vazio, o parágrafo não é um cabeçalho. Esta propriedade é somente leitura. |
namedStyleType |
O tipo de estilo nomeado do parágrafo. Como a atualização do tipo de estilo nomeado afeta outras propriedades em ParagraphStyle, o tipo de estilo nomeado é aplicado antes que as outras propriedades sejam atualizadas. |
alignment |
O alinhamento do texto para este parágrafo. |
lineSpacing |
A quantidade de espaço entre as linhas, como uma porcentagem do normal, em que o normal é representado como 100,0. Se não for definido, o valor será herdado do pai. |
direction |
A direção do texto deste parágrafo. Se não for definido, o valor padrão será |
spacingMode |
O modo de espaçamento do parágrafo. |
spaceAbove |
A quantidade de espaço extra acima do parágrafo. Se não for definido, o valor será herdado do pai. |
spaceBelow |
A quantidade de espaço extra abaixo do parágrafo. Se não for definido, o valor será herdado do pai. |
borderBetween |
A borda entre este parágrafo e o parágrafo seguinte e o anterior. 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ágrafos não podem ser parcialmente atualizadas. Ao mudar a borda de um parágrafo, a nova borda precisa ser especificada por completo. |
borderTop |
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 |
A borda na parte de baixo deste parágrafo. Se não for definido, o valor será herdado do pai. A borda inferior é renderizada quando o parágrafo abaixo tem propriedades de borda e recuo diferentes. As bordas de parágrafos não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda precisa ser especificada integralmente. |
borderLeft |
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 alterar uma borda de parágrafo, a nova borda precisa ser especificada integralmente. |
borderRight |
A borda à direita do 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 |
A quantidade de recuo da primeira linha do parágrafo. Se não for definido, o valor será herdado do pai. |
indentStart |
A quantidade de recuo do parágrafo no lado que corresponde ao início do texto, com base na direção atual do parágrafo. Se não for definido, o valor será herdado do pai. |
indentEnd |
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[] |
Uma lista de tabulações é interrompida nesse parágrafo. A lista de tabulações não é herdada. Esta propriedade é somente leitura. |
keepLinesTogether |
Define 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 |
Se pelo menos uma parte deste parágrafo deve 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 |
Se viúvas e órfãos devem ser evitados no parágrafo. Se não for definido, o valor será herdado do pai. |
shading |
O sombreamento do parágrafo. Se não for definido, o valor será herdado do pai. |
pageBreakBefore |
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 |
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 elemento 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 é centralizado. |
END |
O parágrafo é alinhado ao fim 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 chegar.
Enums | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
A direção do conteúdo não foi especificada. |
LEFT_TO_RIGHT |
O conteúdo vai da esquerda para a direita. |
RIGHT_TO_LEFT |
O conteúdo vai da direita para a esquerda. |
SpacingMode
Os diferentes modos de espaçamento de parágrafos.
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 do parágrafo é ignorado entre os elementos da lista. |
ParagraphBorder
Uma borda ao redor de um parágrafo.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
A cor da borda. |
width |
A largura da borda. |
padding |
O padding da borda. |
dashStyle |
O estilo de traço da borda. |
DashStyle
Os tipos de traços com que a geometria linear pode ser renderizada. Esses valores 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 ST_PresetLineDashVal da ECMA-376. Esse é o estilo de traço padrão. |
DOT |
Linha pontilhada. Corresponde ao valor de ECMA-376 ST_PresetLineDashVal "dot". |
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 ( |
Campos | |
---|---|
offset |
O deslocamento entre essa parada de guia e a margem inicial. |
alignment |
O alinhamento desta parada de guia. Se não for definido, o valor padrão será |
TabStopAlignment
O alinhamento do recuo de tabulação.
Enums | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
O alinhamento da parada de tabulação não está especificado. |
START |
A parada de tabulação é alinhada ao início da linha. Esse é o padrão. |
CENTER |
A tabulação está 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 ( |
Campos | |
---|---|
backgroundColor |
A cor de fundo do sombreamento de parágrafos. |
SuggestedParagraphStyle
Uma mudança sugerida para ParagraphStyle
.
Representação JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraphStyle |
Um |
paragraphStyleSuggestionState |
Uma máscara que indica quais campos na base |
ParagraphStyleSuggestionState
Uma máscara que indica quais dos campos na ParagraphStyle
de base foram alterados nesta 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 ( |
Campos | |
---|---|
headingIdSuggested |
Indica se houve uma alteração sugerida para |
namedStyleTypeSuggested |
Indica se houve uma mudança sugerida para |
alignmentSuggested |
Indica se houve uma mudança sugerida para |
lineSpacingSuggested |
Indica se houve uma alteração sugerida para |
directionSuggested |
Indica se houve uma alteração sugerida para |
spacingModeSuggested |
Indica se houve uma alteração sugerida para |
spaceAboveSuggested |
Indica se houve uma mudança sugerida para |
spaceBelowSuggested |
Indica se houve uma mudança sugerida para |
borderBetweenSuggested |
Indica se houve uma mudança sugerida para |
borderTopSuggested |
Indica se houve uma mudança sugerida para |
borderBottomSuggested |
Indica se houve uma mudança sugerida para |
borderLeftSuggested |
Indica se houve uma mudança sugerida para |
borderRightSuggested |
Indica se houve uma alteração sugerida para |
indentFirstLineSuggested |
Indica se houve uma mudança sugerida para |
indentStartSuggested |
Indica se houve uma alteração sugerida para |
indentEndSuggested |
Indica se houve uma alteração sugerida para |
keepLinesTogetherSuggested |
Indica se houve uma alteração sugerida para |
keepWithNextSuggested |
Indica se houve uma mudança sugerida para |
avoidWidowAndOrphanSuggested |
Indica se houve uma mudança sugerida para |
shadingSuggestionState |
Uma máscara que indica quais campos em |
pageBreakBeforeSuggested |
Indica se houve uma alteração sugerida para |
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 |
Indica se houve uma mudança sugerida no |
Marcador
Descreve o marcador de um parágrafo.
Representação JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Campos | |
---|---|
listId |
O ID da lista a que este parágrafo pertence. |
nestingLevel |
O nível de aninhamento deste parágrafo na lista. |
textStyle |
É o estilo de texto específico de parágrafo aplicado ao marcador. |
Sugestão de bala
Uma mudança sugerida para Bullet
.
Representação JSON |
---|
{ "bullet": { object ( |
Campos | |
---|---|
bullet |
Um |
bulletSuggestionState |
Uma máscara que indica quais dos campos na |
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 ( |
Campos | |
---|---|
listIdSuggested |
Indica se houve uma mudança sugerida no |
nestingLevelSuggested |
Indica se houve uma mudança sugerida no |
textStyleSuggestionState |
Uma máscara que indica quais campos em |
ObjectReferences
Uma coleção de IDs de objetos.
Representação JSON |
---|
{ "objectIds": [ string ] } |
Campos | |
---|---|
objectIds[] |
Os IDs de objeto. |
SectionBreak
Um StructuralElement
que representa uma quebra de seção. Uma seção é um intervalo de conteúdo que tem o mesmo SectionStyle
. Uma quebra de seção representa o início de uma nova seção, e o estilo dela é aplicado à seção após a quebra.
O corpo do documento sempre começa com uma quebra de seção.
Representação JSON |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
sectionStyle |
O estilo da seção após essa quebra de seção. |
SectionStyle
O estilo que se aplica a uma seção.
Representação JSON |
---|
{ "columnProperties": [ { object ( |
Campos | |
---|---|
columnProperties[] |
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. Desconfigurar essa propriedade resultará em um erro 400 de solicitação inválida. |
columnSeparatorStyle |
O estilo dos separadores de coluna. Esse estilo pode ser definido mesmo quando há uma coluna na seção. Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
contentDirection |
A direção do conteúdo desta seção. Se não for definido, o valor padrão será Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
marginTop |
Margem superior da página da seção. Se não for definido, o valor padrão será Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
marginBottom |
Margem inferior da página da seção. Se não for definido, o valor padrão será Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
marginRight |
Margem direita da página da seção. Se não for definido, o valor padrão será 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 |
A margem da página à esquerda da seção. Se não for definido, o valor padrão será Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
marginHeader |
A margem do cabeçalho da seção. Se não for definido, o valor padrão será Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
marginFooter |
A margem do rodapé da seção. Se não for definido, o valor padrão será Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
sectionType |
Apenas saída. O tipo de seção. |
defaultHeaderId |
O ID do cabeçalho padrão. Se não for definido, o valor herda o SectionStyle Esta propriedade é somente leitura. |
defaultFooterId |
O ID do rodapé padrão. Se não for definido, o valor será herdado do sectionStyle Esta propriedade é somente leitura. |
firstPageHeaderId |
O ID do cabeçalho usado apenas para a primeira página da seção. Se Esta propriedade é somente leitura. |
firstPageFooterId |
O ID do rodapé usado apenas para a primeira página da seção. Se Esta propriedade é somente leitura. |
evenPageHeaderId |
O ID do cabeçalho usado apenas para páginas pares. Se o valor de Esta propriedade é somente leitura. |
evenPageFooterId |
O ID do rodapé usado apenas para páginas pares. Se o valor de Esta propriedade é somente leitura. |
useFirstPageHeaderFooter |
Indica se os IDs do cabeçalho / rodapé da primeira página devem ser usados para a primeira página da seção. Se não for definido, ele será herdado de Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
pageNumberStart |
O número da página a partir da qual a contagem é iniciada. Se ela não for definida, a numeração de páginas continuará da seção anterior. Se o valor não for definido na primeira Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
flipPageOrientation |
Opcional. Indica se as dimensões de Ao atualizar essa propriedade, é necessário definir um valor concreto. Desativar essa 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 ( |
Campos | |
---|---|
width |
Apenas saída. A largura da coluna. |
paddingEnd |
O padding no fim da coluna. |
ColumnSeparatorStyle
O estilo dos separadores entre as colunas.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Um estilo de separador de colunas não especificado. |
NONE |
Não há linhas separadas por colunas entre as colunas. |
BETWEEN_EACH_COLUMN |
Renderiza uma linha separadora de coluna entre cada coluna. |
SectionType
Representa como o início da seção atual é posicionado em relação à seção anterior.
Enums | |
---|---|
SECTION_TYPE_UNSPECIFIED |
O tipo de seção não foi especificado. |
CONTINUOUS |
A seção começa imediatamente após o último parágrafo da seção anterior. |
NEXT_PAGE |
A seção começa na próxima página. |
Tabela
Um StructuralElement
que representa uma tabela.
Representação JSON |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
Campos | |
---|---|
rows |
Número de linhas na tabela. |
columns |
Número de colunas na tabela. É possível que uma tabela não seja retangular, portanto, algumas linhas podem ter um número diferente de células. |
tableRows[] |
O conteúdo e o estilo de cada linha. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
tableStyle |
O estilo da tabela. |
TableRow
O conteúdo e o estilo de uma linha em um Table
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
Campos | |
---|---|
startIndex |
O índice inicial baseado em zero dessa linha, em unidades de código UTF-16. |
endIndex |
O índice final com base em zero desta linha, exclusivo, em unidades de código UTF-16. |
tableCells[] |
O conteúdo e o estilo de cada célula nessa linha. É possível que uma tabela não seja retangular, portanto, algumas linhas podem ter um número diferente de células do que outras linhas da mesma tabela. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Um |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
tableRowStyle |
O estilo da linha da tabela. |
suggestedTableRowStyleChanges |
O estilo sugerido muda para essa linha, codificado pelo ID da sugestão. |
TableCell
O conteúdo e o estilo de uma célula em um Table
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Campos | |
---|---|
startIndex |
O índice inicial baseado em zero desta célula, em unidades de código UTF-16. |
endIndex |
O índice final com base em zero desta célula, exclusivo, em unidades de código UTF-16. |
content[] |
O conteúdo da célula. |
tableCellStyle |
O estilo da célula. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
suggestedTableCellStyleChanges |
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élulas herdadas da tabela são representados como campos não definidos nesta mensagem. Um estilo de célula da tabela pode herdar do estilo da tabela.
Representação JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
Campos | |
---|---|
rowSpan |
A extensão da linha da célula. Esta propriedade é somente leitura. |
columnSpan |
A extensão da coluna da célula. Esta propriedade é somente leitura. |
backgroundColor |
A cor de fundo da célula. |
borderLeft |
A borda esquerda da célula. |
borderRight |
A borda direita da célula. |
borderTop |
A borda superior da célula. |
borderBottom |
A borda inferior da célula. |
paddingLeft |
O padding esquerdo da célula. |
paddingRight |
O padding à direita da célula. |
paddingTop |
O padding superior da célula. |
paddingBottom |
O padding da parte de baixo da célula. |
contentAlignment |
O alinhamento do conteúdo na célula da tabela. O alinhamento padrão corresponde ao alinhamento das células da tabela recém-criadas no Editor de arquivos Google. |
TableCellBorder
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 ( |
Campos | |
---|---|
color |
A cor da borda. Essa cor não pode ser transparente. |
width |
A largura da borda. |
dashStyle |
O estilo de traço da borda. |
ContentAlignment
Os tipos de alinhamento de conteúdo.
Derivado de um subconjunto dos valores do tipo simples "ST_TextAnchoringType" na seção 20.1.10.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 houver um. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Alinhamento de conteúdo incompatível. |
TOP |
Um alinhamento que alinha o conteúdo à parte superior do armazenador de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType 't'. |
MIDDLE |
Um alinhamento que alinha o conteúdo ao meio do detentor de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType "ctr". |
BOTTOM |
Um alinhamento que alinha o conteúdo à parte inferior do armazenador de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType 'b'. |
SuggestedTableCellStyle
Uma mudança sugerida para TableCellStyle
.
Representação JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
tableCellStyle |
Um |
tableCellStyleSuggestionState |
Uma máscara que indica quais campos na base |
TableCellStyleSuggestionState
Uma máscara que indica quais campos na base TableCellStyle
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
Campos | |
---|---|
rowSpanSuggested |
Indica se houve uma mudança sugerida para |
columnSpanSuggested |
Indica se houve uma alteração sugerida para |
backgroundColorSuggested |
Indica se houve uma alteração sugerida para |
borderLeftSuggested |
Indica se houve uma mudança sugerida para |
borderRightSuggested |
Indica se houve uma alteração sugerida para |
borderTopSuggested |
Indica se houve uma mudança sugerida para |
borderBottomSuggested |
Indica se houve uma alteração sugerida para |
paddingLeftSuggested |
Indica se houve uma mudança sugerida para |
paddingRightSuggested |
Indica se houve uma mudança sugerida para |
paddingTopSuggested |
Indica se houve uma alteração sugerida para |
paddingBottomSuggested |
Indica se houve uma mudança sugerida para |
contentAlignmentSuggested |
Indica se houve uma alteração sugerida para |
TableRowStyle
Estilos que se aplicam a uma linha da tabela.
Representação JSON |
---|
{
"minRowHeight": {
object ( |
Campos | |
---|---|
minRowHeight |
A altura mínima da linha. A linha será renderizada no Editor do Documentos Google a uma altura igual ou maior que esse valor para mostrar todo o conteúdo das células da linha. |
tableHeader |
Se a linha é um cabeçalho de tabela. |
preventOverflow |
Indica se a linha não pode ultrapassar os limites de página ou coluna. |
SuggestedTableRowStyle
Uma mudança sugerida para TableRowStyle
.
Representação JSON |
---|
{ "tableRowStyle": { object ( |
Campos | |
---|---|
tableRowStyle |
Um |
tableRowStyleSuggestionState |
Uma máscara que indica quais campos na base |
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 |
Indica se houve uma mudança sugerida para |
TableStyle
Estilos que se aplicam a uma tabela.
Representação JSON |
---|
{
"tableColumnProperties": [
{
object ( |
Campos | |
---|---|
tableColumnProperties[] |
As propriedades de cada coluna. Nos Documentos, as tabelas contêm linhas e as linhas contêm células, semelhante ao HTML. Portanto, as propriedades de uma linha podem ser encontradas no |
TableColumnProperties
As propriedades de uma coluna em uma tabela.
Representação JSON |
---|
{ "widthType": enum ( |
Campos | |
---|---|
widthType |
O tipo de largura da coluna. |
width |
A largura da coluna. Definido quando o |
WidthType
O tipo de largura da coluna.
Enums | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
O tipo de largura da coluna não foi especificado. |
EVENLY_DISTRIBUTED |
A largura da coluna é distribuída uniformemente entre as outras colunas. A largura da coluna é determinada automaticamente e terá uma parte igual da largura restante da tabela depois de considerar todas as colunas com larguras especificadas. |
FIXED_WIDTH |
Uma largura de coluna fixa. A propriedade [width][google.apps.docs.v1.TableColumnProperties.width ] contém a largura da coluna. |
TableOfContents
Um StructuralElement
que representa um sumário.
Representação JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
O conteúdo do sumário. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão desse conteúdo. |
Cabeçalho
Um cabeçalho de documento.
Representação JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
Campos | |
---|---|
headerId |
O ID do cabeçalho. |
content[] |
O conteúdo do cabeçalho. Os índices do conteúdo de um cabeçalho começam em zero. |
Nota de rodapé
Uma nota de rodapé do documento.
Representação JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
Campos | |
---|---|
footnoteId |
O ID da nota de rodapé. |
content[] |
O conteúdo da nota de rodapé. Os índices do conteúdo de uma nota de rodapé começam em zero. |
DocumentStyle
O estilo do documento.
Representação JSON |
---|
{ "background": { object ( |
Campos | |
---|---|
background |
O plano de fundo do documento. Os documentos não podem ter uma cor de fundo transparente. |
defaultHeaderId |
O ID do cabeçalho padrão. Se ela não for definida, não haverá um cabeçalho padrão. Esta propriedade é somente leitura. |
defaultFooterId |
O ID do rodapé padrão. Se ela for deixada sem definição, não haverá rodapé padrão. Esta propriedade é somente leitura. |
evenPageHeaderId |
O ID do cabeçalho usado apenas para páginas pares. O valor de Esta propriedade é somente leitura. |
evenPageFooterId |
O ID do rodapé usado apenas para páginas pares. O valor de Esta propriedade é somente leitura. |
firstPageHeaderId |
O ID do cabeçalho usado apenas para a primeira página. Se não for definido, um cabeçalho exclusivo para a primeira página não vai existir. O valor de Esta propriedade é somente leitura. |
firstPageFooterId |
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 Esta propriedade é somente leitura. |
useFirstPageHeaderFooter |
Indica se os IDs do cabeçalho / rodapé da primeira página precisam ser usados. |
useEvenPageHeaderFooter |
Indica se é necessário usar IDs de cabeçalho / rodapé de página par para as páginas pares. |
pageNumberStart |
O número da página a partir da qual a contagem é iniciada. |
marginTop |
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 |
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 |
A margem da página à direita. Atualizar a margem de página direita no estilo de documento limpa essa margem em todos os estilos de seção. Isso também pode fazer com que as colunas sejam redimensionadas em todas as seções. |
marginLeft |
A margem da página à esquerda. Atualizar a margem de página esquerda no estilo de documento limpa essa margem em todos os estilos de seção. Isso também pode fazer com que as colunas sejam redimensionadas em todas as seções. |
pageSize |
O tamanho de uma página no documento. |
marginHeader |
A quantidade de espaço entre a parte de cima da página e o conteúdo do cabeçalho. |
marginFooter |
A quantidade de espaço entre a parte inferior da página e o conteúdo do rodapé. |
useCustomHeaderFooterMargins |
Indica se DocumentStyle Esta propriedade é somente leitura. |
flipPageOrientation |
Opcional. Indica se as dimensões da |
Contexto
Representa o plano de fundo de um documento.
Representação JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
A cor do plano de fundo. |
Tamanho
Indica a largura e a altura.
Representação JSON |
---|
{ "height": { object ( |
Campos | |
---|---|
height |
A altura do objeto. |
width |
A largura do objeto. |
SuggestedDocumentStyle
Uma mudança sugerida no DocumentStyle
.
Representação JSON |
---|
{ "documentStyle": { object ( |
Campos | |
---|---|
documentStyle |
Um |
documentStyleSuggestionState |
Uma máscara que indica quais dos campos na |
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 ( |
Campos | |
---|---|
backgroundSuggestionState |
Uma máscara que indica quais campos em |
defaultHeaderIdSuggested |
Indica se houve uma alteração sugerida para |
defaultFooterIdSuggested |
Indica se houve uma alteração sugerida para |
evenPageHeaderIdSuggested |
Indica se houve uma alteração sugerida para |
evenPageFooterIdSuggested |
Indica se houve uma alteração sugerida para |
firstPageHeaderIdSuggested |
Indica se houve uma mudança sugerida para |
firstPageFooterIdSuggested |
Indica se houve uma mudança sugerida para |
useFirstPageHeaderFooterSuggested |
Indica se houve uma alteração sugerida para |
useEvenPageHeaderFooterSuggested |
Indica se houve uma mudança sugerida para |
pageNumberStartSuggested |
Indica se houve uma mudança sugerida para |
marginTopSuggested |
Indica se houve uma mudança sugerida para |
marginBottomSuggested |
Indica se houve uma alteração sugerida para |
marginRightSuggested |
Indica se houve uma mudança sugerida para |
marginLeftSuggested |
Indica se houve uma alteração sugerida para |
pageSizeSuggestionState |
Uma máscara que indica quais dos campos em [size] [google.apps.docs.v1.DocumentStyle.size] foram alterados nesta sugestão. |
marginHeaderSuggested |
Indica se houve uma alteração sugerida para |
marginFooterSuggested |
Indica se houve uma alteração sugerida para |
useCustomHeaderFooterMarginsSuggested |
Indica se houve uma alteração sugerida para |
flipPageOrientationSuggested |
Opcional. Indica se houve uma alteração sugerida para |
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 |
Indica se a cor de fundo atual foi modificada nessa 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 |
Indica se houve uma mudança sugerida para |
widthSuggested |
Indica se houve uma alteração sugerida para |
NamedStyles
Os estilos nomeados. Os parágrafos do documento podem herdar o TextStyle
e a ParagraphStyle
desses estilos nomeados.
Representação JSON |
---|
{
"styles": [
{
object ( |
Campos | |
---|---|
styles[] |
Os estilos nomeados. Há uma entrada para cada um dos |
NamedStyle
Um estilo com nome. Os parágrafos do documento podem herdar TextStyle
e ParagraphStyle
desse estilo nomeado quando tiverem o mesmo tipo de estilo.
Representação JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
namedStyleType |
Tipo do estilo. |
textStyle |
O estilo de texto desse estilo nomeado. |
paragraphStyle |
O estilo de parágrafo deste estilo nomeado. |
SuggestedNamedStyles
Uma mudança sugerida no NamedStyles
.
Representação JSON |
---|
{ "namedStyles": { object ( |
Campos | |
---|---|
namedStyles |
Um |
namedStylesSuggestionState |
Uma máscara que indica quais dos campos na |
NamedStylesSuggestionState
O estado da sugestão de uma mensagem NamedStyles
.
Representação JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
Campos | |
---|---|
stylesSuggestionStates[] |
Uma máscara que indica quais campos no A ordem desses estados de sugestão de estilo nomeados corresponde à ordem do estilo nomeado correspondente na sugestão |
NamedStyleSuggestionState
Um estado de sugestão de uma mensagem NamedStyle
.
Representação JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
namedStyleType |
O tipo de estilo nomeado ao qual esse estado de sugestão corresponde. Esse campo é fornecido como uma conveniência para corresponder o NamedStyleSuggestionState ao |
textStyleSuggestionState |
Uma máscara que indica quais campos em |
paragraphStyleSuggestionState |
Uma máscara que indica quais dos campos em |
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 ( |
Campos | |
---|---|
listProperties |
Propriedades da lista. |
suggestedListPropertiesChanges |
As mudanças sugeridas para as propriedades da lista, codificadas por ID de sugestão. |
suggestedInsertionId |
O ID de inserção sugerido. Se estiver vazio, não é uma inserção sugerida. |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusões para esta lista. |
ListProperties
São as propriedades de um list
que descrevem a aparência de marcadores pertencentes a parágrafos associados a uma lista.
Representação JSON |
---|
{
"nestingLevels": [
{
object ( |
Campos | |
---|---|
nestingLevels[] |
Descreve as propriedades dos marcadores no nível associado. Uma lista tem no máximo nove níveis de aninhamento, sendo que o nível 0 corresponde ao nível mais alto e o nível 8 ao 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 ( |
Campos | |
---|---|
bulletAlignment |
O alinhamento do marcador dentro do espaço alocado para renderizar o marcador. |
glyphFormat |
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 Por exemplo, o formato de glifo
O formato de glifo pode conter marcadores de posição para o nível de aninhamento atual e para níveis de aninhamento pai. Por exemplo, uma lista pode ter um formato de glifo de
Para níveis de aninhamento 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 |
A quantidade de recuo para a primeira linha de parágrafos nesse nível de aninhamento. |
indentStart |
A quantidade de recuo para parágrafos nesse nível de aninhamento. Aplicada ao lado que corresponde ao início do texto, com base na direção do conteúdo do parágrafo. |
textStyle |
O estilo de texto dos marcadores neste nível de aninhamento. |
startNumber |
O número do primeiro item da lista neste nível de aninhamento. Um valor de 0 é tratado como 1 para listas de letras e de numerais romanos. Para valores de 0 e 1, as listas de letras e algarismos romanos começam em Esse valor é ignorado para níveis aninhados com glifos não ordenados. |
Campo de união glyph_kind . O tipo de glifo usado pelos marcadores. Isso define o glifo de marcador que substitui os marcadores de posição no glyph_format . glyph_kind pode ser apenas de um dos tipos a seguir: |
|
glyphType |
O tipo de glifo usado pelos marcadores quando eles estão ordenados nesse nível de aninhamento. O tipo de glifo determina o tipo de glifo usado para substituir marcadores de posição no |
glyphSymbol |
Um glifo personalizado usado pelos marcadores quando os parágrafos desse nível de aninhamento não estão ordenados. O símbolo do glifo substitui os marcadores de posição no |
BulletAlignment
Os tipos de alinhamento de um marcador.
Enums | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
O alinhamento dos marcadores não foi especificado. |
START |
O marcador é alinhado ao início do espaço alocado para renderizar o marcador. Alinhado à esquerda para texto LTR. Caso contrário, alinhado à direita. |
CENTER |
O marcador é alinhado ao centro do espaço alocado para renderização. |
END |
O marcador é alinhado ao final do espaço alocado para renderizar o marcador. 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 números de apenas um dígito são prefixados com zero, como 01 , 02 ou 03 . Números com mais de um dígito não têm um zero no prefixo. |
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 numeral romano em letra minúscula, como i , ii ou iii . |
SuggestedListProperties
Uma alteração sugerida para ListProperties
.
Representação JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Um |
listPropertiesSuggestionState |
Uma máscara que indica quais dos campos na |
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 ( |
Campos | |
---|---|
nestingLevelsSuggestionStates[] |
Uma máscara que indica quais campos no Os estados de sugestão do nível de aninhamento são retornados na 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 ( |
Campos | |
---|---|
bulletAlignmentSuggested |
Indica se houve uma alteração sugerida para |
glyphTypeSuggested |
Indica se houve uma mudança sugerida para |
glyphFormatSuggested |
Indica se houve uma alteração sugerida para |
glyphSymbolSuggested |
Indica se houve uma alteração sugerida para |
indentFirstLineSuggested |
Indica se houve uma alteração sugerida para |
indentStartSuggested |
Indica se houve uma alteração sugerida para |
textStyleSuggestionState |
Uma máscara que indica quais dos campos em |
startNumberSuggested |
Indica se houve uma alteração sugerida para |
NamedRanges
Uma coleção de todos os NamedRange
s no documento que compartilham um determinado nome.
Representação JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Campos | |
---|---|
name |
O nome que todos os |
namedRanges[] |
As |
NamedRange
Uma coleção de Range
s com o mesmo ID de intervalo nomeado.
Os intervalos nomeados permitem que os desenvolvedores associem partes de um documento a um marcador arbitrário definido pelo usuário para que o conteúdo possa ser lido ou editado programaticamente mais tarde. Um documento pode conter vários intervalos nomeados com o mesmo nome, mas cada intervalo nomeado tem um ID exclusivo.
Um intervalo nomeado é criado com um único Range
, e o conteúdo inserido dentro dele geralmente expande esse intervalo. No entanto, algumas alterações 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 acessar os intervalos nomeados.
Representação JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Campos | |
---|---|
namedRangeId |
O ID do intervalo nomeado. |
name |
O nome do intervalo nomeado. |
ranges[] |
Os intervalos que pertencem a este intervalo nomeado. |
Intervalo
Especifica um intervalo contíguo de texto.
Representação JSON |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer, "tabId": string } |
Campos | |
---|---|
segmentId |
O ID do cabeçalho, rodapé ou nota de rodapé em que o intervalo está contido. Um ID de segmento vazio significa o corpo do documento. |
startIndex |
O índice inicial baseado em zero desse intervalo, em unidades de código UTF-16. Em todos os usos atuais, é necessário fornecer um índice inicial. Este campo é um Int32Value para acomodar casos de uso futuros com intervalos abertos. |
endIndex |
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 |
A guia que contém esse intervalo. Quando omitida, a solicitação se aplica à primeira guia. Em um documento com uma única guia:
Em um documento com várias guias:
|
InlineObject
Um objeto que aparece inline com o texto. Um InlineObject contém um EmbeddedObject
, como uma imagem.
Representação JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
Campos | |
---|---|
objectId |
O ID desse objeto inline. Pode ser usado para atualizar as propriedades de um objeto. |
inlineObjectProperties |
As propriedades desse objeto inline. |
suggestedInlineObjectPropertiesChanges |
As mudanças sugeridas para as propriedades do objeto inline, codificadas por ID de sugestão. |
suggestedInsertionId |
O ID de inserção sugerido. Se estiver vazio, não é uma inserção sugerida. |
suggestedDeletionIds[] |
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 ( |
Campos | |
---|---|
embeddedObject |
O objeto incorporado desse objeto inline. |
EmbeddedObject
Um objeto incorporado no documento.
Representação JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Campos | |
---|---|
title |
O título do objeto incorporado. O |
description |
A descrição do objeto incorporado. |
embeddedObjectBorder |
A borda do objeto incorporado. |
size |
O tamanho visível da imagem após o corte. |
marginTop |
A margem superior do objeto incorporado. |
marginBottom |
A margem inferior do objeto incorporado. |
marginRight |
A margem direita do objeto incorporado. |
marginLeft |
A margem esquerda do objeto incorporado. |
linkedContentReference |
Uma referência ao conteúdo de origem externa vinculada. Por exemplo, ele contém uma referência ao gráfico de origem das Planilhas Google quando o objeto incorporado é um gráfico vinculado. Se não 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 |
As propriedades de um desenho incorporado. |
imageProperties |
As propriedades de uma imagem. |
EmbeddedDrawingProperties
Esse tipo não tem campos.
As propriedades de um desenho incorporado e usadas para diferenciar o tipo de objeto. Um desenho incorporado é um desenho criado e editado em um documento. Não há suporte para muitos detalhes.
ImageProperties
As propriedades de uma imagem.
Representação JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
Campos | |
---|---|
contentUri |
Um URI para a imagem com vida útil 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 |
URI de origem é o URI usado para inserir a imagem. O URI de origem pode estar vazio. |
brightness |
O efeito de brilho da imagem. O valor deve estar no intervalo [-1,0, 1,0], em que 0 significa que não há efeito. |
contrast |
É o efeito de contraste da imagem. O valor precisa estar no intervalo [-1,0, 1,0], em que 0 significa nenhum efeito. |
transparency |
O efeito de transparência da imagem. O valor deve estar no intervalo [0,0, 1,0], em que 0 significa nenhum efeito e 1 significa transparente. |
cropProperties |
As propriedades de corte da imagem. |
angle |
O ângulo de rotação no sentido horário da imagem, em radianos. |
CropProperties
As propriedades de corte de uma imagem.
O retângulo de corte é representado usando deslocamentos fracionários das quatro bordas do conteúdo original.
- Se o deslocamento estiver no intervalo (0, 1), a borda correspondente do retângulo de corte será posicionada dentro do retângulo delimitador original da imagem.
- Se o deslocamento for negativo ou maior que 1, a borda correspondente do retângulo de corte será posicionada fora do retângulo delimitador original da imagem.
- Se todos os deslocamentos e ângulos de rotação forem 0, a imagem não será cortada.
Representação JSON |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
Campos | |
---|---|
offsetLeft |
O deslocamento especifica a distância entre a borda esquerda do retângulo de corte e a borda esquerda do conteúdo original como uma fração da largura do conteúdo original. |
offsetRight |
O deslocamento especifica a distância 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 |
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 |
O deslocamento especifica a distância entre a borda inferior do retângulo de corte e a borda inferior do conteúdo original como uma fração da altura do conteúdo original. |
angle |
O ângulo de rotação no sentido horário do retângulo de corte em torno do centro, em radianos. A rotação é aplicada após os deslocamentos. |
EmbeddedObjectBorder
Uma borda ao redor de um EmbeddedObject
.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
A cor da borda. |
width |
A largura da borda. |
dashStyle |
O estilo de traço da borda. |
propertyState |
O estado da propriedade da borda. |
PropertyState
Os possíveis estados 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 de origem externa vinculada.
Representação JSON |
---|
{ // Union field |
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 |
Uma referência ao gráfico vinculado. |
SheetsChartReference
Referência a um gráfico vinculado incorporado do Planilhas Google.
Representação JSON |
---|
{ "spreadsheetId": string, "chartId": integer } |
Campos | |
---|---|
spreadsheetId |
O ID da planilha do Google Planilhas que contém o gráfico de origem. |
chartId |
O ID do gráfico específico na planilha do Planilhas Google que está incorporada. |
SuggestedInlineObjectProperties
Uma alteração sugerida para InlineObjectProperties
.
Representação JSON |
---|
{ "inlineObjectProperties": { object ( |
Campos | |
---|---|
inlineObjectProperties |
Um |
inlineObjectPropertiesSuggestionState |
Uma máscara que indica quais campos na base |
InlineObjectPropertiesSuggestionState
Uma máscara que indica quais dos campos na InlineObjectProperties
de base foram alterados nesta sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Campos | |
---|---|
embeddedObjectSuggestionState |
Uma máscara que indica quais campos em |
EmbeddedObjectSuggestionState
Uma máscara que indica quais campos na base EmbeddedObject
foram alterados nessa sugestão. Para qualquer campo definido como "verdadeiro", há um novo valor sugerido.
Representação JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Campos | |
---|---|
embeddedDrawingPropertiesSuggestionState |
Uma máscara que indica quais dos campos em |
imagePropertiesSuggestionState |
Uma máscara que indica quais dos campos em |
titleSuggested |
Indica se houve uma alteração sugerida para |
descriptionSuggested |
Indica se houve uma mudança sugerida para |
embeddedObjectBorderSuggestionState |
Uma máscara que indica quais dos campos em |
sizeSuggestionState |
Uma máscara que indica quais campos em |
marginLeftSuggested |
Indica se houve uma mudança sugerida para |
marginRightSuggested |
Indica se houve uma mudança sugerida para |
marginTopSuggested |
Indica se houve uma alteração sugerida para |
marginBottomSuggested |
Indica se houve uma alteração sugerida para |
linkedContentReferenceSuggestionState |
Uma máscara que indica quais campos em |
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 ( |
Campos | |
---|---|
contentUriSuggested |
Indica se houve uma mudança sugerida para |
sourceUriSuggested |
Indica se houve uma alteração sugerida para [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
Indica se houve uma mudança sugerida em [brightness] [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested |
Indica se houve uma mudança sugerida em [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
Indica se houve uma alteração sugerida em [transparência] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
Uma máscara que indica quais dos campos em |
angleSuggested |
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 |
Indica se houve uma mudança sugerida para |
offsetRightSuggested |
Indica se houve uma alteração sugerida para |
offsetTopSuggested |
Indica se houve uma mudança sugerida para |
offsetBottomSuggested |
Indica se houve uma alteração sugerida para |
angleSuggested |
Indica se houve uma alteração sugerida para |
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 |
Indica se houve uma alteração sugerida para [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
Indica se houve uma mudança sugerida em [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
Indica se houve uma mudança sugerida em [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested |
Indica se houve uma mudança sugerida em [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
Uma máscara que indica quais 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 ( |
Campos | |
---|---|
sheetsChartReferenceSuggestionState |
Uma máscara que indica quais dos campos em |
SheetsChartReferenceSuggestionState
Uma máscara que indica quais dos campos na SheetsChartReference
de base foram alterados nesta sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Campos | |
---|---|
spreadsheetIdSuggested |
Indica se houve uma alteração sugerida para |
chartIdSuggested |
Indica se houve uma mudança sugerida para |
PositionedObject
Um objeto vinculado a um Paragraph
e posicionado em relação ao início do parágrafo. Um PositionedObject contém um EmbeddedObject
, como uma imagem.
Representação JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Campos | |
---|---|
objectId |
O ID deste objeto posicionado. |
positionedObjectProperties |
As propriedades deste objeto posicionado. |
suggestedPositionedObjectPropertiesChanges |
As mudanças sugeridas nas propriedades do objeto posicionado, com chave pelo ID da sugestão. |
suggestedInsertionId |
O ID de inserção sugerido. Se estiver vazio, não é uma inserção sugerida. |
suggestedDeletionIds[] |
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 ( |
Campos | |
---|---|
positioning |
O posicionamento desse objeto em relação ao novo parágrafo do |
embeddedObject |
O objeto incorporado deste objeto posicionado. |
PositionedObjectPositioning
O posicionamento de um PositionedObject
. O objeto posicionado é posicionado em relação ao início do Paragraph
ao qual está vinculado.
Representação JSON |
---|
{ "layout": enum ( |
Campos | |
---|---|
layout |
O layout deste objeto posicionado. |
leftOffset |
O deslocamento da borda esquerda do objeto posicionado em relação ao início do |
topOffset |
O deslocamento da borda superior do objeto posicionado em relação ao início do |
PositionedObjectLayout
Os 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 se ajusta ao objeto posicionado. |
BREAK_LEFT |
Interrompe 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 de modo 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 alteração sugerida para PositionedObjectProperties
.
Representação JSON |
---|
{ "positionedObjectProperties": { object ( |
Campos | |
---|---|
positionedObjectProperties |
Um |
positionedObjectPropertiesSuggestionState |
Uma máscara que indica quais campos na base |
PositionedObjectPropertiesSuggestionState
Uma máscara que indica quais campos na base PositionedObjectProperties
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "positioningSuggestionState": { object ( |
Campos | |
---|---|
positioningSuggestionState |
Uma máscara que indica quais campos em |
embeddedObjectSuggestionState |
Uma máscara que indica quais campos em |
PositionedObjectPositioningSuggestionState
Uma máscara que indica quais 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 |
Indica se houve uma alteração sugerida para |
leftOffsetSuggested |
Indica se houve uma mudança sugerida para |
topOffsetSuggested |
Indica se houve uma alteração sugerida para |
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. Este é o modo de visualização de sugestões padrão. |
SUGGESTIONS_INLINE |
O documento retornado tem sugestões inline. As mudanças sugeridas serão diferenciadas do conteúdo básico do documento. As solicitações para recuperar um documento usando esse modo retornarão um erro 403 se o usuário não tiver permissão para visualizar as alterações sugeridas. |
PREVIEW_SUGGESTIONS_ACCEPTED |
O documento retornado é uma visualização com todas as mudanças sugeridas aceitas. As solicitações para recuperar um documento usando esse modo retornarão um erro 403 se o usuário não tiver permissão para visualizar as alterações sugeridas. |
PREVIEW_WITHOUT_SUGGESTIONS |
O documento retornado é uma visualização, e todas as alterações sugeridas são rejeitadas quando há sugestões nele. |
Métodos |
|
---|---|
|
Aplica uma ou mais atualizações ao documento. |
|
Cria um documento em branco usando o título fornecido na solicitação. |
|
Recebe a versão mais recente do documento especificado. |