- Recurso: documento
- Corpo
- StructuralElement
- Parágrafo
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- Cor
- RgbColor
- Dimensão
- Unidade
- WeightedFontFamily (em inglês)
- BaselineOffset (em inglês)
- Link
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- Tipo
- Quebra de página
- ColumnBreak
- FootnoteReference
- HorizontalRule
- Equação
- InlineObjectElement
- Pessoa
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType.
- Alinhamento
- ContentDirection (em inglês)
- SpacingMode (em inglês)
- ParagraphBorder
- DashStyle (em inglês)
- TabStop
- TabStopAlignment (em inglês)
- Sombra
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Marcador
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- Quebra de seção
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle (em inglês)
- SectionType (em inglês)
- Tabela
- TableRow
- TableCell (em inglês)
- TableCellStyle
- TableCellBorder (em inglês)
- 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 (em inglês)
- GlyphType (link em inglês)
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- Intervalo
- SuggestionsViewMode.
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties (em inglês).
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState (em inglês)
- LinkedContentReference
- PlanilhasChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState.
- EmbeddedDrawingPropertiesSuggestionState.
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- PlanilhasChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout (link em inglês)
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- Métodos
Recurso: Document
Um documento do Google Docs.
Representação JSON |
---|
{ "documentId": string, "title": string, "body": { object ( |
Campos | |
---|---|
documentId |
Apenas saída. O 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 código da nota de rodapé. |
documentStyle |
Apenas saída. O estilo do documento. |
suggestedDocumentStyleChanges |
Apenas saída. As alterações sugeridas para o estilo do documento, codificadas pelo código da sugestão. |
namedStyles |
Apenas saída. Os estilos nomeados do documento. |
suggestedNamedStylesChanges |
Apenas saída. As alterações sugeridas para os estilos nomeados do documento, codificadas pelo ID da sugestão. |
lists |
Apenas saída. As listas no documento, codificadas pelo código da lista. |
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 a revisão. Preenchido apenas se o usuário tiver acesso de edição ao documento. O código de revisão não é um número sequencial, mas uma string opaca. O formato do ID de revisão pode mudar ao longo do tempo. Um código de revisão retornado só é válido por 24 horas depois de ser retornado e não pode ser compartilhado entre usuários. Se o ID de revisão não for alterado entre as chamadas, o documento não foi alterado. Por outro lado, um ID alterado (para o mesmo documento e usuário) normalmente significa que o documento foi atualizado. No entanto, um ID alterado também pode ser causado por fatores internos, como alterações no formato do ID. |
suggestionsViewMode |
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 in-line 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 todo o conteúdo do documento, exceto headers
, footers
e footnotes
.
Representação JSON |
---|
{
"content": [
{
object ( |
Campos | |
---|---|
content[] |
O conteúdo do corpo. Os índices do conteúdo do corpo começam em zero. |
Elemento estrutural
Um StructuralElement descreve o conteúdo que fornece estrutura para o documento.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
O índice inicial deste elemento estrutural, com base em zero, em unidades de código UTF-16. |
endIndex |
O índice final desse elemento estrutural, exclusivo, em unidades de código UTF-16. |
Campo de união content . O conteúdo do elemento estrutural. content pode ser apenas de um dos tipos a seguir: |
|
paragraph |
Um tipo de parágrafo de elemento estrutural. |
sectionBreak |
Um tipo de quebra de seção do elemento estrutural. |
table |
Um tipo de tabela de elemento estrutural. |
tableOfContents |
Um índice no tipo de elemento estrutural. |
Parágrafo
Um StructuralElement
que representa um parágrafo. Um parágrafo é um intervalo de conteúdo terminado em um caractere de nova linha.
Representação JSON |
---|
{ "elements": [ { object ( |
Campos | |
---|---|
elements[] |
O conteúdo do parágrafo, dividido em suas partes componentes. |
paragraphStyle |
O estilo deste parágrafo. |
suggestedParagraphStyleChanges |
O estilo de parágrafo sugerido muda para este parágrafo, codificado pelo código da sugestão. |
bullet |
O marcador para este parágrafo. Se não estiver presente, o parágrafo não pertence 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. |
ParagraphElemento
Um ParagraphElement descreve conteúdo em uma Paragraph
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Campos | |
---|---|
startIndex |
O índice inicial deste elemento do parágrafo, com base em zero, 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 |
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 da nota de rodapé. |
horizontalRule |
Um elemento de parágrafo de regra horizontal. |
equation |
Um elemento de parágrafo da equação. |
inlineObjectElement |
Um elemento de parágrafo do objeto in-line. |
person |
Um elemento de parágrafo vinculado a uma pessoa ou um endereço de e-mail. |
richLink |
Um elemento de parágrafo vinculado a um recurso do Google (como um arquivo no Google Drive, um vídeo do YouTube ou um evento do Google Agenda) |
Execução de texto
Um ParagraphElement
que representa um conjunto de textos com o mesmo estilo.
Representação JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
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 dessa execução. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para essa execução, indicado pelo ID da sugestão. |
TextStyle
Representa o estilo que pode ser aplicado ao texto.
Os estilos de texto herdados são representados como campos não definidos nesta mensagem. O pai de um estilo de texto depende de onde o estilo de texto é definido:
- O TextStyle do texto em uma
Paragraph
herda donamed style type
correspondente do parágrafo. - O TextStyle em um
named style
herda do estilo nomeadonormal text
. - O TextStyle do estilo nomeado
normal text
herda do estilo de texto padrão no editor do Documentos. - O TextStyle em um elemento
Paragraph
contido em uma tabela pode herdar o estilo de texto dele.
Se o estilo de texto não herdar de um pai, cancelar a configuração dos campos reverterá o estilo para um valor que corresponda aos padrões no editor do Documentos.
Representação JSON |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
Campos | |
---|---|
bold |
Indica se o texto é renderizado como negrito. |
italic |
Se o texto está ou não em itálico. |
underline |
Se o texto está sublinhado ou não. |
strikethrough |
Se o texto é tachado ou não. |
smallCaps |
Se o texto está em letras minúsculas ou não. |
backgroundColor |
A cor do plano de fundo do texto. Se definida, a cor será RGB ou transparente, dependendo do campo |
foregroundColor |
A cor de 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 ponderação renderizada do texto. Se uma solicitação de atualização especificar valores para Se Se |
baselineOffset |
O deslocamento vertical do texto a partir da posição normal. O texto com deslocamentos de valor de referência |
link |
O destino do hiperlink do texto. Se ela não for definida, não haverá um link. Os links não são herdados do texto principal. Alterar o link em uma solicitação de atualização causa algumas outras mudanças 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 será usado como uma cor opaca. Se não for definida, representará uma cor transparente. |
Cor
Uma cor sólida.
Representação JSON |
---|
{
"rgbColor": {
object ( |
Campos | |
---|---|
rgbColor |
O valor da cor RGB. |
Cor gb
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. |
Família de fontes ponderadas
Representa uma família de fontes e o peso do texto.
Representação JSON |
---|
{ "fontFamily": string, "weight": integer } |
Campos | |
---|---|
fontFamily |
A família de fontes do texto. A família de fontes pode ser qualquer fonte do menu "Fontes" do Documentos ou do Google Fonts. Se o nome da fonte não for reconhecido, o texto será renderizado em |
weight |
A espessura da fonte. Esse campo pode ter qualquer valor que seja um múltiplo de O valor padrão é O peso da fonte forma apenas um componente do peso da fonte renderizada. Uma combinação de
|
Deslocamento base
Maneiras em que o texto pode ser deslocado verticalmente da posição normal.
Enums | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
O deslocamento do valor de referência do texto é herdado do pai. |
NONE |
O texto não está deslocado verticalmente. |
SUPERSCRIPT |
O texto está deslocado verticalmente para cima (sobrescrito). |
SUBSCRIPT |
O texto está deslocado verticalmente para baixo (subscrito). |
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. |
bookmarkId |
O ID de um favorito neste documento. |
headingId |
O ID de um título neste documento. |
Estilo de texto sugerido
Uma alteração sugerida para 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. 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 alteração sugerida para |
strikethroughSuggested |
Indica se houve uma alteração sugerida para |
smallCapsSuggested |
Indica se houve uma alteração 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 alteração sugerida para |
Texto automático
Um ParagraphElement
que representa uma posição no texto que é substituída dinamicamente por um conteúdo que pode mudar ao longo do tempo, como um número de página.
Representação JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
O tipo deste 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 de texto deste AutoText. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para esse texto automático, codificado pelo código da sugestão. |
Tipo
Os tipos de texto automático.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Um tipo de texto automático não especificado. |
PAGE_NUMBER |
Tipo de texto automático que representa o número da página atual. |
PAGE_COUNT |
Tipo de texto automático que representa o número total de páginas no documento. |
Quebra de página
Um ParagraphElement
que representa uma quebra de página. Uma quebra de página faz com que o texto subsequente comece na parte superior da próxima página.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
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 deste PageBreak. Assim como o conteúdo de texto, como execuções de texto e referências de nota de rodapé, o estilo de texto de uma quebra de página pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para este PageBreak, inserido pelo ID da sugestão. |
Quebra de coluna
Um ParagraphElement
que representa uma quebra de coluna. Uma quebra de coluna faz com que o texto subsequente comece na parte superior da próxima coluna.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
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 ColumnBreak. Assim como o conteúdo de texto, como execuções de texto e referências de nota de rodapé, o estilo de texto de uma quebra de coluna pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para essa coluna, dividida pelo código da sugestão. |
Referência da nota de rodapé
Um ParagraphElement
que representa uma referência de nota de rodapé. Uma referência de nota de rodapé é o conteúdo in-line renderizado com um número e é usado para identificar a nota de rodapé.
Representação JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
footnoteId |
O ID do |
footnoteNumber |
O número renderizado dessa 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 essa FootnoteReference, inserido pelo ID da sugestão. |
Regra horizontal
Um ParagraphElement
que representa uma linha horizontal.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
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. Semelhante ao conteúdo de texto, como execuções de texto e referências de nota de rodapé, o estilo de texto de uma regra horizontal pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para esta horizontal, codificado pelo código da sugestão. |
Equação
Um ParagraphElement
que representa uma equação.
Representação JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Campos | |
---|---|
suggestedInsertionIds[] |
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. |
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. 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 deste InlineObjectElement. Assim como o conteúdo de texto, como execuções de texto e referências de nota de rodapé, o estilo de texto de um elemento de objeto in-line pode afetar o layout do conteúdo, bem como o estilo do texto inserido ao lado dele. |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para este InlineObject, codificado pelo ID da sugestão. |
Pessoa
Uma pessoa ou um endereço de e-mail mencionado em um documento. Essas referências se comportam como um único elemento imutável, que contém o nome ou o endereço de e-mail da pessoa.
Representação JSON |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Campos | |
---|---|
personId |
Apenas saída. O ID exclusivo desse link. |
suggestedInsertionIds[] |
IDs de sugestões que inserem o link desta pessoa no documento. Uma |
suggestedDeletionIds[] |
IDs de sugestões que removem o link desta pessoa do documento. Um |
textStyle |
O estilo de texto deste |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para este |
personProperties |
Apenas saída. As propriedades desse |
Propriedades de pessoa
Propriedades específicas de um Person
vinculado.
Representação JSON |
---|
{ "name": string, "email": string } |
Campos | |
---|---|
name |
Apenas saída. O nome da pessoa, se ele for exibido no texto do link em vez do endereço de e-mail da pessoa. |
email |
Apenas saída. O endereço de e-mail vinculado a este |
Link rico
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. Uma |
suggestedDeletionIds[] |
IDs de sugestões que removem esse link do documento. Um |
textStyle |
O estilo de texto deste |
suggestedTextStyleChanges |
O estilo de texto sugerido muda para este |
richLinkProperties |
Apenas saída. As propriedades desse |
PropriedadesLink
Propriedades específicas de um RichLink
.
Representação JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
Campos | |
---|---|
title |
Apenas saída. O título da |
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 o estilo é 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
herda do estilo de parágrafo padrão no editor do Documentos. - O ParagraphStyle em um elemento
Paragraph
contido em uma tabela pode herdar o estilo de parágrafo do estilo da tabela.
Se o estilo do parágrafo não for herdado de um elemento pai, a não definição dos campos o reverterá para um valor que corresponda aos padrões do editor do Documentos Google.
Representação JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
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 no 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 para o 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 seguinte e anterior. Se não for definido, o valor será herdado do pai. A borda entre é renderizada quando o parágrafo adjacente tem as mesmas propriedades de borda e recuo. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo. |
borderTop |
A borda na parte superior deste parágrafo. Se não for definido, o valor será herdado do pai. A borda superior é renderizada quando o parágrafo acima tem propriedades de borda e recuo diferentes. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo. |
borderBottom |
A borda na parte inferior deste parágrafo. Se não for definido, o valor será herdado do pai. A borda inferior é renderizada quando o parágrafo abaixo tem propriedades de borda e recuo diferentes. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo. |
borderLeft |
A borda à esquerda deste parágrafo. Se não for definido, o valor será herdado do pai. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo. |
borderRight |
A borda à direita deste parágrafo. Se não for definido, o valor será herdado do pai. As bordas do parágrafo não podem ser parcialmente atualizadas. Ao alterar uma borda de parágrafo, a nova borda deve ser especificada por completo. |
indentFirstLine |
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 do parágrafo na lateral que corresponde ao início do texto, com base na direção atual do parágrafo. Se não for definido, o valor será herdado do pai. |
indentEnd |
A quantidade de recuo do parágrafo na lateral que corresponde ao final do texto, com base na direção atual do parágrafo. Se não for definido, o valor será herdado do pai. |
tabStops[] |
Uma lista da guia para esse parágrafo. A lista de paradas de tabulação não é herdada. Esta propriedade é somente leitura. |
keepLinesTogether |
Indica se todas as linhas do parágrafo devem ser dispostas na mesma página ou coluna, se possível. Se não for definido, o valor será herdado do pai. |
keepWithNext |
Se pelo menos uma parte deste parágrafo deve ser colocada na mesma página ou coluna do próximo parágrafo, se possível. Se não for definido, o valor será herdado do pai. |
avoidWidowAndOrphan |
Define se viúvas e órfãos devem ser evitados no parágrafo. Se não for definido, o valor será herdado do pai. |
shading |
O sombreamento do parágrafo. Se não for definido, o valor será herdado do pai. |
pageBreakBefore |
Se o parágrafo atual deve começar sempre no início de uma página. Se não for definido, o valor será herdado do pai. A tentativa de atualizar |
TipoNomeNomeado
Os tipos de estilos nomeados.
Enums | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
O tipo de estilo nomeado não foi especificado. |
NORMAL_TEXT |
Texto normal. |
TITLE |
Título. |
SUBTITLE |
Legenda. |
HEADING_1 |
Título 1. |
HEADING_2 |
Título 2. |
HEADING_3 |
Título 3. |
HEADING_4 |
Título 4. |
HEADING_5 |
Título 5. |
HEADING_6 |
Título 6. |
Alinhamento
Os tipos de alinhamento de texto de um parágrafo.
Enums | |
---|---|
ALIGNMENT_UNSPECIFIED |
O alinhamento do parágrafo é herdado do elemento pai. |
START |
O parágrafo está alinhado ao início da linha. Alinhado à esquerda para texto LTR, alinhado à direita caso contrário. |
CENTER |
O parágrafo está centralizado. |
END |
O parágrafo está alinhado ao final da linha. Alinhado à direita para texto LTR, alinhado à esquerda caso contrário. |
JUSTIFIED |
O parágrafo é justificado. |
ContentDirection
O conteúdo das rotas pode fluir.
Enums | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
A direção do conteúdo não é especificada. |
LEFT_TO_RIGHT |
O conteúdo vai da esquerda para a direita. |
RIGHT_TO_LEFT |
O conteúdo vai da direita para a esquerda. |
Modo de espaçamento
Os diferentes modos de espaçamento de parágrafo.
Enums | |
---|---|
SPACING_MODE_UNSPECIFIED |
O modo de espaçamento é herdado do principal. |
NEVER_COLLAPSE |
O espaçamento entre parágrafos é sempre processado. |
COLLAPSE_LISTS |
O espaçamento entre parágrafos é ignorado entre os elementos da lista. |
Borda do parágrafo
Uma borda ao redor de um parágrafo.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
A cor da borda. |
width |
A largura da borda. |
padding |
O padding da borda. |
dashStyle |
O estilo de traço da borda. |
Traço estilo
Os tipos de traços com os quais a geometria linear pode ser renderizada. Esses valores são baseados no tipo simples "ST_PresetLineDashVal" descrito na seção 20.1.10.48 de "Formatos de arquivos XML abertos do Office: referência da linguagem de marcação e fundamentos", parte 1 da 4a edição ECMA-376.
Enums | |
---|---|
DASH_STYLE_UNSPECIFIED |
Estilo de traço não especificado. |
SOLID |
Linha sólida. Corresponde ao valor ST_PresetLineDashVal ECMA-376 "sólido". Este é o estilo de traço padrão. |
DOT |
Linha pontilhada. Corresponde ao valor "dot" de ECMA-376 ST_PresetLineDashVal. |
DASH |
Linha tracejada. Corresponde ao valor "ST" de ECMA-376 ST_PresetLineDashVal. |
TabTab
Uma tabulação para dentro de um parágrafo.
Representação JSON |
---|
{ "offset": { object ( |
Campos | |
---|---|
offset |
O deslocamento entre a parada da guia 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 de tabulação não é especificado. |
START |
A parada de tabulação está alinhada ao início da linha. Esse é o padrão. |
CENTER |
A parada de tabulação é alinhada ao centro da linha. |
END |
A parada de tabulação é alinhada ao final da linha. |
Sombreamento
O sombreamento de um parágrafo.
Representação JSON |
---|
{
"backgroundColor": {
object ( |
Campos | |
---|---|
backgroundColor |
A cor do plano de fundo do sombreamento do parágrafo. |
ParagraphParagraphStyle
Uma alteração sugerida para 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. 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 alteração sugerida para |
alignmentSuggested |
Indica se houve uma alteração 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 alteração sugerida para |
spaceBelowSuggested |
Indica se houve uma alteração sugerida para |
borderBetweenSuggested |
Indica se houve uma alteração sugerida para |
borderTopSuggested |
Indica se houve uma alteração sugerida para |
borderBottomSuggested |
Indica se houve uma alteração sugerida para |
borderLeftSuggested |
Indica se houve uma alteração sugerida para |
borderRightSuggested |
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 |
indentEndSuggested |
Indica se houve uma alteração sugerida para |
keepLinesTogetherSuggested |
Indica se houve uma alteração sugerida para |
keepWithNextSuggested |
Indica se houve uma alteração sugerida para |
avoidWidowAndOrphanSuggested |
Indica se houve uma alteração sugerida para |
shadingSuggestionState |
Uma máscara que indica quais campos do |
pageBreakBeforeSuggested |
Indica se houve uma alteração sugerida para |
ShadingSuggestionState
Uma máscara que indica quais dos campos na base Shading
foram alterados nessa alteração sugerida. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "backgroundColorSuggested": boolean } |
Campos | |
---|---|
backgroundColorSuggested |
Indica se houve uma alteração sugerida para o |
Marcador
Descreve o marcador de um parágrafo.
Representação JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Campos | |
---|---|
listId |
O ID da lista à qual 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 alteração sugerida para um Bullet
.
Representação JSON |
---|
{ "bullet": { object ( |
Campos | |
---|---|
bullet |
Um |
bulletSuggestionState |
Uma máscara que indica quais dos campos na base |
BulletSuggestionState
Uma máscara que indica quais dos campos na base Bullet
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
listIdSuggested |
Indica se houve uma alteração sugerida para o |
nestingLevelSuggested |
Indica se houve uma alteração sugerida para o |
textStyleSuggestionState |
Uma máscara que indica quais campos do |
Referências de objetos
Uma coleção de IDs de objeto.
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 com o mesmo SectionStyle
. Uma quebra de seção representa o início de uma nova seção, e o estilo da seção é aplicado à seção após a quebra.
O corpo do documento sempre começa com uma quebra de seção.
Representação JSON |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
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 a quebra desta seção. |
Estilo de 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 no editor do Documentos. Uma seção pode ter no máximo três colunas. Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resultará em um erro 400 de solicitação inválida. |
columnSeparatorStyle |
O estilo dos separadores de coluna. Esse estilo pode ser definido mesmo quando há uma coluna na seção. Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
contentDirection |
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. Desativar essa 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 do documento será definido como Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
marginBottom |
A margem inferior da página da seção. Se não for definido, o valor do documento será definido como Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa 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 do documento será definido como Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
marginLeft |
A margem esquerda da seção. Se não for definido, o valor do documento será definido como Ao atualizar esta 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 do documento será definido como Ao atualizar esta 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 do documento será definido como Ao atualizar esta 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 vai ser herdado do método SectionStyle Esta propriedade é somente leitura. |
defaultFooterId |
O ID do rodapé padrão. Se não for definido, o valor vai ser herdado do método 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 na 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 cabeçalhos de rodapé / rodapé da primeira página serão usados para a primeira página da seção. Se não for definido, ele será herdado do Ao atualizar esta 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 inicia a contagem do número de páginas desta seção. Se ela não for definida, a numeração da página continuará a partir da seção anterior. Se o valor não for definido no primeiro Ao atualizar esta propriedade, é necessário definir um valor concreto. Desativar essa propriedade resulta em um erro 400 de solicitação inválida. |
Propriedades da coluna de seção
Propriedades que se aplicam à coluna de uma seção.
Representação JSON |
---|
{ "width": { object ( |
Campos | |
---|---|
width |
Apenas saída. A largura da coluna. |
paddingEnd |
O padding no final da coluna. |
ColumnSeparatorStyle
O estilo dos separadores de coluna entre colunas.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Um estilo de separador de coluna não especificado. |
NONE |
Não há linhas separadoras para as colunas. |
BETWEEN_EACH_COLUMN |
Renderiza uma linha separadora de coluna entre cada coluna. |
SectionType
Representa como o início da seção atual é posicionado em relação à seção anterior.
Enums | |
---|---|
SECTION_TYPE_UNSPECIFIED |
O tipo de seção não foi especificado. |
CONTINUOUS |
A seção começa imediatamente após o último parágrafo da seção anterior. |
NEXT_PAGE |
A seção começa na próxima página. |
Tabela
Um StructuralElement
que representa uma tabela.
Representação JSON |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
Campos | |
---|---|
rows |
Número de linhas na tabela. |
columns |
Número de colunas na tabela. É possível que a tabela não seja retangular, por isso algumas linhas podem ter um número de células diferente. |
tableRows[] |
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 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 uma Table
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
Campos | |
---|---|
startIndex |
O índice inicial dessa linha, baseado em zero, em unidades de código UTF-16. |
endIndex |
O índice final dessa linha, com base em zero, exclusivo, em unidades de código UTF-16. |
tableCells[] |
O conteúdo e o estilo de cada célula nessa linha. É possível que a tabela não seja retangular, portanto, algumas linhas podem ter um número de células diferente de outras linhas da mesma tabela. |
suggestedInsertionIds[] |
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. |
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 uma Table
.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Campos | |
---|---|
startIndex |
O índice inicial dessa célula, em zero, nas unidades de código UTF-16. |
endIndex |
Índice final dessa 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 pelo código da sugestão. |
TableCellStyle
O estilo de um TableCell
.
Os estilos de células da tabela herdados são representados como campos não definidos nesta mensagem. Um estilo de célula de tabela pode herdar do estilo da tabela.
Representação JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
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 plano 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 inferior da célula. |
contentAlignment |
O alinhamento do conteúdo na célula da tabela. O alinhamento padrão corresponde ao das células da tabela recém-criadas no editor do Documentos. |
TableCellBorder
Uma borda ao redor de uma célula da tabela.
As bordas das células da tabela não podem ser transparentes. Para ocultar uma borda de célula da tabela, defina a largura como 0.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
A cor da borda. Esta cor não pode ser transparente. |
width |
A largura da borda. |
dashStyle |
O estilo de traço da borda. |
Alinhamento de conteúdo
Os tipos de alinhamento de conteúdo.
Derivado de um subconjunto dos valores do tipo simples "ST_TextAnchoringType" na seção 20.1.10.59 de "Formatos de arquivo XML abertos do Office: referência da linguagem de marcação e fundamentos", parte 1 da 4a edição ECMA-376.
Enums | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Um alinhamento de conteúdo não especificado. O alinhamento do conteúdo é herdado do pai, se houver. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Um alinhamento de conteúdo incompatível. |
TOP |
Um alinhamento que alinha o conteúdo à parte superior do detentor de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType 't'. |
MIDDLE |
Um alinhamento que alinha o conteúdo ao meio do detentor de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType "ctr". |
BOTTOM |
Um alinhamento que alinha o conteúdo à parte inferior do detentor de conteúdo. Corresponde a ECMA-376 ST_TextAnchoringType 'b'. |
TableTableCellStyle
Uma alteração sugerida para um TableCellStyle
.
Representação JSON |
---|
{ "tableCellStyle": { object ( |
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. 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 alteração 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 alteração sugerida para |
borderRightSuggested |
Indica se houve uma alteração sugerida para |
borderTopSuggested |
Indica se houve uma alteração sugerida para |
borderBottomSuggested |
Indica se houve uma alteração sugerida para |
paddingLeftSuggested |
Indica se houve uma alteração sugerida para |
paddingRightSuggested |
Indica se houve uma alteração sugerida para |
paddingTopSuggested |
Indica se houve uma alteração sugerida para |
paddingBottomSuggested |
Indica se houve uma alteração 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 com uma altura igual ou maior que esse valor para exibir todo o conteúdo nas células da linha. |
tableHeader |
Se a linha é um cabeçalho de tabela. |
preventOverflow |
Se a linha não pode ultrapassar os limites de página ou coluna. |
TableTableRowStyle sugerido.
Uma alteração sugerida para 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. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "minRowHeightSuggested": boolean } |
Campos | |
---|---|
minRowHeightSuggested |
Indica se houve uma alteração sugerida para |
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 contêm linhas e as linhas contêm células, semelhante ao HTML. Assim, 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 |
Tipo de largura
O tipo de largura da coluna.
Enums | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
O tipo de largura da coluna não foi especificado. |
EVENLY_DISTRIBUTED |
A largura da coluna é distribuída uniformemente entre as outras colunas. A largura da coluna é determinada automaticamente e terá uma parte igual à largura restante para a tabela depois de contabilizar todas as colunas com larguras especificadas. |
FIXED_WIDTH |
Largura fixa da coluna. A propriedade [width][google.apps.docs.v1.TableColumnProperties.width contém a largura da coluna. |
Sumário
Um StructuralElement
que representa um índice.
Representação JSON |
---|
{
"content": [
{
object ( |
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é de documento.
Representação JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
Campos | |
---|---|
footnoteId |
O ID da nota de rodapé. |
content[] |
O conteúdo da nota de rodapé. Os índices do conteúdo de uma nota de rodapé começam em zero. |
DocumentStyle
O estilo do documento.
Representação JSON |
---|
{ "background": { object ( |
Campos | |
---|---|
background |
O plano de fundo do documento. Os documentos não podem ter uma cor de fundo transparente. |
defaultHeaderId |
O ID do cabeçalho padrão. Se não for definido, não haverá cabeçalho padrão. Esta propriedade é somente leitura. |
defaultFooterId |
O ID do rodapé padrão. Se não for definida, não há 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 somente para a primeira página. Se não for definido, um cabeçalho exclusivo para a primeira página não existirá. O valor de Esta propriedade é somente leitura. |
firstPageFooterId |
O ID do rodapé usado apenas na primeira página. Se não for definido, um rodapé exclusivo para a primeira página não existirá. O valor de Esta propriedade é somente leitura. |
useFirstPageHeaderFooter |
Indica se os cabeçalhos de rodapé / rodapé da primeira página serão usados. |
useEvenPageHeaderFooter |
Indica se os cabeçalhos de rodapé / rodapé da página serão usados nas páginas pares. |
pageNumberStart |
O número da página a partir da qual inicia a contagem do número de páginas. |
marginTop |
A margem superior da página. Atualizar a margem da página superior no estilo de documento limpa a margem de todas as seções. |
marginBottom |
A margem inferior da página. Atualizar a margem da página inferior no estilo de documento limpa a margem de página inferior em todos os estilos de seção. |
marginRight |
A margem direita da página. A atualização da margem direita da página no estilo de documento limpa a margem da página correta em todos os estilos de seção. Isso também pode fazer com que as colunas sejam redimensionadas em todas as seções. |
marginLeft |
A margem esquerda da página. A atualização da margem esquerda da página no estilo de documento limpa a margem esquerda de todos os estilos de seção. Isso também pode fazer com que as colunas sejam redimensionadas em todas as seções. |
pageSize |
O tamanho de uma página no documento. |
marginHeader |
A quantidade de espaço entre a parte superior 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. |
Contexto
Representa o plano de fundo de um documento.
Representação JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
A cor do plano de fundo. |
Tamanho
Largura e altura.
Representação JSON |
---|
{ "height": { object ( |
Campos | |
---|---|
height |
A altura do objeto. |
width |
A largura do objeto. |
Estilo de documento sugerido
Uma alteração sugerida para o 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. 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 do |
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 alteração sugerida para |
firstPageFooterIdSuggested |
Indica se houve uma alteração sugerida para |
useFirstPageHeaderFooterSuggested |
Indica se houve uma alteração sugerida para |
useEvenPageHeaderFooterSuggested |
Indica se houve uma alteração sugerida para |
pageNumberStartSuggested |
Indica se houve uma alteração sugerida para |
marginTopSuggested |
Indica se houve uma alteração sugerida para |
marginBottomSuggested |
Indica se houve uma alteração sugerida para |
marginRightSuggested |
Indica se houve uma alteração 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 |
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 atual do plano de fundo foi modificada nessa sugestão. |
EstadodeSugestãodeTamanho
Uma máscara que indica quais dos campos na base Size
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, o Size
tem um novo valor sugerido.
Representação JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Campos | |
---|---|
heightSuggested |
Indica se houve uma alteração sugerida para |
widthSuggested |
Indica se houve uma alteração sugerida para |
Estilos nomeados
Os estilos nomeados. Os parágrafos do documento podem herdar TextStyle
e ParagraphStyle
desses estilos nomeados.
Representação JSON |
---|
{
"styles": [
{
object ( |
Campos | |
---|---|
styles[] |
Os estilos nomeados. Há uma entrada para cada |
EstiloNome
Um estilo nomeado. Os parágrafos no documento podem herdar TextStyle
e ParagraphStyle
desse estilo nomeado quando têm o mesmo tipo de estilo nomeado.
Representação JSON |
---|
{ "namedStyleType": enum ( |
Campos | |
---|---|
namedStyleType |
O tipo desse estilo nomeado. |
textStyle |
O estilo de texto desse estilo nomeado. |
paragraphStyle |
O estilo de parágrafo desse estilo nomeado. |
SugeridosNomesEstilos
Uma alteração sugerida para o 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 campos do 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 este estado de sugestão corresponde. Esse campo é fornecido como uma conveniência para corresponder o NamedStyleSuggestionState com o |
textStyleSuggestionState |
Uma máscara que indica quais campos do |
paragraphStyleSuggestionState |
Uma máscara que indica quais campos do |
Listar
Uma lista representa os atributos da lista para um grupo de parágrafos que pertencem à mesma lista. Um parágrafo que faz parte de uma lista tem uma referência ao ID da lista em bullet
.
Representação JSON |
---|
{ "listProperties": { object ( |
Campos | |
---|---|
listProperties |
As propriedades da lista. |
suggestedListPropertiesChanges |
As alterações sugeridas para as propriedades da lista, codificadas pelo ID da sugestão. |
suggestedInsertionId |
O código de inserção sugerido. Se estiver vazio, isso não é uma inserção sugerida. |
suggestedDeletionIds[] |
Os IDs de exclusão sugeridos. Se estiver vazio, não há sugestões de exclusão dessa lista. |
Propriedades de lista
As propriedades de um list
que descrevem a aparência de marcadores pertencentes a parágrafos associados a uma lista.
Representação JSON |
---|
{
"nestingLevels": [
{
object ( |
Campos | |
---|---|
nestingLevels[] |
Descreve as propriedades dos marcadores no nível associado. Uma lista tem no máximo 9 níveis de aninhamento com nível 0 correspondente ao nível superior e nível 8 correspondente ao nível mais aninhado. Os níveis de aninhamento são retornados em ordem crescente, com o menor valor aninhado retornado primeiro. |
Nível de transição
Contém propriedades que descrevem a aparência de um marcador de lista em um determinado nível de aninhamento.
Representação JSON |
---|
{ "bulletAlignment": enum ( |
Campos | |
---|---|
bulletAlignment |
O alinhamento do marcador dentro do espaço alocado para renderizar o marcador. |
glyphFormat |
A string de formato usada pelos marcadores neste nível de aninhamento. O formato do glifo contém um ou mais marcadores, que são substituídos pelos valores adequados, dependendo de 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 para os níveis de aninhamento principais. Por exemplo, uma lista pode ter um formato de glifo de
Para níveis de aninhamento ordenados, a string que substitui um marcador no formato de glifo de um parágrafo específico depende da ordem do parágrafo na lista. |
indentFirstLine |
A quantidade de recuo para a primeira linha dos parágrafos neste nível de aninhamento. |
indentStart |
A quantidade de recuo para parágrafos neste nível de aninhamento. Aplicado ao lado que corresponde ao início do texto, com base na direção de 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 nesse nível de aninhamento. Um valor de 0 é tratado como um valor de 1 para as listas numeradas e numeradas com letra. Para valores de 0 e 1, as listas de algarismos com letras e romanas começarão em Esse valor é ignorado para níveis de aninhamento com glifos não ordenados. |
Campo de união glyph_kind . O tipo de glifo usado pelos marcadores. Isso define o símbolo do marcador que substitui os marcadores no glyph_format . glyph_kind pode ser apenas de um dos tipos a seguir: |
|
glyphType |
Tipo de glifo usado pelos marcadores quando os parágrafos desse nível de aninhamento são ordenados. O tipo de glifo determina o tipo de glifo usado para substituir marcadores de posição no |
glyphSymbol |
Um símbolo de glifo personalizado usado por marcadores quando os parágrafos desse nível de aninhamento não são ordenados. O símbolo de glifo substitui os marcadores no |
BulletAlignment (em inglês)
Os tipos de alinhamento de um marcador.
Enums | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
O alinhamento do marcador não foi especificado. |
START |
O marcador é alinhado ao início do espaço alocado para renderizá-lo. Alinhado à esquerda para texto LTR, alinhado à direita caso contrário. |
CENTER |
O marcador é alinhado ao centro do espaço alocado para renderizá-lo. |
END |
O marcador é alinhado ao final do espaço alocado para renderizar o marcador. Alinhado à direita para texto LTR, alinhado à esquerda caso contrário. |
Tipo de glifo
Os tipos de glifos usados por marcadores quando os parágrafos desse nível de aninhamento são ordenados.
Enums | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
O tipo de glifo não foi especificado ou não é compatível. |
NONE |
Uma string vazia. |
DECIMAL |
Um número, como 1 , 2 ou 3 . |
ZERO_DECIMAL |
Um número em que números de um único dígito têm um zero, como 01 , 02 ou 03 . Números com mais de um dígito não são prefixados com um zero. |
UPPER_ALPHA |
Uma letra maiúscula, como A , B ou C . |
ALPHA |
Uma letra minúscula, como a , b ou c . |
UPPER_ROMAN |
Um algarismo romano maiúsculo, como I , II ou III . |
ROMAN |
Um algarismo romano minúsculo, como i , ii ou iii . |
SuggestedListProperties
Uma alteração sugerida para ListProperties
.
Representação JSON |
---|
{ "listProperties": { object ( |
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. 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 do Os estados de sugestão de nível de aninhamento são retornados em ordem crescente do nível de aninhamento, com o menos aninhado retornado primeiro. |
NestingLevelSuggestionState
Uma máscara que indica quais dos campos na base NestingLevel
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Campos | |
---|---|
bulletAlignmentSuggested |
Indica se houve uma alteração sugerida para |
glyphTypeSuggested |
Indica se houve uma alteração 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 campos do |
startNumberSuggested |
Indica se houve uma alteração sugerida para |
Intervalos nomeados
Uma coleção de todas as 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 |
Intervalo nomeado
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 seu conteúdo possa ser lido ou editado programaticamente mais tarde. Um documento pode conter vários intervalos nomeados com o mesmo nome, mas cada intervalo nomeado tem um código exclusivo.
Um intervalo nomeado é criado com um único Range
, e o conteúdo inserido nele geralmente expande esse intervalo. No entanto, determinadas alterações de documentos podem fazer com que o intervalo seja dividido em vários intervalos.
Os intervalos nomeados não são particulares. Todos os aplicativos e colaboradores que têm acesso ao documento podem ver seus intervalos nomeados.
Representação JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Campos | |
---|---|
namedRangeId |
O ID do intervalo nomeado. |
name |
O nome do intervalo nomeado. |
ranges[] |
Os intervalos que pertencem a esse intervalo nomeado. |
Intervalo
Especifica um intervalo contíguo de texto.
Representação JSON |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer } |
Campos | |
---|---|
segmentId |
O ID do cabeçalho, rodapé ou nota de rodapé no qual esse intervalo está contido. Um código de segmento vazio representa o corpo do documento. |
startIndex |
Índice inicial deste intervalo com base em zero, em unidades de código UTF-16. Em todos os usos atuais, é necessário fornecer um índice inicial. Esse campo é um Int32Value para acomodar futuros casos de uso com intervalos abertos. |
endIndex |
O índice final desse intervalo, exclusivo, em unidades de código UTF-16. Em todos os usos atuais, é necessário fornecer um índice final. Esse campo é um Int32Value para acomodar futuros casos de uso com intervalos abertos. |
Modo de sugestão
O modo de visualização de sugestões aplicado ao documento que indica como as alterações sugeridas são representadas. Ele oferece opções para ler o documento com todas as sugestões inline, aceitas ou rejeitadas.
Enums | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
O SuggestionsViewMode aplicado ao documento retornado depende do nível de acesso atual do usuário. Se o usuário só tiver acesso para ver, PREVIEW_WITHOUT_SUGGESTIONS será aplicado. Caso contrário, SUGGESTIONS_INLINE será aplicado. Este é o modo de visualização de sugestões padrão. |
SUGGESTIONS_INLINE |
O documento retornado tem sugestões inline. As alterações sugeridas serão diferenciadas do conteúdo base no documento. As solicitações para recuperar um documento usando este modo retornarão um erro 403 se o usuário não tiver permissão para visualizar as alterações sugeridas. |
PREVIEW_SUGGESTIONS_ACCEPTED |
O documento retornado é uma visualização com todas as alterações sugeridas aceitas. As solicitações para recuperar um documento usando este modo retornarão um erro 403 se o usuário não tiver permissão para visualizar as alterações sugeridas. |
PREVIEW_WITHOUT_SUGGESTIONS |
O documento retornado é uma visualização com todas as alterações sugeridas rejeitadas se houver sugestões no documento. |
Objeto in-line
Um objeto que aparece em linha com o texto. Um InlineObject contém um EmbeddedObject
, como uma imagem.
Representação JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
Campos | |
---|---|
objectId |
O ID deste objeto in-line. Pode ser usado para atualizar as propriedades de um objeto. |
inlineObjectProperties |
As propriedades deste objeto in-line. |
suggestedInlineObjectPropertiesChanges |
Alterações sugeridas para as propriedades do objeto in-line, codificadas pelo código da sugestão. |
suggestedInsertionId |
O código de inserção sugerido. Se estiver vazio, isso 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. |
PropriedadesInLineObject
Propriedades de uma InlineObject
.
Representação JSON |
---|
{
"embeddedObject": {
object ( |
Campos | |
---|---|
embeddedObject |
O objeto incorporado deste objeto in-line. |
Objeto incorporado
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 da fonte vinculada externa. Por exemplo, ele contém uma referência ao gráfico do Planilhas Google de origem quando o objeto incorporado for um gráfico vinculado. Se não for definido, o objeto incorporado não será vinculado. |
Campo de união properties . As propriedades específicas de cada tipo de objeto incorporado. properties pode ser apenas de um dos tipos a seguir: |
|
embeddedDrawingProperties |
As propriedades de um desenho incorporado. |
imageProperties |
As propriedades de uma imagem. |
EmbeddedDrawingProperties
As propriedades de um desenho incorporado e usadas para diferenciar o tipo de objeto. Um desenho incorporado é aquele criado e editado em um documento. Não há suporte para detalhes abrangentes.
ImageProperties
As propriedades de uma imagem.
Representação JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
Campos | |
---|---|
contentUri |
Um URI para a imagem com duração padrão de 30 minutos. Esse URI é marcado com a conta do solicitante. Qualquer pessoa com o URI acessa a imagem como o solicitante original. O acesso à imagem pode ser perdido se as configurações de compartilhamento do documento forem alteradas. |
sourceUri |
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 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 deve estar no intervalo [-1,0, 1,0], em que 0 significa que não há efeito. |
transparency |
O efeito de transparência da imagem. O valor deve estar no intervalo [0.0, 1.0], em que 0 significa não ter efeito e 1 significa transparente. |
cropProperties |
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 por deslocamentos fracionários das quatro bordas do conteúdo original.
- Se o deslocamento estiver no intervalo (0, 1), a borda correspondente do retângulo de corte será posicionada dentro do retângulo delimitador original da imagem.
- Se o deslocamento for negativo ou maior que 1, a borda correspondente do retângulo de corte será posicionada fora do retângulo delimitador original da imagem.
- Se todos os deslocamentos e ângulos de rotação forem zero, a imagem não será cortada.
Representação JSON |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
Campos | |
---|---|
offsetLeft |
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 ao redor do centro, em radianos. A rotação é aplicada depois dos deslocamentos. |
Borda do objeto incorporado
Uma borda ao redor de um EmbeddedObject
.
Representação JSON |
---|
{ "color": { object ( |
Campos | |
---|---|
color |
A cor da borda. |
width |
A largura da borda. |
dashStyle |
O estilo de traço da borda. |
propertyState |
O estado da propriedade de borda. |
Estado da propriedade
Os estados possíveis de uma propriedade.
Enums | |
---|---|
RENDERED |
Se o estado de uma propriedade for RENDERED, o elemento vai ter a propriedade correspondente quando renderizado no documento. Esse é o valor padrão. |
NOT_RENDERED |
Se o estado de uma propriedade for NOT_RENDERED, o elemento não terá a propriedade correspondente quando renderizado no documento. |
LinkedContentReference
Uma referência ao conteúdo da fonte vinculada externa.
Representação JSON |
---|
{ // Union field |
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
Uma referência a um gráfico vinculado incorporado ao Planilhas Google.
Representação JSON |
---|
{ "spreadsheetId": string, "chartId": integer } |
Campos | |
---|---|
spreadsheetId |
O código da planilha do Planilhas Google que contém o gráfico de origem. |
chartId |
O código do gráfico específico incorporado à planilha do Planilhas Google. |
SuggestedInlineObjectProperties
Uma alteração sugerida para InlineObjectProperties
.
Representação JSON |
---|
{ "inlineObjectProperties": { object ( |
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. 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 do |
EmbeddedObjectSuggestionState
Uma máscara que indica quais dos campos na base EmbeddedObject
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Campos | |
---|---|
embeddedDrawingPropertiesSuggestionState |
Uma máscara que indica quais campos do |
imagePropertiesSuggestionState |
Uma máscara que indica quais campos do |
titleSuggested |
Indica se houve uma alteração sugerida para |
descriptionSuggested |
Indica se houve uma alteração sugerida para |
embeddedObjectBorderSuggestionState |
Uma máscara que indica quais campos do |
sizeSuggestionState |
Uma máscara que indica quais campos do |
marginLeftSuggested |
Indica se houve uma alteração sugerida para |
marginRightSuggested |
Indica se houve uma alteração 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 do |
EmbeddedDrawingPropertiesSuggestionState
Uma máscara que indica quais dos campos na base EmbeddedDrawingProperties
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
ImagePropertiesSuggestionState
Uma máscara que indica quais dos campos na base ImageProperties
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Campos | |
---|---|
contentUriSuggested |
Indica se houve uma alteração sugerida para |
sourceUriSuggested |
Indica se houve uma alteração sugerida para [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 alteração sugerida para [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
Indica se houve uma alteração sugerida para [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
Uma máscara que indica quais campos do |
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 base CropProperties
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Campos | |
---|---|
offsetLeftSuggested |
Indica se houve uma alteração sugerida para |
offsetRightSuggested |
Indica se houve uma alteração sugerida para |
offsetTopSuggested |
Indica se houve uma alteração 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 dos campos na base EmbeddedObjectBorder
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
Campos | |
---|---|
colorSuggested |
Indica se houve uma alteração sugerida para [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
Indica se houve uma alteração sugerida para [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 para [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
Uma máscara que indica quais dos campos na base LinkedContentReference
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Campos | |
---|---|
sheetsChartReferenceSuggestionState |
Uma máscara que indica quais campos do |
PlanilhasChartReferenceSuggestionState
Uma máscara que indica quais dos campos na base SheetsChartReference
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Campos | |
---|---|
spreadsheetIdSuggested |
Indica se houve uma alteração sugerida para |
chartIdSuggested |
Indica se houve uma alteração sugerida para |
Objeto de posição
Um objeto vinculado a uma Paragraph
e posicionado em relação ao início do parágrafo. Um PositionedObject contém um EmbeddedObject
, como uma imagem.
Representação JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Campos | |
---|---|
objectId |
O ID deste objeto posicionado. |
positionedObjectProperties |
As propriedades deste objeto posicionado. |
suggestedPositionedObjectPropertiesChanges |
As alterações sugeridas para as propriedades do objeto posicionado, codificadas pelo ID da sugestão. |
suggestedInsertionId |
O código de inserção sugerido. Se estiver vazio, isso 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 uma PositionedObject
.
Representação JSON |
---|
{ "positioning": { object ( |
Campos | |
---|---|
positioning |
O posicionamento deste objeto posicionado em relação à nova linha de |
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 (em inglês)
Os layouts possíveis de um [PositionedObject][google.aps.docs.v1.PositionedObject].
Enums | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED |
O layout não foi especificado. |
WRAP_TEXT |
O texto envolve o objeto posicionado. |
BREAK_LEFT |
Quebra o texto de forma que o objeto posicionado fique à esquerda e o texto à direita. |
BREAK_RIGHT |
Quebra o texto de forma que o objeto posicionado esteja à direita e o texto à esquerda. |
BREAK_LEFT_RIGHT |
Quebra o texto de forma que não haja texto à esquerda ou à direita do objeto posicionado. |
IN_FRONT_OF_TEXT |
O objeto posicionado está na frente do texto. |
BEHIND_TEXT |
O objeto posicionado está atrás do texto. |
SuggestedPositionedObjectProperties
Uma alteração sugerida para PositionedObjectProperties
.
Representação JSON |
---|
{ "positionedObjectProperties": { object ( |
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. 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 do |
embeddedObjectSuggestionState |
Uma máscara que indica quais campos do |
PositionedObjectPositioningSuggestionState
Uma máscara que indica quais dos campos na base PositionedObjectPositioning
foram alterados nessa sugestão. Para qualquer campo definido como verdadeiro, há um novo valor sugerido.
Representação JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
Campos | |
---|---|
layoutSuggested |
Indica se houve uma alteração sugerida para |
leftOffsetSuggested |
Indica se houve uma alteração sugerida para |
topOffsetSuggested |
Indica se houve uma alteração sugerida para |
Métodos |
|
---|---|
|
Aplica uma ou mais atualizações ao documento. |
|
Cria um documento em branco usando o título fornecido na solicitação. |
|
Obtém a versão mais recente do documento especificado. |