Solicitação
Uma única atualização a ser aplicada a um documento.
Representação JSON |
---|
{ // Union field |
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
|
Substitui todas as instâncias do texto especificado. |
insertText
|
Insere texto no local especificado. |
updateTextStyle
|
Atualiza o estilo de texto no intervalo especificado. |
createParagraphBullets
|
Cria marcadores para parágrafos. |
deleteParagraphBullets
|
Exclui marcadores de parágrafos. |
createNamedRange
|
Cria um intervalo nomeado. |
deleteNamedRange
|
Exclui um intervalo nomeado. |
updateParagraphStyle
|
Atualiza o estilo de parágrafo no intervalo especificado. |
deleteContentRange
|
Exclui o conteúdo do documento. |
insertInlineImage
|
Insere uma imagem inline no local especificado. |
insertTable
|
Insere uma tabela no local especificado. |
insertTableRow
|
Insere uma linha vazia em uma tabela. |
insertTableColumn
|
Insere uma coluna vazia em uma tabela. |
deleteTableRow
|
Exclui uma linha de uma tabela. |
deleteTableColumn
|
Exclui uma coluna de uma tabela. |
insertPageBreak
|
Insere uma quebra de página no local especificado. |
deletePositionedObject
|
Exclui um objeto posicionado do documento. |
updateTableColumnProperties
|
Atualiza as propriedades das colunas em uma tabela. |
updateTableCellStyle
|
Atualiza o estilo das células da tabela. |
updateTableRowStyle
|
Atualiza o estilo da linha em uma tabela. |
replaceImage
|
Substitui uma imagem no documento. |
updateDocumentStyle
|
Atualiza o estilo do documento. |
mergeTableCells
|
Mescla as células em uma tabela. |
unmergeTableCells
|
Cancela a mesclagem de células em uma tabela. |
createHeader
|
Cria um cabeçalho. |
createFooter
|
Cria um rodapé. |
createFootnote
|
Cria uma nota de rodapé. |
replaceNamedRangeContent
|
Substitui o conteúdo em um intervalo nomeado. |
updateSectionStyle
|
Atualiza o estilo de seção do intervalo especificado. |
insertSectionBreak
|
Insere uma quebra de seção no local especificado. |
deleteHeader
|
Exclui um cabeçalho do documento. |
deleteFooter
|
Exclui um rodapé do documento. |
pinTableHeaderRows
|
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 |
Campos | |
---|---|
replaceText
|
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
|
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
|
O texto a ser pesquisado no documento. |
matchCase
|
Indica se a pesquisa deve respeitar o caso:
|
InsertTextRequest
Insere texto no local especificado.
Representação JSON |
---|
{ "text": string, // Union field |
Campos | |
---|---|
text
|
O texto a ser inserido.
A inserção de um caractere de nova linha cria implicitamente um novo 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
|
Insere o texto em um índice específico no documento.
O texto precisa ser inserido dentro dos limites de um |
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
|
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
|
O índice baseado em zero, em unidades de código UTF-16.
O índice é relativo ao início do segmento especificado por |
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
|
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 ( |
Campos | |
---|---|
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 |
fields
|
Os campos que precisam ser atualizados.
Pelo menos um campo precisa ser especificado. A raiz
Por exemplo, para atualizar o estilo do texto para negrito, defina 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
|
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 ( |
Campos | |
---|---|
range
|
O intervalo ao qual a predefinição de marcador é aplicada. |
bulletPreset
|
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 (
|
Campos | |
---|---|
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 (
|
Campos | |
---|---|
name
|
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
|
O intervalo ao qual o nome será aplicado. |
DeleteNamedRangeRequest
Exclui um NamedRange
.
Representação JSON |
---|
{ // Union field |
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
|
O ID do intervalo nomeado a ser excluído. |
name
|
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 ( |
Campos | |
---|---|
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 |
fields
|
Os campos que precisam ser atualizados.
Pelo menos um campo precisa ser especificado. A raiz
Por exemplo, para atualizar a propriedade de alinhamento do estilo de parágrafo, defina 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
|
O intervalo que se sobrepõe aos parágrafos a serem estilizados. |
DeleteContentRangeRequest
Exclui o conteúdo do documento.
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
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 ( |
Campos | |
---|---|
uri
|
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 |
objectSize
|
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
|
Insere a imagem em um índice específico no documento.
A imagem precisa ser inserida dentro dos limites de um Não é possível inserir imagens inline em uma nota de rodapé ou equação. |
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 |
Campos | |
---|---|
rows
|
O número de linhas na tabela. |
columns
|
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
|
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 Não é possível inserir tabelas em uma nota de rodapé ou em uma equação. |
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 (
|
Campos | |
---|---|
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
|
Define se uma nova linha deve ser inserida abaixo do local da célula de referência.
|
TableCellLocation
Local de uma única célula em uma tabela.
Representação JSON |
---|
{
"tableStartLocation": {
object (
|
Campos | |
---|---|
tableStartLocation
|
O local em que a tabela começa no documento. |
rowIndex
|
O índice de linhas com base em zero. Por exemplo, a segunda linha da tabela tem um índice de 1. |
columnIndex
|
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 (
|
Campos | |
---|---|
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
|
Define se uma nova coluna deve ser inserida à direita do local da célula de referência.
|
DeleteTableRowRequest
Exclui uma linha de uma tabela.
Representação JSON |
---|
{
"tableCellLocation": {
object (
|
Campos | |
---|---|
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 (
|
Campos | |
---|---|
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 |
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
|
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
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 |
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 |
DeletePositionedObjectRequest
Exclui um PositionedObject
do documento.
Representação JSON |
---|
{ "objectId": string } |
Campos | |
---|---|
objectId
|
O ID do objeto posicionado a ser excluído. |
Atualizar TableColumnPropertiesRequest
Atualiza o TableColumnProperties
das colunas em uma tabela.
Representação JSON |
---|
{ "tableStartLocation": { object ( |
Campos | |
---|---|
tableStartLocation
|
O local em que a tabela começa no documento. |
columnIndices[]
|
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
|
As propriedades da coluna da tabela a serem atualizadas.
Se o valor de |
fields
|
Os campos que precisam ser atualizados.
Pelo menos um campo precisa ser especificado. A raiz
Por exemplo, para atualizar a largura da coluna, defina |
Atualizar TableCellStyleRequest
Atualiza o estilo de um intervalo de células da tabela.
Representação JSON |
---|
{ "tableCellStyle": { object ( |
Campos | |
---|---|
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:
|
fields
|
Os campos que precisam ser atualizados.
Pelo menos um campo precisa ser especificado. A raiz
Por exemplo, para atualizar a cor do plano de fundo da célula da tabela, defina 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
|
O intervalo da tabela que representa o subconjunto da tabela à qual as atualizações são aplicadas. |
tableStartLocation
|
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 (
|
Campos | |
---|---|
tableCellLocation
|
O local da célula onde o intervalo da tabela começa. |
rowSpan
|
O período da linha do intervalo da tabela. |
columnSpan
|
O período da coluna do intervalo da tabela. |
Atualizar TableRowStyleRequest
Atualiza o TableRowStyle
de linhas em uma tabela.
Representação JSON |
---|
{ "tableStartLocation": { object ( |
Campos | |
---|---|
tableStartLocation
|
O local em que a tabela começa no documento. |
rowIndices[]
|
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
|
Os estilos a serem definidos nas linhas. |
fields
|
Os campos que precisam ser atualizados.
Pelo menos um campo precisa ser especificado. A raiz
Por exemplo, para atualizar a altura mínima da linha, defina |
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 (
|
Campos | |
---|---|
imageObjectId
|
O ID da imagem existente que será substituída. O ID pode ser recuperado a partir da resposta de uma solicitação get. |
uri
|
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 |
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 (
|
Campos | |
---|---|
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 |
fields
|
Os campos que precisam ser atualizados.
Pelo menos um campo precisa ser especificado. A raiz
Por exemplo, para atualizar o plano de fundo, defina |
MesclarTableCellsRequest
Mescla as células em um Table
.
Representação JSON |
---|
{
"tableRange": {
object (
|
Campos | |
---|---|
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 (
|
Campos | |
---|---|
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 ( |
Campos | |
---|---|
type
|
O tipo de cabeçalho a ser criado. |
sectionBreakLocation
|
O local do |
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 |
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
|
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
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 |
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 |
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 |
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
|
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
|
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
|
O nome do
Se houver vários |
Atualização da seção de estilo da solicitação
Atualiza o SectionStyle
.
Representação JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
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 |
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 |
fields
|
Os campos que precisam ser atualizados.
Pelo menos um campo precisa ser especificado. A raiz
Por exemplo, para atualizar a margem esquerda, defina |
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 ( |
Campos | |
---|---|
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
|
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
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 |
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 |
DeleteHeaderRequest
Exclui um Header
do documento.
Representação JSON |
---|
{ "headerId": string } |
Campos | |
---|---|
headerId
|
O ID do cabeçalho a ser excluído. Se esse cabeçalho for definido em |
PinTableHeaderRowsRequest
Atualiza o número de linhas de cabeçalho de tabela fixada em uma tabela.
Representação JSON |
---|
{
"tableStartLocation": {
object (
|
Campos | |
---|---|
tableStartLocation
|
O local em que a tabela começa no documento. |
pinnedHeaderRowsCount
|
O número de linhas da tabela a serem fixadas, em que 0 indica que todas as linhas estão desafixadas. |