Requests

Solicitação

Uma única atualização a ser aplicada a um documento.

Representação JSON 
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  }
  // End of list of possible types for union field request.
}
Campos
Campo de união request. A solicitação específica a ser aplicada. Exatamente um campo é obrigatório. request pode ser apenas uma das seguintes opções:
replaceAllText

object (ReplaceAllTextRequest)

Substitui todas as instâncias do texto especificado.

insertText

object (InsertTextRequest)

Insere texto no local especificado.

updateTextStyle

object (UpdateTextStyleRequest)

Atualiza o estilo de texto no intervalo especificado.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Cria marcadores para parágrafos.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Exclui marcadores de parágrafos.

createNamedRange

object (CreateNamedRangeRequest)

Cria um intervalo nomeado.

deleteNamedRange

object (DeleteNamedRangeRequest)

Exclui um intervalo nomeado.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Atualiza o estilo de parágrafo no intervalo especificado.

deleteContentRange

object (DeleteContentRangeRequest)

Exclui o conteúdo do documento.

insertInlineImage

object (InsertInlineImageRequest)

Insere uma imagem inline no local especificado.

insertTable

object (InsertTableRequest)

Insere uma tabela no local especificado.

insertTableRow

object (InsertTableRowRequest)

Insere uma linha vazia em uma tabela.

insertTableColumn

object (InsertTableColumnRequest)

Insere uma coluna vazia em uma tabela.

deleteTableRow

object (DeleteTableRowRequest)

Exclui uma linha de uma tabela.

deleteTableColumn

object (DeleteTableColumnRequest)

Exclui uma coluna de uma tabela.

insertPageBreak

object (InsertPageBreakRequest)

Insere uma quebra de página no local especificado.

deletePositionedObject

object (DeletePositionedObjectRequest)

Exclui um objeto posicionado do documento.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Atualiza as propriedades das colunas em uma tabela.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Atualiza o estilo das células da tabela.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Atualiza o estilo da linha em uma tabela.

replaceImage

object (ReplaceImageRequest)

Substitui uma imagem no documento.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Atualiza o estilo do documento.

mergeTableCells

object (MergeTableCellsRequest)

Mescla as células em uma tabela.

unmergeTableCells

object (UnmergeTableCellsRequest)

Cancela a mesclagem de células em uma tabela.

createHeader

object (CreateHeaderRequest)

Cria um cabeçalho.

createFootnote

object (CreateFootnoteRequest)

Cria uma nota de rodapé.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Substitui o conteúdo em um intervalo nomeado.

updateSectionStyle

object (UpdateSectionStyleRequest)

Atualiza o estilo de seção do intervalo especificado.

insertSectionBreak

object (InsertSectionBreakRequest)

Insere uma quebra de seção no local especificado.

deleteHeader

object (DeleteHeaderRequest)

Exclui um cabeçalho do documento.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Atualiza o número de linhas de cabeçalho fixadas em uma tabela.

Substituir AllTextRequest

Substitui todas as instâncias de texto que correspondem a um critério por replace text.

Representação JSON 
{
  "replaceText": string,

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
Campos
replaceText

string

O texto que substituirá o texto correspondente.

Campo de união criteria. Os critérios usados para corresponder ao texto a ser substituído. criteria pode ser apenas uma das seguintes opções:
containsText

object (SubstringMatchCriteria)

Encontra texto no documento que corresponde a esta substring.

SubstringMatchCriteria

Um critério que corresponde a uma string de texto específica no documento.

Representação JSON 
{
  "text": string,
  "matchCase": boolean
}
Campos
text

string

O texto a ser pesquisado no documento.

matchCase

boolean

Indica se a pesquisa deve respeitar o caso:

  • True: a pesquisa diferencia maiúsculas de minúsculas.
  • False: a pesquisa não diferencia maiúsculas de minúsculas.

InsertTextRequest

Insere texto no local especificado.

Representação JSON 
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
text

string

O texto a ser inserido.

A inserção de um caractere de nova linha cria implicitamente um novo Paragraph nesse índice. O estilo do novo parágrafo será copiado do parágrafo no índice de inserção atual, incluindo listas e marcadores.

Os estilos de texto para texto inserido serão determinados automaticamente, preservando o estilo do texto ao lado. Na maioria dos casos, o estilo do texto inserido corresponderá ao texto imediatamente antes do índice de inserção.

Alguns caracteres de controle (U+0000-U+0008, U+000C-U+001F) e caracteres da Área de uso privado do plano multilíngue Unicode Basic (U+E000-U+F8FF) serão retirados do texto inserido.

Campo de união insertion_location. O local onde o texto será inserido. insertion_location pode ser apenas uma das seguintes opções:
location

object (Location)

Insere o texto em um índice específico no documento.

O texto precisa ser inserido dentro dos limites de um Paragraph existente. Por exemplo, não é possível inserir texto no índice inicial de uma tabela (por exemplo, entre a tabela e o parágrafo anterior dela). O texto precisa ser inserido no parágrafo anterior.

endOfSegmentLocation

object (EndOfSegmentLocation)

Insere o texto no final de um cabeçalho, rodapé, nota de rodapé ou corpo do documento.

Local

Um local específico no documento.

Representação JSON 
{
  "segmentId": string,
  "index": integer
}
Campos
segmentId

string

O ID do cabeçalho, rodapé ou nota de rodapé em que o local está. Um código de segmento vazio representa o corpo do documento.

index

integer

O índice baseado em zero, em unidades de código UTF-16.

O índice é relativo ao início do segmento especificado por segmentId.

EndOfSegmentLocation

Local no final de um corpo, cabeçalho, rodapé ou nota de rodapé. O local fica imediatamente antes da última nova linha no segmento do documento.

Representação JSON 
{
  "segmentId": string
}
Campos
segmentId

string

O ID do cabeçalho, rodapé ou nota de rodapé em que o local está. Um código de segmento vazio representa o corpo do documento.

Atualização de TextTextStyleRequest

Atualize o estilo do texto.

Representação JSON 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
textStyle

object (TextStyle)

Os estilos a serem definidos no texto.

Se o valor de um estilo específico corresponder ao valor do pai, esse estilo será definido como herdado.

Algumas alterações de estilo de texto podem causar outras alterações para refletir o comportamento do editor do Documentos Google. Consulte a documentação de TextStyle para mais informações.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz textStyle está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar o estilo do texto para negrito, defina fields como "bold".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

Campo de união insertion_location. O tipo de intervalo usado em que o estilo de texto será atualizado. insertion_location pode ser apenas uma das seguintes opções:
range

object (Range)

O intervalo de texto a ser estilizado.

O intervalo pode ser estendido para incluir novas linhas adjacentes.

Se o intervalo contiver um parágrafo que pertença a uma lista, o marcador dele também será atualizado com o estilo de texto correspondente.

Os intervalos não podem ser inseridos em uma UpdateTextStyleRequest relativa.

CreateParagraphBulletsRequest

Cria marcadores para todos os parágrafos que se sobrepõem ao intervalo fornecido.

O nível de aninhamento de cada parágrafo será determinado contando as guias à frente de cada parágrafo. Para evitar espaço excessivo entre o marcador e o parágrafo correspondente, essas guias à esquerda são removidas por essa solicitação. Isso pode alterar os índices de partes do texto.

Se o parágrafo imediatamente anterior aos parágrafos atualizados estiver em uma lista com uma predefinição correspondente, os parágrafos atualizados serão adicionados a essa lista.

Representação JSON 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Campos
range

object (Range)

O intervalo ao qual a predefinição de marcador é aplicada.

bulletPreset

enum (BulletGlyphPreset)

Os tipos de glifos de marcador a serem usados.

Conjunto de BulletGlyphph

Padrões predefinidos de glifos de marcador para listas.

Esses padrões usam estes tipos de marcadores:

  • ARROW: uma seta, correspondente a um ponto de código Unicode U+2794
  • ARROW3D: uma seta com sombreamento 3D correspondente a um ponto de código Unicode U+27a2.
  • CHECKBOX: um quadrado oco, correspondente a um ponto de código Unicode U+274f
  • CIRCLE: um círculo vazio, que corresponde a um ponto de código Unicode U+25cb
  • DIAMOND: um diamante sólido, correspondente a um ponto de código Unicode U+25c6
  • DIAMONDX: um diamante com um "x", que corresponde a um ponto de código Unicode U+2756
  • HOLLOWDIAMOND: um losango vazado, correspondente a um ponto de código Unicode U+25c7
  • DISC: um círculo sólido, correspondente a um ponto de código Unicode U+25cf
  • SQUARE: um quadrado sólido, correspondente a um ponto de código Unicode U+25a0.
  • STAR: uma estrela, correspondente a um ponto de código Unicode U+2605
  • ALPHA: uma letra minúscula, como "a", "b" ou "c".
  • UPPERALPHA: uma letra maiúscula, como "A", "B" ou "C".
  • DECIMAL : um número, como "1", "2" ou "3".
  • ZERODECIMAL: 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 em zero.
  • ROMAN : um algarismo romano minúsculo, como "i", "ii" ou "iii".
  • UPPERROMAN: um algarismo romano romano, como "I", "II" ou "III".
  • LEFTTRIANGLE: um triângulo apontando para a esquerda, correspondente a um ponto de código Unicode U+25c4
Enums
BULLET_GLYPH_PRESET_UNSPECIFIED A predefinição de símbolo de marcador não foi especificada.
BULLET_DISC_CIRCLE_SQUARE Uma lista com marcadores com um glifo DISC, CIRCLE e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_DIAMONDX_ARROW3D_SQUARE Uma lista com marcadores com um glifo DIAMONDX, ARROW3D e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_CHECKBOX Uma lista com marcadores com glifos de CHECKBOX para todos os níveis de aninhamento.
BULLET_ARROW_DIAMOND_DISC Uma lista com marcadores com um glifo ARROW, DIAMOND e DISC para os três primeiros níveis de aninhamento de lista.
BULLET_STAR_CIRCLE_SQUARE Uma lista com marcadores com um glifo STAR, CIRCLE e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_ARROW3D_CIRCLE_SQUARE Uma lista com marcadores com um glifo ARROW3D, CIRCLE e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Uma lista com marcadores com um glifo LEFTTRIANGLE, DIAMOND e DISC para os três primeiros níveis de aninhamento de lista.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Uma lista com marcadores com um glifo DIAMONDX, HOLLOWDIAMOND e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_DIAMOND_CIRCLE_SQUARE Uma lista com marcadores com um glifo DIAMOND, CIRCLE e SQUARE para os três primeiros níveis de aninhamento de lista.
NUMBERED_DECIMAL_ALPHA_ROMAN Uma lista numerada com glifos numéricos DECIMAL, ALPHA e ROMAN para os três primeiros níveis de aninhamento da lista, seguidos por pontos.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Uma lista numerada com glifos numéricos DECIMAL, ALPHA e ROMAN para os três primeiros níveis de aninhamento da lista, seguidos por parênteses.
NUMBERED_DECIMAL_NESTED Uma lista numerada com glifos numéricos DECIMAL separados por pontos, em que cada nível de aninhamento usa o glifo do nível anterior como prefixo. Por exemplo: "1.", "1.1", "2.", "2.2".
NUMBERED_UPPERALPHA_ALPHA_ROMAN Uma lista numerada com glifos numéricos UPPERALPHA, ALPHA e ROMAN para os três primeiros níveis de aninhamento da lista, seguidos por pontos.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Uma lista numerada com glifos numéricos UPPERROMAN, UPPERALPHA e DECIMAL para os três primeiros níveis de aninhamento da lista, seguidos por pontos.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Uma lista numerada com glifos numéricos ZERODECIMAL, ALPHA e ROMAN para os três primeiros níveis de aninhamento da lista, seguidos por pontos.

ExcluirParagraphBulletBullets

Exclui os marcadores de todos os parágrafos que se sobrepõem ao intervalo fornecido.

O nível de aninhamento de cada parágrafo será preservado visualmente com a adição do recuo ao início do parágrafo correspondente.

Representação JSON 
{
  "range": {
    object (Range)
  }
}
Campos
range

object (Range)

O intervalo do qual os marcadores serão excluídos.

CreateNamedRangeRequest

Cria um NamedRange que faz referência ao intervalo fornecido.

Representação JSON 
{
  "name": string,
  "range": {
    object (Range)
  }
}
Campos
name

string

O nome do NamedRange. Os nomes não precisam ser exclusivos.

Os nomes precisam ter entre 1 e 256 caracteres, medidos em unidades de código UTF-16.

range

object (Range)

O intervalo ao qual o nome será aplicado.

DeleteNamedRangeRequest

Exclui um NamedRange.

Representação JSON 
{

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
Campos
Campo de união named_range_reference. O valor que determina quais intervalos excluir. Exatamente um deve ser definido. named_range_reference pode ser apenas uma das seguintes opções:
namedRangeId

string

O ID do intervalo nomeado a ser excluído.

name

string

O nome dos intervalos a serem excluídos. Todos os intervalos nomeados com o nome fornecido serão excluídos.

AtualizarParagraphParagraphRequest

Atualize o estilo de todos os parágrafos que se sobrepõem ao intervalo fornecido.

Representação JSON 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
paragraphStyle

object (ParagraphStyle)

Os estilos a serem definidos nos parágrafos.

Algumas alterações de estilo de parágrafo podem causar outras alterações para refletir o comportamento do editor do Documentos Google. Consulte a documentação de ParagraphStyle para mais informações.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz paragraphStyle está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a propriedade de alinhamento do estilo de parágrafo, defina fields como "alignment".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

Campo de união insertion_location. O tipo de intervalo usado em que o estilo de parágrafo será atualizado. insertion_location pode ser apenas uma das seguintes opções:
range

object (Range)

O intervalo que se sobrepõe aos parágrafos a serem estilizados.

DeleteContentRangeRequest

Exclui o conteúdo do documento.

Representação JSON 
{
  "range": {
    object (Range)
  }
}
Campos
range

object (Range)

O intervalo de conteúdo a ser excluído.

A exclusão de texto que cruza o limite de um parágrafo pode resultar em alterações em estilos, listas, objetos posicionados e favoritos de parágrafos à medida que os dois parágrafos são mesclados.

A tentativa de excluir determinados intervalos pode resultar em uma estrutura de documento inválida. Nesse caso, um erro 400 de solicitação inválida é retornado.

Alguns exemplos de solicitações de exclusão inválidas incluem:

Inserir imagem na solicitação

Insere um InlineObject contendo uma imagem no local fornecido.

Representação JSON 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
uri

string

O URI da imagem.

A imagem é buscada uma vez no momento da inserção e uma cópia é armazenada para exibição dentro do documento. As imagens devem ter menos de 50 MB, não pode exceder 25 megapixels e estar no formato PNG, JPEG ou GIF.

O URI fornecido precisa ser acessível publicamente e ter no máximo 2 KB. O URI em si é salvo com a imagem e exposto por meio do campo ImageProperties.content_uri.

objectSize

object (Size)

O tamanho da imagem no documento. Essa propriedade é opcional, e o tamanho final da imagem no documento é determinado pelas seguintes regras: * Se a largura e a altura não forem especificadas, o tamanho padrão da imagem será calculado com base em sua resolução. * Se uma dimensão for especificada, a outra dimensão será calculada para preservar a proporção da imagem. * Se a largura e a altura forem especificadas, a imagem será dimensionada para se ajustar às dimensões fornecidas, mantendo sua proporção.

Campo de união insertion_location. O local em que a imagem será inserida. insertion_location pode ser apenas uma das seguintes opções:
location

object (Location)

Insere a imagem em um índice específico no documento.

A imagem precisa ser inserida dentro dos limites de um Paragraph existente. Por exemplo, ela não pode ser inserida no índice inicial de uma tabela (ou seja, entre a tabela e seu parágrafo anterior).

Não é possível inserir imagens inline em uma nota de rodapé ou equação.

endOfSegmentLocation

object (EndOfSegmentLocation)

Insere o texto no final de um cabeçalho, rodapé ou corpo do documento.

Não é possível inserir imagens inline em uma nota de rodapé.

InsertTableRequest

Insere uma tabela no local especificado.

Um caractere de nova linha será inserido antes da tabela inserida.

Representação JSON 
{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
rows

integer

O número de linhas na tabela.

columns

integer

O número de colunas na tabela.

Campo de união insertion_location. O local em que a tabela será inserida. insertion_location pode ser apenas uma das seguintes opções:
location

object (Location)

Insere a tabela em um índice de modelo específico.

Um caractere de nova linha será inserido antes da tabela inserida, portanto, o índice de início da tabela estará no índice de localização especificado +1.

A tabela precisa ser inserida dentro dos limites de um Paragraph existente. Por exemplo, ela não pode ser inserida no índice inicial de uma tabela (ou seja, entre uma tabela existente e seu parágrafo anterior).

Não é possível inserir tabelas em uma nota de rodapé ou em uma equação.

endOfSegmentLocation

object (EndOfSegmentLocation)

Insere a tabela no final do cabeçalho, rodapé ou corpo do documento fornecido. Um caractere de nova linha será inserido antes da tabela inserida.

Não é possível inserir tabelas em uma nota de rodapé.

InsertTableRowRequest

Insere uma linha vazia em uma tabela.

Representação JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Campos
tableCellLocation

object (TableCellLocation)

O local da célula da tabela de referência a partir do qual as linhas serão inseridas.

Uma nova linha será inserida acima (ou abaixo) da linha em que a célula de referência está. Se a célula de referência for uma célula mesclada, uma nova linha será inserida acima (ou abaixo) da célula mesclada.

insertBelow

boolean

Define se uma nova linha deve ser inserida abaixo do local da célula de referência.

  • True: insira abaixo da célula.
  • False: insira acima da célula.

TableCellLocation

Local de uma única célula em uma tabela.

Representação JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Campos
tableStartLocation

object (Location)

O local em que a tabela começa no documento.

rowIndex

integer

O índice de linhas com base em zero. Por exemplo, a segunda linha da tabela tem um índice de 1.

columnIndex

integer

O índice de coluna com base em zero. Por exemplo, a segunda coluna da tabela tem um índice de 1.

InsertTableColumnRequest

Insere uma coluna vazia em uma tabela.

Representação JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Campos
tableCellLocation

object (TableCellLocation)

O local da célula da tabela de referência a partir do qual as colunas serão inseridas.

Uma nova coluna será inserida à esquerda (ou à direita) da coluna em que a célula de referência está. Se a célula de referência for uma célula mesclada, uma nova coluna será inserida à esquerda (ou à direita) da célula mesclada.

insertRight

boolean

Define se uma nova coluna deve ser inserida à direita do local da célula de referência.

  • True: insira para a direita.
  • False: insira para a esquerda.

DeleteTableRowRequest

Exclui uma linha de uma tabela.

Representação JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Campos
tableCellLocation

object (TableCellLocation)

O local da célula da tabela de referência de onde a linha será excluída.

A linha que esta célula abrange será excluída. Se esta for uma célula mesclada que abrange várias linhas, todas as linhas que a célula abrange serão excluídas. Se nenhuma linha permanecer na tabela após a exclusão, a tabela inteira será excluída.

DeleteTableColumnRequest

Exclui uma coluna de uma tabela.

Representação JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Campos
tableCellLocation

object (TableCellLocation)

O local da célula da tabela de referência de onde a coluna será excluída.

A coluna desta célula será excluída. Se esta for uma célula mesclada que abrange várias colunas, todas as colunas que a célula abrange serão excluídas. Se nenhuma coluna permanecer na tabela após a exclusão, a tabela inteira será excluída.

InsertPageBreakRequest

Insere uma quebra de página seguida de uma nova linha no local especificado.

Representação JSON 
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
Campo de união insertion_location. O local onde a quebra de página será inserida. insertion_location pode ser apenas uma das seguintes opções:
location

object (Location)

Insere a quebra de página em um índice específico do documento.

A quebra de página precisa ser inserida dentro dos limites de um Paragraph existente. Por exemplo, ela não pode ser inserida no índice inicial de uma tabela (ou seja, entre a tabela e seu parágrafo anterior).

Não é possível inserir quebras de página dentro de uma tabela, equação, nota de rodapé, cabeçalho ou rodapé. Como as quebras de página só podem ser inseridas no corpo, o campo segment ID precisa estar vazio.

endOfSegmentLocation

object (EndOfSegmentLocation)

Insere a quebra de página no final do corpo do documento.

As quebras de página não podem ser inseridas em uma nota de rodapé, cabeçalho ou rodapé. Como as quebras de página só podem ser inseridas no corpo, o campo segment ID precisa estar vazio.

DeletePositionedObjectRequest

Exclui um PositionedObject do documento.

Representação JSON 
{
  "objectId": string
}
Campos
objectId

string

O ID do objeto posicionado a ser excluído.

Atualizar TableColumnPropertiesRequest

Atualiza o TableColumnProperties das colunas em uma tabela.

Representação JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Campos
tableStartLocation

object (Location)

O local em que a tabela começa no documento.

columnIndices[]

integer

A lista de índices de coluna com base em zero cuja propriedade deve ser atualizada. Se nenhum índice for especificado, todas as colunas serão atualizadas.

tableColumnProperties

object (TableColumnProperties)

As propriedades da coluna da tabela a serem atualizadas.

Se o valor de tableColumnProperties#width for menor que 5 pontos (5/72 polegadas), um erro de solicitação inválida 400 será retornado.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz tableColumnProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a largura da coluna, defina fields como "width".

Atualizar TableCellStyleRequest

Atualiza o estilo de um intervalo de células da tabela.

Representação JSON 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
Campos
tableCellStyle

object (TableCellStyle)

O estilo a ser definido nas células da tabela.

Ao atualizar bordas, se uma célula compartilha uma borda com uma célula adjacente, a propriedade de borda correspondente da célula adjacente também é atualizada. As bordas mescladas e invisíveis não são atualizadas.

Como a atualização de uma borda compartilhada por células adjacentes na mesma solicitação pode causar atualizações de borda conflitantes, as atualizações de borda são aplicadas na seguinte ordem:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz tableCellStyle está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a cor do plano de fundo da célula da tabela, defina fields como "backgroundColor".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

Campo de união cells. As células que serão atualizadas. cells pode ser apenas uma das seguintes opções:
tableRange

object (TableRange)

O intervalo da tabela que representa o subconjunto da tabela à qual as atualizações são aplicadas.

tableStartLocation

object (Location)

O local em que a tabela começa no documento. Quando especificado, as atualizações são aplicadas a todas as células na tabela.

Intervalo da tabela

Um intervalo de tabela representa uma referência a um subconjunto de uma tabela.

É importante observar que as células especificadas por um intervalo de tabela não formam necessariamente um retângulo. Por exemplo, digamos que temos uma tabela 3 x 3 na qual todas as células da última linha estão mescladas. A tabela terá esta aparência: 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

Um intervalo de tabela com local de célula da tabela = (tableStartLocation, row = 0, column = 0), row span = 3 e column span = 2 especifica as seguintes células: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
Representação JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Campos
tableCellLocation

object (TableCellLocation)

O local da célula onde o intervalo da tabela começa.

rowSpan

integer

O período da linha do intervalo da tabela.

columnSpan

integer

O período da coluna do intervalo da tabela.

Atualizar TableRowStyleRequest

Atualiza o TableRowStyle de linhas em uma tabela.

Representação JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
Campos
tableStartLocation

object (Location)

O local em que a tabela começa no documento.

rowIndices[]

integer

A lista de índices de linha com base em zero cujo estilo deve ser atualizado. Se nenhum índice for especificado, todas as linhas serão atualizadas.

tableRowStyle

object (TableRowStyle)

Os estilos a serem definidos nas linhas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz tableRowStyle está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a altura mínima da linha, defina fields como "minRowHeight".

Solicitação de substituição de imagem

Substitui uma imagem existente por uma nova.

A substituição de uma imagem remove alguns image effects da imagem existente para espelhar o comportamento do editor do Documentos.

Representação JSON 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod)
}
Campos
imageObjectId

string

O ID da imagem existente que será substituída. O ID pode ser recuperado a partir da resposta de uma solicitação get.

uri

string

O URI da nova imagem.

A imagem é buscada uma vez no momento da inserção e uma cópia é armazenada para exibição dentro do documento. As imagens precisam ter menos de 50 MB, não podem exceder 25 megapixels e precisam estar no formato PNG, JPEG ou GIF.

O URI fornecido não pode ultrapassar 2 KB de comprimento. O URI é salvo com a imagem e exposto por meio do campo ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

O método de substituição.

ImageReplaceMethod

O método de substituição de imagem.

Enums
IMAGE_REPLACE_METHOD_UNSPECIFIED Método de substituição de imagem não especificado. Este valor não pode ser usado.
CENTER_CROP Dimensiona e centraliza a imagem para preencher os limites da imagem original. A imagem pode ser cortada para preencher os limites da imagem original. O tamanho renderizado da imagem será igual ao da imagem original.

Atualizar DocumentStyleStyle

Atualiza o DocumentStyle.

Representação JSON 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string
}
Campos
documentStyle

object (DocumentStyle)

Os estilos a serem definidos no documento.

Algumas alterações no estilo de documentos podem causar outras alterações para refletir o comportamento do editor do Documentos Google. Consulte a documentação de DocumentStyle para mais informações.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz documentStyle está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar o plano de fundo, defina fields como "background".

MesclarTableCellsRequest

Mescla as células em um Table.

Representação JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Campos
tableRange

object (TableRange)

O intervalo da tabela que especifica as células a serem mescladas.

O texto das células que estão sendo mescladas será concatenado e armazenado na célula "head" do intervalo. Esta é a célula superior esquerda do intervalo quando a direção do conteúdo é da esquerda para a direita. Caso contrário, é a célula superior direita do intervalo.

Se o intervalo não for retangular (o que pode ocorrer em alguns casos em que o intervalo abrange células que já foram mescladas ou onde a tabela não é retangular), será retornado um erro 400 de solicitação inválida.

UnmergeTableCellsRequest

Cancela a mesclagem de células em uma Table.

Representação JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Campos
tableRange

object (TableRange)

O intervalo da tabela que especifica as células a serem desfeitas.

Todas as células mescladas nesse intervalo não serão mescladas, e as células que já foram mescladas não serão afetadas. Se o intervalo não tiver células mescladas, a solicitação não terá efeito.

Se houver texto em qualquer uma das células mescladas, o texto permanecerá na célula "principal" do bloco resultante de células não mescladas. A célula "principal" é a célula superior esquerda quando a direção do conteúdo é da esquerda para a direita; caso contrário, é o canto superior direito.

Solicitação de criação de cabeçalho

Cria um Header. O novo cabeçalho é aplicado ao SectionStyle no local do SectionBreak, se especificado. Caso contrário, é aplicado ao DocumentStyle.

Se já existir um cabeçalho do tipo especificado, será retornado um erro 400 de solicitação inválida.

Representação JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Campos
type

enum (HeaderFooterType)

O tipo de cabeçalho a ser criado.

sectionBreakLocation

object (Location)

O local do SectionBreak, que começa a seção a que este cabeçalho deve pertencer. Se "sectionBreakLocation" não estiver definido ou se referir à primeira quebra de seção no corpo do documento, o cabeçalho será aplicado à DocumentStyle.

Tipo de rodapé

Os tipos de cabeçalhos e rodapés que podem ser criados.

Enums
DEFAULT Um cabeçalho/rodapé padrão.

CreateFooterRequest

Cria um Footer. O novo rodapé é aplicado ao SectionStyle no local do SectionBreak, se especificado. Caso contrário, é aplicado ao DocumentStyle.

Se já existir um rodapé do tipo especificado, será retornado um erro 400 de solicitação inválida.

Representação JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Campos
type

enum (HeaderFooterType)

O tipo de rodapé a ser criado.

sectionBreakLocation

object (Location)

O local do SectionBreak, imediatamente anterior à seção com SectionStyle ao qual o rodapé pertence. Se ela não for definida ou se referir à primeira quebra de seção no documento, o rodapé será aplicado ao estilo do documento.

CreateFootnoteRequest

Cria um segmento Footnote e insere um novo FootnoteReference no local especificado.

O novo segmento Footnote conterá um espaço seguido por um caractere de nova linha.

Representação JSON 
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
Campos
Campo de união footnote_reference_location. O local para inserir a referência da nota de rodapé. footnote_reference_location pode ser apenas uma das seguintes opções:
location

object (Location)

Insere a referência da nota de rodapé em um índice específico do documento.

A referência da nota de rodapé precisa ser inserida dentro dos limites de um Paragraph existente. Por exemplo, ela não pode ser inserida no índice inicial de uma tabela (ou seja, entre a tabela e seu parágrafo anterior).

Não é possível inserir referências de rodapé em uma equação, cabeçalho, rodapé ou nota de rodapé. Como as referências de nota de rodapé só podem ser inseridas no corpo, o campo segment ID precisa estar vazio.

endOfSegmentLocation

object (EndOfSegmentLocation)

Insere a referência de nota de rodapé no final do corpo do documento.

Não é possível inserir referências de rodapé em cabeçalhos, rodapés ou notas de rodapé. Como as referências de nota de rodapé só podem ser inseridas no corpo, o campo segment ID precisa estar vazio.

ReplaceNamedRangeContentRequest

Substitui o conteúdo do NamedRange ou NamedRanges especificado pelo conteúdo de substituição fornecido.

Observe que um NamedRange individual pode consistir em vários ranges não contínuos. Nesse caso, somente o conteúdo do primeiro intervalo será substituído. Os outros intervalos e o conteúdo deles serão excluídos.

Nos casos em que a substituição ou exclusão de intervalos resultaria em uma estrutura de documento inválida, um erro de solicitação 400 inválido será retornado.

Representação JSON 
{

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
Campos
Campo de união replacement_content. O conteúdo para substituir o conteúdo existente do intervalo nomeado. replacement_content pode ser apenas uma das seguintes opções:
text

string

Substitui o conteúdo dos intervalos nomeados especificados pelo texto fornecido.

Campo de união named_range_reference. Uma referência aos intervalos nomeados cujo conteúdo será substituído. named_range_reference pode ser apenas uma das seguintes opções:
namedRangeId

string

O ID do intervalo nomeado cujo conteúdo será substituído.

Se não houver um intervalo nomeado com o ID fornecido, um erro de solicitação inválida 400 será retornado.

namedRangeName

string

O nome do NamedRanges cujo conteúdo será substituído.

Se houver vários named ranges com o nome fornecido, o conteúdo de cada um será substituído. Se não houver intervalos nomeados com o nome fornecido, a solicitação será um ambiente autônomo.

Atualização da seção de estilo da solicitação

Atualiza o SectionStyle.

Representação JSON 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Campos
range

object (Range)

O intervalo que se sobrepõe às seções a serem personalizadas.

Como as quebras de seção só podem ser inseridas no corpo, o campo segment ID precisa estar vazio.

sectionStyle

object (SectionStyle)

Os estilos a serem definidos na seção.

Algumas alterações de estilo da seção podem causar outras alterações para refletir o comportamento do editor do Documentos Google. Consulte a documentação de SectionStyle para mais informações.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz sectionStyle está implícita e não pode ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a margem esquerda, defina fields como "marginLeft".

InsertSectionBreakRequest

Insere uma quebra de seção no local especificado.

Um caractere de nova linha será inserido antes da quebra de seção.

Representação JSON 
{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campos
sectionType

enum (SectionType)

O tipo de seção a ser inserida.

Campo de união insertion_location. O local onde o intervalo será inserido. insertion_location pode ser apenas uma das seguintes opções:
location

object (Location)

Insere uma nova linha e uma quebra de seção em um índice específico no documento.

A quebra de seção precisa ser inserida dentro dos limites de um Paragraph existente. Por exemplo, ela não pode ser inserida no índice inicial de uma tabela (ou seja, entre a tabela e seu parágrafo anterior).

As quebras de seção não podem ser inseridas em uma tabela, equação, nota de rodapé, cabeçalho ou rodapé. Como as quebras de seção só podem ser inseridas no corpo, o campo segment ID precisa estar vazio.

endOfSegmentLocation

object (EndOfSegmentLocation)

Insere uma nova linha e uma quebra de seção no final do corpo do documento.

As quebras de seção não podem ser inseridas em uma nota de rodapé, cabeçalho ou rodapé. Como as quebras de seção só podem ser inseridas no corpo, o campo segment ID precisa estar vazio.

DeleteHeaderRequest

Exclui um Header do documento.

Representação JSON 
{
  "headerId": string
}
Campos
headerId

string

O ID do cabeçalho a ser excluído. Se esse cabeçalho for definido em DocumentStyle, a referência a ele será removida, resultando em nenhum cabeçalho desse tipo para a primeira seção do documento. Se esse cabeçalho for definido em um SectionStyle, a referência a ele será removida, e o cabeçalho desse tipo será continuado da seção anterior.

Solicitação de exclusão de rodapé

Exclui um Footer do documento.

Representação JSON 
{
  "footerId": string
}
Campos
footerId

string

O ID do rodapé a ser excluído. Se esse rodapé estiver definido em DocumentStyle, a referência a ele será removida, resultando em nenhum rodapé desse tipo para a primeira seção do documento. Se esse rodapé estiver definido em um SectionStyle, a referência a ele será removida e o rodapé desse tipo continuará da seção anterior.

PinTableHeaderRowsRequest

Atualiza o número de linhas de cabeçalho de tabela fixada em uma tabela.

Representação JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Campos
tableStartLocation

object (Location)

O local em que a tabela começa no documento.

pinnedHeaderRowsCount

integer

O número de linhas da tabela a serem fixadas, em que 0 indica que todas as linhas estão desafixadas.