- Recurso: Document
- Corpo
- StructuralElement (link em inglês)
- Parágrafo
- ParagraphElement
- TextRun
- TextStyle
- OpcionalColor
- Cor
- RgbColor
- Dimensão
- Unidade
- WeightFontFamily
- BaselineOffset (em inglês)
- Link
- SuggestedTextStyle
- TextStyleSuggestionState
- Texto automático
- Tipo
- Quebra de página
- ColumnBreak
- Nota de rodapé
- HorizontalRule
- Equação
- InlineObjectElement
- Pessoa
- PersonProperties
- richLink
- richLinkProperties
- ParagraphStyle
- NamedStyleType
- Alinhamento
- ContentDirection (em inglês)
- SpacingMode (link em inglês)
- ParagraphBorder
- DashStyle (em inglês)
- TabStop
- TabStopAlignment (link em inglês)
- Sombra
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Marcador
- Marcador sugerido
- MarkerSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- Tabela
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- Alinhamento de conteúdo
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties.
- WidthType (em inglês)
- TableOfContents (em inglês)
- Cabeçalho
- Rodapé
- Nota de rodapé
- DocumentStyle
- Segundo plano
- Tamanho
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Lista
- ListProperties
- NestingLevel
- Alinhamento de marcador
- GlyphType (link em inglês)
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- Intervalo
- SuggestionsViewMode
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState (link em inglês)
- LinkedContentReference
- PlanilhasChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState (link em inglês)
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- PlanilhasChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout (em inglês)
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- Métodos
Recurso: Document
Um arquivo do Documentos Google.
Representação JSON |
---|
{ "documentId": string, "title": string, "body": { object ( |
Campos | |
---|---|
documentId |
Apenas saída. ID do documento. |
title |
O título do documento. |
body |
Apenas saída. O corpo principal do documento. |
headers |
Apenas saída. Os cabeçalhos no documento, codificados pelo ID do cabeçalho. |
footers |
Apenas saída. Os rodapés no documento, codificados pelo ID do rodapé. |
footnotes |
Apenas saída. As notas de rodapé no documento, codificadas pelo ID da nota. |
documentStyle |
Apenas saída. O estilo do documento. |
suggestedDocumentStyleChanges |
Apenas saída. São as mudanças sugeridas no estilo do documento, com chave pelo ID da sugestão. |
namedStyles |
Apenas saída. Os estilos nomeados do documento. |
suggestedNamedStylesChanges |
Apenas saída. São as mudanças sugeridas para os estilos nomeados do documento, codificados pelo ID da sugestão. |
lists |
Apenas saída. As listas no documento, codificadas por ID. |
namedRanges |
Apenas saída. Os intervalos nomeados no documento, codificados por nome. |
revisionId |
Apenas saída. O ID de revisão do documento. Pode ser usado em solicitações de atualização para especificar a qual revisão de um documento as atualizações serão aplicadas e como a solicitação deve se comportar se o documento tiver sido editado desde essa revisão. Preenchido apenas se o usuário tiver acesso para editar o documento. O ID de revisão não é um número sequencial, mas uma string opaca. O formato do ID de revisão pode mudar com o tempo. Um ID de revisão retornado só é válido por 24 horas após ser retornado e não pode ser compartilhado entre os usuários. Se o ID de revisão não foi alterado entre as chamadas, o documento não foi alterado. Por outro lado, um ID alterado (para o mesmo documento e usuário) geralmente significa que o documento foi atualizado. No entanto, isso também pode acontecer por fatores internos, como mudanças no formato do documento. |
suggestionsViewMode |
Apenas saída. O modo de visualização de sugestões aplicado ao documento. Observação: ao editar um documento, as alterações precisam ser baseadas em um documento com |
inlineObjects |
Apenas saída. Os objetos inline no documento, codificados pelo ID do objeto. |
positionedObjects |
Apenas saída. Os objetos posicionados no documento, codificados pelo ID do objeto. |
Body
O corpo do documento.
O corpo normalmente 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 do conteúdo do corpo começam em zero. |
Elemento Estrutural
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, baseado em zero, desse elemento estrutural, exclusivo, em unidades de código UTF-16. |
Campo de união content . O conteúdo do elemento estrutural. content pode ser apenas de um dos tipos a seguir: |
|
paragraph |
Um tipo de parágrafo de elemento estrutural. |
sectionBreak |
Um tipo de quebra de seção de elemento estrutural. |
table |
Um tipo de tabela de elemento estrutural. |
tableOfContents |
Um tipo de índice de elemento estrutural. |
Parágrafo
Um StructuralElement
que representa um parágrafo. Um parágrafo é um intervalo de conteúdo que é encerrado com um caractere de nova linha.
Representação JSON |
---|
{ "elements": [ { object ( |
Campos | |
---|---|
elements[] |
O conteúdo do parágrafo, dividido em partes componentes. |
paragraphStyle |
O estilo deste parágrafo. |
suggestedParagraphStyleChanges |
O estilo sugerido muda para este parágrafo, codificado pelo ID da sugestão. |
bullet |
O marcador deste parágrafo. Se ausente, o parágrafo não pertencerá a uma lista. |
suggestedBulletChanges |
As alterações sugeridas para o marcador deste parágrafo. |
positionedObjectIds[] |
Os IDs dos objetos posicionados vinculados a este parágrafo. |
suggestedPositionedObjectIds |
Os IDs dos objetos posicionados sugeridos para serem anexados a este parágrafo, codificados pelo ID da sugestão. |
ParagraphElement
Um ParagraphElement descreve o conteúdo em um Paragraph
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
O índice inicial baseado em zero desse elemento de parágrafo, em unidades de código UTF-16. |
endIndex |
O índice final de base zero desse elemento de parágrafo, exclusivo, em unidades de código UTF-16. |
Campo de união content . O conteúdo do elemento do parágrafo. content pode ser apenas de um dos tipos a seguir: |
|
textRun |
Um elemento de parágrafo de execução de texto. |
autoText |
Um elemento de parágrafo de texto automático. |
pageBreak |
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 da nota de rodapé. |
horizontalRule |
Um elemento de parágrafo de regra horizontal. |
equation |
Um elemento de parágrafo de equação. |
inlineObjectElement |
Um elemento de parágrafo de objeto inline. |
person |
Um elemento de parágrafo que se vincula a uma pessoa ou a um endereço de e-mail. |
richLink |
Um elemento de parágrafo que direciona a um recurso do Google (como um arquivo no Google Drive, um vídeo do YouTube ou um evento do Google Agenda). |
TextRun
Uma ParagraphElement
que representa uma sequência de texto em que todas têm o mesmo estilo.
Representação JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
content |
O texto da execução. Todos os elementos não textuais na execução serã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 haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto da execução. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para esta 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 é definido:
- O TextStyle de texto em uma
Paragraph
herda danamed style type
correspondente do parágrafo. - O TextStyle em um
named style
é herdado do estilo nomeado donormal text
. - O TextStyle do estilo nomeado do
normal text
é herdado do estilo de texto padrão nos Editores 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, a remoção da configuração dos campos reverterá o estilo para um valor correspondente aos padrões nos Editores de arquivos Google.
Representação JSON |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
Campos | |
---|---|
bold |
Indica se o texto é renderizado em negrito ou não. |
italic |
Se o texto está ou não em itálico. |
underline |
Indica se o texto está sublinhado ou não. |
strikethrough |
Se o texto é tachado ou não. |
smallCaps |
Se o texto está ou não em letras maiúsculas pequenas. |
backgroundColor |
A cor do plano 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 a espessura renderizada 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 linha de base |
link |
O destino do hiperlink do texto. Se ela for deixada sem definição, não haverá um link. Os links não são herdados do texto pai. Alterar o link em uma solicitação de atualização causa algumas outras alterações no estilo de texto do intervalo:
|
Cor opcional
Uma cor que pode ser totalmente opaca ou totalmente transparente.
Representação JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Se definido, ele vai ser usado como uma cor opaca. Se não for definido, representa uma cor transparente. |
Cor
Uma cor sólida.
Representação JSON |
---|
{
"rgbColor": {
object ( |
Campos | |
---|---|
rgbColor |
O valor da cor RGB. |
Cor RGB
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. |
WeightFontFamily
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. Você pode escolher qualquer fonte no menu "Fontes" do 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 representa apenas um componente da espessura da fonte renderizada. Uma combinação de
|
BaselineOffset
As formas como o texto pode ser deslocado verticalmente em relação à posição normal.
Enums | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
O deslocamento da linha de base 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 um recurso de URL externo.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união destination . Destino do link. destination pode ser apenas de um dos tipos a seguir: |
|
url |
Um URL externo. |
bookmarkId |
O ID de um favorito neste documento. |
headingId |
O ID de um título neste documento. |
SuggestedTextStyle
Uma mudança sugerida em um TextStyle
.
Representação JSON |
---|
{ "textStyle": { object ( |
Campos | |
---|---|
textStyle |
Um |
textStyleSuggestionState |
Uma máscara que indica quais dos campos na base |
TextStyleSuggestionState
Uma máscara que indica quais dos campos na base TextStyle
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
Campos | |
---|---|
boldSuggested |
Indica se houve uma mudança sugerida em |
italicSuggested |
Indica se houve uma mudança sugerida em |
underlineSuggested |
Indica se houve uma mudança sugerida em |
strikethroughSuggested |
Indica se houve uma mudança sugerida em |
smallCapsSuggested |
Indica se houve uma mudança sugerida em |
backgroundColorSuggested |
Indica se houve uma mudança sugerida em |
foregroundColorSuggested |
Indica se houve uma mudança sugerida em |
fontSizeSuggested |
Indica se houve uma mudança sugerida em |
weightedFontFamilySuggested |
Indica se houve uma mudança sugerida em |
baselineOffsetSuggested |
Indica se houve uma mudança sugerida em |
linkSuggested |
Indica se houve uma mudança sugerida em |
Texto automático
Um ParagraphElement
que representa um ponto no texto que é dinamicamente substituído por um conteúdo que pode mudar ao longo do tempo, como um número de página.
Representação JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
O tipo desse texto automático. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto desse AutoText. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para esse AutoText, codificado pelo ID da sugestão. |
Tipo
Os tipos de texto automático.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Um tipo de texto automático não especificado. |
PAGE_NUMBER |
Tipo de texto automático que representa o número da página atual. |
PAGE_COUNT |
Tipo de texto automático que representa o número total de páginas no documento. |
Quebra de página
Um ParagraphElement
que representa uma quebra de página. Uma quebra de página faz o texto seguinte começar na parte superior 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 haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto desta quebra de página. Semelhante ao conteúdo de texto, como execuções de texto e referências à nota de rodapé, o estilo de 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 esta quebra de página, codificada pelo ID da sugestão. |
Quebra de coluna
Um ParagraphElement
que representa uma quebra de coluna. Uma quebra de coluna faz com que o texto seguinte comece na parte de cima da coluna seguinte.
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 haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto desse ColumnBreak. Semelhante ao conteúdo de texto, como execuções de texto e referências à nota de rodapé, o estilo de texto de uma quebra de coluna pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para este ColumnBreak, codificado pelo ID da sugestão. |
Referência da nota de rodapé
Um ParagraphElement
que representa uma referência da 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 de rodapé.
Representação JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
footnoteId |
O ID do |
footnoteNumber |
O número renderizado desta nota de rodapé. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto desta nota de rodapé. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para essa FootnoteReference, codificada pelo ID de sugestão. |
HorizontalRule
Um ParagraphElement
que representa uma linha horizontal.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto dessa HorizontalRule. Semelhante ao conteúdo de texto, como execuções de texto e referências à nota de rodapé, o estilo de texto de uma regra horizontal pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para essa HorizontalRule, codificado pelo ID da sugestão |
Equação
Um ParagraphElement
que representa uma equação.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Campos | |
---|---|
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
ElementoInlineObjectElement
Um ParagraphElement
que contém um InlineObject
.
Representação JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
inlineObjectId |
O ID do |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
textStyle |
O estilo de texto desse InlineObjectElement. Semelhante ao conteúdo de texto, como execuções de texto e referências à nota 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 |
O estilo de texto sugerido muda para esse InlineObject, codificado pelo 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 para sugestões que inserem o link desta pessoa no documento. Uma |
suggestedDeletionIds[] |
IDs das sugestões que removem o link desta pessoa do documento. Uma |
textStyle |
O estilo de texto de |
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 aparecer 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 |
Rich link
Um link para um recurso do Google, como um arquivo no Drive, um vídeo do YouTube ou um evento do Google Agenda.
Representação JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
richLinkId |
Apenas saída. O ID desse link. |
suggestedInsertionIds[] |
IDs de sugestões que inserem esse link no documento. Uma |
suggestedDeletionIds[] |
IDs das sugestões que removem esse link do documento. Uma |
textStyle |
O estilo de texto de |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para |
richLinkProperties |
Apenas saída. As propriedades desse |
Propriedades RichLink
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 do |
mimeType |
Apenas saída. O tipo MIME da |
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 é definido:
- O ParagraphStyle em um
Paragraph
herda 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
é herdado do estilo de parágrafo padrão no Editor de arquivos Google. - O ParagraphStyle em um elemento
Paragraph
contido em uma tabela pode herdar o estilo de parágrafo dele do estilo de tabela.
Se o estilo de parágrafo não for herdado de um pai, a remoção da configuração dos campos reverterá o estilo para um valor correspondente aos padrões nos Editores de arquivos Google.
Representação JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Campos | |
---|---|
headingId |
O ID do título do parágrafo. Se estiver vazio, esse parágrafo não será um título. Esta propriedade é somente leitura. |
namedStyleType |
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 de as outras propriedades serem 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 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 os parágrafos seguintes e anteriores. Se não for definido, o valor será herdado do pai. A borda intermediária é renderizada quando o parágrafo adjacente tem as mesmas propriedades de borda e recuo. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda precisa ser especificada por completo. |
borderTop |
A borda na parte superior deste parágrafo. Se não for definido, o valor será herdado do pai. A borda superior é renderizada quando o parágrafo acima tem propriedades de borda e recuo diferentes. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda precisa ser especificada por completo. |
borderBottom |
A borda na parte inferior deste parágrafo. Se não for definido, o valor será herdado do pai. A borda inferior é renderizada quando o parágrafo abaixo tem propriedades de borda e recuo diferentes. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda precisa ser especificada por completo. |
borderLeft |
A borda à esquerda deste parágrafo. Se não for definido, o valor será herdado do pai. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda precisa ser especificada por completo. |
borderRight |
A borda à direita deste parágrafo. Se não for definido, o valor será herdado do pai. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda precisa ser especificada por completo. |
indentFirstLine |
A quantidade de recuo para a primeira linha do parágrafo. Se não for definido, o valor será herdado do pai. |
indentStart |
A quantidade de recuo para o 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 para o 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 das guias é interrompida para esse parágrafo. A lista de paradas de tabulação não é herdada. Esta propriedade é somente leitura. |
keepLinesTogether |
Define se todas as linhas do parágrafo devem ser dispostas na mesma página ou coluna, se possível. Se não for definido, o valor será herdado do pai. |
keepWithNext |
Define se pelo menos 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 |
Define se viúvas e órfãos devem ser evitadas 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 sempre deve começar no início de uma página. Se não for definido, o valor será herdado do pai. A tentativa de atualizar |
TipoDeEstiloNomeado
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 |
Subtítulo. |
HEADING_1 |
Título 1. |
HEADING_2 |
Título 2. |
HEADING_3 |
Título 3. |
HEADING_4 |
Título 4. |
HEADING_5 |
Título 5. |
HEADING_6 |
Título 6. |
Alinhamento
Os tipos de alinhamento de texto para um parágrafo.
Enums | |
---|---|
ALIGNMENT_UNSPECIFIED |
O alinhamento do parágrafo é herdado do pai. |
START |
O parágrafo é alinhado ao início da linha. Alinhamento à esquerda para texto LTR. Caso contrário, alinhamento à direita. |
CENTER |
O parágrafo está centralizado. |
END |
O parágrafo é alinhado ao fim da linha. Alinhado à direita para texto LTR. Caso contrário, alinhamento à esquerda. |
JUSTIFIED |
O parágrafo é justificado. |
Direção do conteúdo
O conteúdo das rotas pode fluir.
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. |
Modo de espaçamento
Os diferentes modos de espaçamento de parágrafo.
Enums | |
---|---|
SPACING_MODE_UNSPECIFIED |
O modo de espaçamento é herdado do principal. |
NEVER_COLLAPSE |
O espaçamento entre parágrafos é sempre renderizado. |
COLLAPSE_LISTS |
O espaçamento de parágrafo entre elementos de lista é ignorado. |
Borda do parágrafo
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 |
Padding da borda. |
dashStyle |
O estilo do traço da borda. |
Travessão
Os tipos de traços com os quais a geometria linear pode ser renderizada. Esses valores são baseados no tipo simples "ST_PresetLineDashVal" descrito na seção 20.1.10.48 de "Formatos de arquivos XML Open do Office - Fundamentos e referência da linguagem de marcação", parte 1 da ECMA-376 4a 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. Este é o estilo de traço padrão. |
DOT |
Linha pontilhada. Corresponde ao valor "ponto" de ECMA-376 ST_PresetLineDashVal. |
DASH |
Linha tracejada. Corresponde ao valor "dash" de ECMA-376 ST_PresetLineDashVal. |
Parar tab
Uma parada de tabulação em um parágrafo.
Representação JSON |
---|
{ "offset": { object ( |
Campos | |
---|---|
offset |
O deslocamento entre esta parada de tabulação e a margem inicial. |
alignment |
O alinhamento desta guia é interrompido. Se não for definido, o valor padrão será |
TabStopAlignment
O alinhamento da parada de tabulação.
Enums | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
O alinhamento da parada de tabulação não foi especificado. |
START |
A parada de tabulação está alinhada ao início da linha. Esse é o padrão. |
CENTER |
A parada de tabulação está alinhada ao centro da linha. |
END |
A parada de tabulação é alinhada ao fim da linha. |
Sombreamento
O sombreamento de um parágrafo.
Representação JSON |
---|
{
"backgroundColor": {
object ( |
Campos | |
---|---|
backgroundColor |
É a cor do plano de fundo desse sombreamento de parágrafo. |
SuggestedParagraphStyle
Uma mudança sugerida em um ParagraphStyle
.
Representação JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraphStyle |
Um |
paragraphStyleSuggestionState |
Uma máscara que indica quais dos campos na base |
ParagraphStyleSuggestionState
Uma máscara que indica quais dos campos na base ParagraphStyle
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{
"headingIdSuggested": boolean,
"namedStyleTypeSuggested": boolean,
"alignmentSuggested": boolean,
"lineSpacingSuggested": boolean,
"directionSuggested": boolean,
"spacingModeSuggested": boolean,
"spaceAboveSuggested": boolean,
"spaceBelowSuggested": boolean,
"borderBetweenSuggested": boolean,
"borderTopSuggested": boolean,
"borderBottomSuggested": boolean,
"borderLeftSuggested": boolean,
"borderRightSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"indentEndSuggested": boolean,
"keepLinesTogetherSuggested": boolean,
"keepWithNextSuggested": boolean,
"avoidWidowAndOrphanSuggested": boolean,
"shadingSuggestionState": {
object ( |
Campos | |
---|---|
headingIdSuggested |
Indica se houve uma mudança sugerida em |
namedStyleTypeSuggested |
Indica se houve uma mudança sugerida em |
alignmentSuggested |
Indica se houve uma mudança sugerida em |
lineSpacingSuggested |
Indica se houve uma mudança sugerida em |
directionSuggested |
Indica se houve uma mudança sugerida em |
spacingModeSuggested |
Indica se houve uma mudança sugerida em |
spaceAboveSuggested |
Indica se houve uma mudança sugerida em |
spaceBelowSuggested |
Indica se houve uma mudança sugerida em |
borderBetweenSuggested |
Indica se houve uma mudança sugerida em |
borderTopSuggested |
Indica se houve uma mudança sugerida em |
borderBottomSuggested |
Indica se houve uma mudança sugerida em |
borderLeftSuggested |
Indica se houve uma mudança sugerida em |
borderRightSuggested |
Indica se houve uma mudança sugerida em |
indentFirstLineSuggested |
Indica se houve uma mudança sugerida em |
indentStartSuggested |
Indica se houve uma mudança sugerida em |
indentEndSuggested |
Indica se houve uma mudança sugerida em |
keepLinesTogetherSuggested |
Indica se houve uma mudança sugerida em |
keepWithNextSuggested |
Indica se houve uma mudança sugerida em |
avoidWidowAndOrphanSuggested |
Indica se houve uma mudança sugerida em |
shadingSuggestionState |
Uma máscara que indica quais dos campos em |
pageBreakBeforeSuggested |
Indica se houve uma mudança sugerida em |
ShadingSuggestionState
Uma máscara que indica quais dos campos na base Shading
foram alterados nessa mudança sugerida. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica se houve uma mudança sugerida no |
Marcador
Descreve um marcador de um parágrafo.
Representação JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Campos | |
---|---|
listId |
O ID da lista a que este parágrafo pertence. |
nestingLevel |
O nível de aninhamento deste parágrafo na lista. |
textStyle |
O estilo de texto específico do parágrafo aplicado a este marcador. |
Marcador sugerido
Uma mudança sugerida em um Bullet
.
Representação JSON |
---|
{ "bullet": { object ( |
Campos | |
---|---|
bullet |
Um |
bulletSuggestionState |
Uma máscara que indica quais dos campos na base |
MarkerSuggestionState
Uma máscara que indica quais dos campos na base Bullet
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
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 dos campos em |
ObjectReferences
Uma coleção de IDs de objetos.
Representação JSON |
---|
{ "objectIds": [ string ] } |
Campos | |
---|---|
objectIds[] |
Os IDs de objeto. |
Quebra de seção
Um StructuralElement
que representa uma quebra de seção. Uma seção é um intervalo de conteúdo que tem a mesma SectionStyle
. Uma quebra de seção representa o início de uma nova seção, e o estilo é aplicado à seção após a quebra de seção.
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 haverá exclusões sugeridas desse conteúdo. |
sectionStyle |
O estilo da seção após esta quebra de seção. |
Estilo da seção
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 terá uma coluna com as propriedades padrão nos Editores de arquivos Google. Uma seção pode ser atualizada para ter no máximo três colunas. Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa propriedade resulta em um erro 400 de solicitação inválida. |
columnSeparatorStyle |
Estilo dos separadores de coluna. Esse estilo pode ser definido mesmo quando há uma coluna na seção. Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa 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 esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa propriedade resulta em um erro 400 de solicitação inválida. |
marginTop |
A margem superior da página da seção. Se não for definido, o valor padrão de DocumentStyle será Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa propriedade resulta em um erro 400 de solicitação inválida. |
marginBottom |
A margem inferior da seção. Se não for definido, o valor padrão de DocumentStyle será Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa propriedade resulta em um erro 400 de solicitação inválida. |
marginRight |
A margem direita da página da seção. Se não for definido, o valor padrão de DocumentStyle será Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa propriedade resulta em um erro 400 de solicitação inválida. |
marginLeft |
A margem esquerda da página da seção. Se não for definido, o valor padrão de DocumentStyle será Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa 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 de DocumentStyle será Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa 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 de DocumentStyle será Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa 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 vai ser herdado doSectionStyle do Esta propriedade é somente leitura. |
defaultFooterId |
O ID do rodapé padrão. Se não for definido, o valor vai ser herdado doSectionStyle do Esta propriedade é somente leitura. |
firstPageHeaderId |
O ID do cabeçalho usado somente 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 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 herdará do Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa propriedade resulta em um erro 400 de solicitação inválida. |
pageNumberStart |
O número da página a partir da qual iniciar a contagem do número de páginas da seção. Se ela não for definida, a numeração das páginas continuará da seção anterior. Se o valor não for definido na primeira Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa propriedade resulta em um erro 400 de solicitação inválida. |
flipPageOrientation |
Opcional. Indica se as dimensões do Ao atualizar esta propriedade, é necessário definir um valor concreto. A desconfiguração dessa propriedade resulta em um erro 400 de solicitação inválida. |
Propriedades de coluna
Propriedades que se aplicam à coluna de uma seção.
Representação JSON |
---|
{ "width": { object ( |
Campos | |
---|---|
width |
Apenas saída. A largura da coluna. |
paddingEnd |
Padding no final da coluna. |
ColumnSeparatorStyle
Estilo dos separadores de coluna entre colunas.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Um estilo de separador de coluna não especificado. |
NONE |
Não há linhas separadoras 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. Uma tabela pode não ser 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. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
tableStyle |
O estilo da tabela. |
TableRow
O conteúdo e o estilo de uma linha em uma Table
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
Campos | |
---|---|
startIndex |
É o índice inicial baseado em zero desta linha, em unidades de código UTF-16. |
endIndex |
O índice final desta linha, exclusivo, baseado em zero, em unidades de código UTF-16. |
tableCells[] |
O conteúdo e o estilo de cada célula nesta linha. Uma tabela pode não ser retangular, portanto, algumas linhas podem ter um número de células diferente do que outras linhas na mesma tabela. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
tableRowStyle |
O estilo da linha da tabela. |
suggestedTableRowStyleChanges |
O estilo sugerido muda para esta linha, codificado pelo ID da sugestão. |
TableCell
O conteúdo e o estilo de uma célula em uma Table
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Campos | |
---|---|
startIndex |
O índice inicial baseado em zero desta célula, em unidades de código UTF-16. |
endIndex |
O índice final baseado 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 haverá exclusões sugeridas desse conteúdo. |
suggestedTableCellStyleChanges |
As mudanças sugeridas para o estilo da célula da tabela, codificadas pelo ID da sugestão. |
TableCellStyle
O estilo de uma TableCell
.
Os estilos de célula da tabela herdada 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 |
O período da linha da célula. Esta propriedade é somente leitura. |
columnSpan |
O período 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 direito 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 nos Editores de arquivos Google. |
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 sua 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 do traço da borda. |
Alinhamento de conteúdo
Os tipos de alinhamento de conteúdo.
Derivado de um subconjunto dos valores do tipo simples "ST_TextAnchoringType" na seção 20.1.10.59 de "Formatos de arquivos XML abertos do Office - conceitos básicos e referência da linguagem de marcação", parte 1 da ECMA-376 4a edição.
Enums | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Um alinhamento de conteúdo não especificado. O alinhamento do conteúdo é herdado do pai, se houver. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Um alinhamento de conteúdo incompatível. |
TOP |
Um alinhamento que alinha o conteúdo à parte superior do detentor de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType "t". |
MIDDLE |
Um alinhamento que alinha o conteúdo ao meio do detentor de conteúdo. Corresponde a ST_TextAnchoringType "ctr" ECMA-376. |
BOTTOM |
Um alinhamento que alinha o conteúdo à parte de baixo do detentor. Corresponde a ECMA-376 ST_TextAnchoringType "b". |
SuggestedTableCellStyle
Uma mudança sugerida em um TableCellStyle
.
Representação JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
tableCellStyle |
Um |
tableCellStyleSuggestionState |
Uma máscara que indica quais dos campos na base |
TableCellStyleSuggestionState
Uma máscara que indica quais dos campos na base TableCellStyle
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
Campos | |
---|---|
rowSpanSuggested |
Indica se houve uma mudança sugerida em |
columnSpanSuggested |
Indica se houve uma mudança sugerida em |
backgroundColorSuggested |
Indica se houve uma mudança sugerida em |
borderLeftSuggested |
Indica se houve uma mudança sugerida em |
borderRightSuggested |
Indica se houve uma mudança sugerida em |
borderTopSuggested |
Indica se houve uma mudança sugerida em |
borderBottomSuggested |
Indica se houve uma mudança sugerida em |
paddingLeftSuggested |
Indica se houve uma mudança sugerida em |
paddingRightSuggested |
Indica se houve uma mudança sugerida em |
paddingTopSuggested |
Indica se houve uma mudança sugerida em |
paddingBottomSuggested |
Indica se houve uma mudança sugerida em |
contentAlignmentSuggested |
Indica se houve uma mudança sugerida em |
TableRowStyle
Estilos que se aplicam a uma linha da tabela.
Representação JSON |
---|
{
"minRowHeight": {
object ( |
Campos | |
---|---|
minRowHeight |
A altura mínima da linha. A linha será renderizada no Editor do Documentos com uma altura igual ou maior que este valor para mostrar todo o conteúdo nas células da linha. |
tableHeader |
Se a linha é um cabeçalho de tabela. |
preventOverflow |
Indica se a linha não pode ultrapassar os limites da página ou da coluna. |
SuggestedTableRowStyle
Uma mudança sugerida em um TableRowStyle
.
Representação JSON |
---|
{ "tableRowStyle": { object ( |
Campos | |
---|---|
tableRowStyle |
Um |
tableRowStyleSuggestionState |
Uma máscara que indica quais dos campos na base |
TableRowStyleSuggestionState
Uma máscara que indica quais dos campos na base TableRowStyle
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "minRowHeightSuggested": boolean } |
Campos | |
---|---|
minRowHeightSuggested |
Indica se houve uma mudança sugerida em |
Estilo de tabela
Estilos que se aplicam a uma tabela.
Representação JSON |
---|
{
"tableColumnProperties": [
{
object ( |
Campos | |
---|---|
tableColumnProperties[] |
As propriedades de cada coluna. No Documentos, as tabelas têm linhas, e as linhas contêm células, semelhantes ao HTML. Portanto, as propriedades de uma linha podem ser encontradas no |
Propriedades de Coluna da Tabela
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 |
Tipo de largura
O tipo de largura da coluna.
Enums | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
O tipo de largura da coluna não foi especificado. |
EVENLY_DISTRIBUTED |
A largura da coluna é distribuída uniformemente entre as outras colunas de distribuição uniforme. A largura da coluna é determinada automaticamente e terá uma parte igual da largura restante para a tabela depois de contabilizar 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. |
Índice
Um StructuralElement
que representa um índice.
Representação JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
O conteúdo do índice. |
suggestedInsertionIds[] |
Os IDs de inserção sugeridos. Uma |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
Cabeçalho
Um cabeçalho de documento.
Representação JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
Campos | |
---|---|
headerId |
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 |
Plano de fundo do documento. Os documentos não podem ter uma cor de fundo transparente. |
defaultHeaderId |
O ID do cabeçalho padrão. Se não for definido, não haverá cabeçalho padrão. Esta propriedade é somente leitura. |
defaultFooterId |
O ID do rodapé padrão. Se não for definido, 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, não haverá um cabeçalho exclusivo para a primeira página. O valor de Esta propriedade é somente leitura. |
firstPageFooterId |
O ID do rodapé usado apenas para a primeira página. Se não for definido, não haverá um rodapé exclusivo para a primeira página. O valor de Esta propriedade é somente leitura. |
useFirstPageHeaderFooter |
Indica se os IDs do cabeçalho / rodapé da primeira página precisam ser usados na primeira página. |
useEvenPageHeaderFooter |
Indica se os IDs de cabeçalho / rodapé de página par devem ser usados para as páginas pares. |
pageNumberStart |
O número da página a partir da qual iniciar a contagem de páginas. |
marginTop |
A margem superior da página. Atualizar a margem superior da página no estilo do documento limpa a margem superior da página em todos os estilos de seção. |
marginBottom |
A margem inferior da página. Atualizar a margem inferior da página no estilo do documento limpa a margem inferior em todos os estilos de seção. |
marginRight |
A margem da página à direita. 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 |
A margem esquerda da página. Atualizar a margem esquerda da página no estilo do documento limpa a margem esquerda 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. |
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 de baixo 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
Uma largura e uma 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 base |
DocumentStyleSuggestionState
Uma máscara que indica quais dos campos na base DocumentStyle
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "backgroundSuggestionState": { object ( |
Campos | |
---|---|
backgroundSuggestionState |
Uma máscara que indica quais dos campos em |
defaultHeaderIdSuggested |
Indica se houve uma mudança sugerida em |
defaultFooterIdSuggested |
Indica se houve uma mudança sugerida em |
evenPageHeaderIdSuggested |
Indica se houve uma mudança sugerida em |
evenPageFooterIdSuggested |
Indica se houve uma mudança sugerida em |
firstPageHeaderIdSuggested |
Indica se houve uma mudança sugerida em |
firstPageFooterIdSuggested |
Indica se houve uma mudança sugerida em |
useFirstPageHeaderFooterSuggested |
Indica se houve uma mudança sugerida em |
useEvenPageHeaderFooterSuggested |
Indica se houve uma mudança sugerida em |
pageNumberStartSuggested |
Indica se houve uma mudança sugerida em |
marginTopSuggested |
Indica se houve uma mudança sugerida em |
marginBottomSuggested |
Indica se houve uma mudança sugerida em |
marginRightSuggested |
Indica se houve uma mudança sugerida em |
marginLeftSuggested |
Indica se houve uma mudança sugerida em |
pageSizeSuggestionState |
Uma máscara que indica quais dos campos em [size] [google.apps.docs.v1.DocumentStyle.size] foram alterados nessa sugestão. |
marginHeaderSuggested |
Indica se houve uma mudança sugerida em |
marginFooterSuggested |
Indica se houve uma mudança sugerida em |
useCustomHeaderFooterMarginsSuggested |
Indica se houve uma mudança sugerida em |
flipPageOrientationSuggested |
Opcional. Indica se houve uma mudança sugerida em |
BackgroundSuggestionState
Uma máscara que indica quais dos campos na base Background
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, o Backgound
tem um novo valor sugerido.
Representação JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica se a cor de fundo atual foi modificada nessa sugestão. |
SizeSuggestionState
Uma máscara que indica quais dos campos na base Size
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, o Size
tem um novo valor sugerido.
Representação JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Campos | |
---|---|
heightSuggested |
Indica se houve uma mudança sugerida em |
widthSuggested |
Indica se houve uma mudança sugerida em |
Estilos nomeados
Os estilos nomeados. Os parágrafos do documento podem herdar a TextStyle
e a ParagraphStyle
desses estilos nomeados.
Representação JSON |
---|
{
"styles": [
{
object ( |
Campos | |
---|---|
styles[] |
Os estilos nomeados. Há uma entrada para cada um dos |
Estilo nomeado
Um estilo nomeado. Os parágrafos do documento podem herdar a TextStyle
e a ParagraphStyle
desse estilo quando tiverem o mesmo tipo.
Representação JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
namedStyleType |
O tipo desse estilo nomeado. |
textStyle |
O estilo de texto desse estilo nomeado. |
paragraphStyle |
O estilo de parágrafo desse estilo nomeado. |
SuggestedNamedStyles
Uma mudança sugerida no NamedStyles
.
Representação JSON |
---|
{ "namedStyles": { object ( |
Campos | |
---|---|
namedStyles |
Um |
namedStylesSuggestionState |
Uma máscara que indica quais dos campos na base |
NamedStylesSuggestionState
O estado de sugestão de uma mensagem NamedStyles
.
Representação JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
Campos | |
---|---|
stylesSuggestionStates[] |
Uma máscara que indica quais dos 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 a que esse estado de sugestão corresponde. Esse campo é fornecido como uma conveniência para corresponder o NamedStyleSuggestionState com o |
textStyleSuggestionState |
Uma máscara que indica quais dos campos em |
paragraphStyleSuggestionState |
Uma máscara que indica quais dos campos em |
Lista
Uma lista representa os atributos de lista de um grupo de parágrafos que pertencem à mesma lista. Um parágrafo que faz parte de uma lista tem uma referência ao ID da lista no bullet
.
Representação JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Propriedades da lista. |
suggestedListPropertiesChanges |
Mudanças sugeridas para as propriedades da lista, codificadas pelo ID da sugestão. |
suggestedInsertionId |
É o ID de inserção sugerido. Se estiver vazio, a inserção não vai ser sugerida. |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazia, não haverá exclusões sugeridas para essa lista. |
Propriedades de lista
As propriedades de um list
que descrevem a aparência dos marcadores que pertencem a parágrafos associados a uma lista.
Representação JSON |
---|
{
"nestingLevels": [
{
object ( |
Campos | |
---|---|
nestingLevels[] |
Descreve as propriedades dos marcadores no nível associado. Uma lista tem no máximo nove níveis de aninhamento, sendo o nível 0 correspondente ao nível mais alto e o nível 8 de aninhamento correspondente ao nível mais aninhado. Os níveis de aninhamento são retornados em ordem crescente, com o menos aninhado retornado primeiro. |
Nível de aninhamento
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 renderização. |
glyphFormat |
A string de formatação usada pelos marcadores nesse 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 de Por exemplo, o formato de glifo
O formato de glifo pode conter marcadores de posição para o nível de aninhamento atual, bem como marcadores de posição 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. Aplicado ao lado que corresponde ao início do texto, com base na direção do conteúdo do parágrafo. |
textStyle |
O estilo de texto dos marcadores nesse nível de aninhamento. |
startNumber |
O número do primeiro item da lista neste nível de aninhamento. Um valor de 0 é tratado como o valor 1 para listas com letras e numerais romanos. Para valores de 0 e 1, listas de algarismos com letras e romanos começam em Esse valor é ignorado para níveis de aninhamento com glifos não ordenados. |
Campo de união glyph_kind . O tipo de glifo usado pelos marcadores. Isso define o símbolo que substitui os marcadores de posição na glyph_format . glyph_kind pode ser apenas de um dos tipos a seguir: |
|
glyphType |
O tipo de glifo usado pelos marcadores quando os parágrafos nesse nível de aninhamento estão ordenados. O tipo de glifo determina o tipo usado para substituir os marcadores de posição no |
glyphSymbol |
Um símbolo de glifo personalizado usado por marcadores quando os parágrafos nesse nível de aninhamento não estão ordenados. O símbolo de glifo substitui os marcadores de posição no |
Alinhamento de marcador
Os tipos de alinhamento de um marcador.
Enums | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
O alinhamento do marcador não foi especificado. |
START |
O marcador é alinhado ao início do espaço alocado para renderização. Alinhamento à esquerda para texto LTR. Caso contrário, alinhamento à direita. |
CENTER |
O marcador é alinhado ao centro do espaço alocado para renderizar o marcador. |
END |
O marcador é alinhado ao fim do espaço alocado para renderização. Alinhado à direita para texto LTR. Caso contrário, alinhamento à esquerda. |
Tipo de glifo
Os tipos de glifos usados pelos marcadores quando os parágrafos nesse nível de aninhamento estão ordenados.
Enums | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
O tipo de glifo não foi especificado ou não é compatível. |
NONE |
Uma string vazia. |
DECIMAL |
Um número, como 1 , 2 ou 3 . |
ZERO_DECIMAL |
Um número em que números de um único dígito 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 algarismo romano minúsculo, como i , ii ou iii . |
SuggestedListProperties
Uma mudança sugerida em ListProperties
.
Representação JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
Um |
listPropertiesSuggestionState |
Uma máscara que indica quais dos campos na base |
ListPropertiesSuggestionState
Uma máscara que indica quais dos campos na base ListProperties
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Campos | |
---|---|
nestingLevelsSuggestionStates[] |
Uma máscara que indica quais dos campos no 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 base NestingLevel
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
bulletAlignmentSuggested |
Indica se houve uma mudança sugerida em |
glyphTypeSuggested |
Indica se houve uma mudança sugerida em |
glyphFormatSuggested |
Indica se houve uma mudança sugerida em |
glyphSymbolSuggested |
Indica se houve uma mudança sugerida em |
indentFirstLineSuggested |
Indica se houve uma mudança sugerida em |
indentStartSuggested |
Indica se houve uma mudança sugerida em |
textStyleSuggestionState |
Uma máscara que indica quais dos campos em |
startNumberSuggested |
Indica se houve uma mudança sugerida em |
Intervalos nomeados
Uma coleção de todos os NamedRange
s no documento que compartilham um determinado nome.
Representação JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Campos | |
---|---|
name |
O nome que todos os |
namedRanges[] |
Os |
IntervaloNomeado
Uma coleção de Range
s com o mesmo ID de intervalo nomeado.
Com os intervalos nomeados, os desenvolvedores podem associar partes de um documento a um marcador arbitrário definido pelo usuário para que o conteúdo possa ser lido ou editado de forma programática mais tarde. Um documento pode conter vários intervalos nomeados com o mesmo nome, mas cada um deles tem um ID exclusivo.
Um intervalo nomeado é criado com um único Range
, e o conteúdo inserido dentro de um intervalo nomeado geralmente o expande. No entanto, determinadas alterações em documentos podem fazer com que o intervalo seja dividido em vários intervalos.
Os intervalos nomeados não são particulares. Todos os aplicativos e colaboradores com acesso ao documento podem ver os intervalos nomeados.
Representação JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Campos | |
---|---|
namedRangeId |
ID do intervalo nomeado. |
name |
O nome do intervalo nomeado. |
ranges[] |
Os intervalos que pertencem a esse intervalo nomeado. |
Intervalo
Especifica um intervalo contíguo de texto.
Representação JSON |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer } |
Campos | |
---|---|
segmentId |
O ID do cabeçalho, rodapé ou nota de rodapé em que esse intervalo está contido. Um ID de segmento vazio indica 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 baseado em zero desse intervalo, exclusivo, em unidades de código UTF-16. Em todos os usos atuais, é necessário fornecer um índice final. Este campo é um Int32Value para acomodar casos de uso futuros com intervalos abertos. |
Modo de visualização de sugestões
O modo de visualização "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 só tiver acesso de leitura, PREVIEW_WITHOUT_SUGGESTIONS será aplicado. Caso contrário, SUGGESTIONS_INLINE é aplicado. Esse é o modo de visualização de sugestões padrão. |
SUGGESTIONS_INLINE |
O documento retornado tem sugestões inline. As mudanças sugeridas vão ser diferenciadas do conteúdo de base no 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 alterações 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 com todas as alterações sugeridas rejeitadas se houver alguma sugestão no 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 ( |
Campos | |
---|---|
objectId |
O ID desse objeto inline. Pode ser usado para atualizar as propriedades de um objeto. |
inlineObjectProperties |
As propriedades desse objeto inline. |
suggestedInlineObjectPropertiesChanges |
Mudanças sugeridas nas propriedades do objeto inline, codificadas pelo ID da sugestão. |
suggestedInsertionId |
É o ID de inserção sugerido. Se estiver vazio, a inserção não vai ser sugerida. |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
InlineObjectProperties
Propriedades de um InlineObject
.
Representação JSON |
---|
{
"embeddedObject": {
object ( |
Campos | |
---|---|
embeddedObject |
O objeto incorporado desse objeto in-line. |
EmbeddedObject
Um objeto incorporado no documento.
Representação JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Campos | |
---|---|
title |
O título do objeto incorporado. A |
description |
A descrição do objeto incorporado. A |
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 do link externo. Por exemplo, ele contém uma referência ao gráfico do Planilhas Google de origem quando o objeto incorporado é um gráfico vinculado. Se ela não for definida, o objeto incorporado não será vinculado. |
Campo de união properties . As propriedades específicas de cada tipo de objeto incorporado. properties pode ser apenas de um dos tipos a seguir: |
|
embeddedDrawingProperties |
As propriedades de um desenho incorporado. |
imageProperties |
As propriedades de uma imagem. |
EmbeddedDrawingProperties
Esse tipo não tem campos.
As propriedades de um desenho incorporado e usadas para diferenciar o tipo de objeto. Um desenho incorporado é criado e editado em um documento. Não aceitamos 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 de forma eficaz como o solicitante original. O acesso à imagem pode ser perdido se as configurações de compartilhamento do documento forem alteradas. |
sourceUri |
O URI de origem é o URI usado para inserir a imagem. O URI de origem pode estar vazio. |
brightness |
É o efeito de brilho da imagem. O valor precisa estar no intervalo [-1,0, 1,0], em que 0 significa nenhum efeito. |
contrast |
É o efeito de contraste da imagem. O valor precisa estar no intervalo [-1,0, 1,0], em que 0 significa nenhum efeito. |
transparency |
O efeito de transparência da imagem. O valor precisa estar no intervalo [0,0, 1,0], em que 0 significa nenhum efeito e 1 significa transparente. |
cropProperties |
Propriedades de corte da imagem. |
angle |
É o ângulo de rotação no sentido horário da imagem, em radianos. |
Propriedades de corte
As propriedades de corte de uma imagem.
O retângulo de corte é representado usando deslocamentos fracionários das quatro bordas do conteúdo original.
- Se o deslocamento estiver no intervalo (0, 1), a borda correspondente do retângulo de corte será posicionada dentro do retângulo delimitador original da imagem.
- Se o deslocamento for negativo ou maior que 1, a borda correspondente do retângulo de corte será posicionada fora do retângulo delimitador original da imagem.
- Se todos os deslocamentos e ângulos de rotação forem 0, a imagem não será cortada.
Representação JSON |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
Campos | |
---|---|
offsetLeft |
O deslocamento especifica a distância entre a borda esquerda do retângulo de corte e a borda esquerda do conteúdo original, como uma fração da largura do conteúdo original. |
offsetRight |
O deslocamento especifica a distância entre a borda direita do retângulo de corte e a borda direita do conteúdo original, como uma fração da largura do conteúdo original. |
offsetTop |
O deslocamento especifica a distância entre a borda 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 uma EmbeddedObject
.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
A cor da borda. |
width |
É a largura da borda. |
dashStyle |
O estilo do traço da borda. |
propertyState |
O estado da propriedade de borda. |
Estado de propriedade
Os estados possíveis de uma propriedade.
Enums | |
---|---|
RENDERED |
Se o estado de uma propriedade for RENDERED, o elemento vai ter a propriedade correspondente quando for renderizado no documento. Esse é o valor padrão. |
NOT_RENDERED |
Se o estado de uma propriedade for NOT_RENDERED, o elemento não vai ter a propriedade correspondente quando renderizado no documento. |
LinkedContentReference
Uma referência ao conteúdo de origem do link externo.
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. |
Referência do Planilhas Google
Uma 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 Planilhas Google que contém o gráfico de origem. |
chartId |
O ID do gráfico específico na planilha do Planilhas Google incorporada. |
SuggestedInlineObjectProperties
Uma mudança sugerida em InlineObjectProperties
.
Representação JSON |
---|
{ "inlineObjectProperties": { object ( |
Campos | |
---|---|
inlineObjectProperties |
Um |
inlineObjectPropertiesSuggestionState |
Uma máscara que indica quais dos campos na base |
InlineObjectPropertiesSuggestionState
Uma máscara que indica quais dos campos na base InlineObjectProperties
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Campos | |
---|---|
embeddedObjectSuggestionState |
Uma máscara que indica quais dos campos em |
EmbeddedObjectSuggestionState
Uma máscara que indica quais dos campos na base EmbeddedObject
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
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 mudança sugerida em |
descriptionSuggested |
Indica se houve uma mudança sugerida em |
embeddedObjectBorderSuggestionState |
Uma máscara que indica quais dos campos em |
sizeSuggestionState |
Uma máscara que indica quais dos campos em |
marginLeftSuggested |
Indica se houve uma mudança sugerida em |
marginRightSuggested |
Indica se houve uma mudança sugerida em |
marginTopSuggested |
Indica se houve uma mudança sugerida em |
marginBottomSuggested |
Indica se houve uma mudança sugerida em |
linkedContentReferenceSuggestionState |
Uma máscara que indica quais dos campos em |
EmbeddedDrawingPropertiesSuggestionState
Esse tipo não tem campos.
Uma máscara que indica quais dos campos na base EmbeddedDrawingProperties
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
ImagePropertiesSuggestionState
Uma máscara que indica quais dos campos na base ImageProperties
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Campos | |
---|---|
contentUriSuggested |
Indica se houve uma mudança sugerida em |
sourceUriSuggested |
Indica se houve uma alteração sugerida em [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
Indica se houve uma alteração sugerida para [brilho] [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 [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
Uma máscara que indica quais dos campos em |
angleSuggested |
Indica se houve uma alteração sugerida em [angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
CropPropertiesSuggestionState
Uma máscara que indica quais dos campos na base CropProperties
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Campos | |
---|---|
offsetLeftSuggested |
Indica se houve uma mudança sugerida em |
offsetRightSuggested |
Indica se houve uma mudança sugerida em |
offsetTopSuggested |
Indica se houve uma mudança sugerida em |
offsetBottomSuggested |
Indica se houve uma mudança sugerida em |
angleSuggested |
Indica se houve uma mudança sugerida em |
EmbeddedObjectBorderSuggestionState
Uma máscara que indica quais dos campos na base EmbeddedObjectBorder
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
Campos | |
---|---|
colorSuggested |
Indica se houve uma alteração sugerida em [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
Indica se houve uma alteração sugerida em [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
Indica se houve uma alteração sugerida para [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested |
Indica se houve uma alteração sugerida em [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
Uma máscara que indica quais dos campos na base LinkedContentReference
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Campos | |
---|---|
sheetsChartReferenceSuggestionState |
Uma máscara que indica quais dos campos em |
PlanilhasChartReferenceSuggestionState
Uma máscara que indica quais dos campos na base SheetsChartReference
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Campos | |
---|---|
spreadsheetIdSuggested |
Indica se houve uma mudança sugerida em |
chartIdSuggested |
Indica se houve uma mudança sugerida em |
PositionedObject
Um objeto vinculado a um Paragraph
e posicionado em relação ao início do parágrafo. Um PositionedObject contém um EmbeddedObject
, como uma imagem.
Representação JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Campos | |
---|---|
objectId |
O ID desse objeto posicionado. |
positionedObjectProperties |
As propriedades desse objeto posicionado. |
suggestedPositionedObjectPropertiesChanges |
As mudanças sugeridas para as propriedades do objeto posicionado, codificadas pelo ID da sugestão. |
suggestedInsertionId |
É o ID de inserção sugerido. Se estiver vazio, a inserção não vai ser sugerida. |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não haverá exclusões sugeridas desse conteúdo. |
PositionedObjectProperties
Propriedades de um PositionedObject
.
Representação JSON |
---|
{ "positioning": { object ( |
Campos | |
---|---|
positioning |
O posicionamento desse objeto posicionado em relação à nova linha do |
embeddedObject |
O objeto incorporado desse objeto posicionado. |
PositionedObjectPositioning
O posicionamento de um PositionedObject
. O objeto posicionado é posicionado em relação ao início do Paragraph
a que está vinculado.
Representação JSON |
---|
{ "layout": enum ( |
Campos | |
---|---|
layout |
O layout desse objeto posicionado. |
leftOffset |
O deslocamento da borda esquerda do objeto posicionado em relação ao início do |
topOffset |
O deslocamento da borda de cima 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 |
quebra o texto de modo que o objeto posicionado esteja à esquerda e o texto à direita. |
BREAK_RIGHT |
Quebra o texto de modo que o objeto posicionado esteja à 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 atrás do texto. |
SuggestedPositionedObjectProperties
Uma mudança sugerida em PositionedObjectProperties
.
Representação JSON |
---|
{ "positionedObjectProperties": { object ( |
Campos | |
---|---|
positionedObjectProperties |
Um |
positionedObjectPropertiesSuggestionState |
Uma máscara que indica quais dos campos na base |
PositionedObjectPropertiesSuggestionState
Uma máscara que indica quais dos campos na base PositionedObjectProperties
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "positioningSuggestionState": { object ( |
Campos | |
---|---|
positioningSuggestionState |
Uma máscara que indica quais dos campos em |
embeddedObjectSuggestionState |
Uma máscara que indica quais dos campos em |
PositionedObjectPositioningSuggestionState
Uma máscara que indica quais dos campos na base PositionedObjectPositioning
foram alterados nessa sugestão. Há um novo valor sugerido para qualquer campo definido como "true".
Representação JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
Campos | |
---|---|
layoutSuggested |
Indica se houve uma mudança sugerida em |
leftOffsetSuggested |
Indica se houve uma mudança sugerida em |
topOffsetSuggested |
Indica se houve uma mudança sugerida em |
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. |