Solicitação
Uma única atualização para aplicar 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 ocorrê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 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. |
ReplaceAllTextRequest
Substitui todas as ocorrências de texto que correspondem a um critério por
replace text
:
Representação JSON |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
Campos | |
---|---|
replaceText
|
O texto que substituirá o texto correspondente. |
tabsCriteria
|
Opcional. Os critérios usados para especificar em quais guias a substituição ocorre. Quando omitido, a substituição se aplica a todas as guias. Em um documento com uma única guia:
Em um documento com várias guias:
|
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 essa substring. |
SubstringMatchCriteria
Um critério que corresponde a uma string específica de texto 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 a capitalização:
|
TabsCriteria
Um critério que especifica em quais guias uma solicitação é executada.
Representação JSON |
---|
{ "tabIds": [ string ] } |
Campos | |
---|---|
tabIds[]
|
A lista de IDs de guia em que a solicitação é executada. |
InsertTextRequest
Insere texto no local especificado.
Representação JSON |
---|
{ "text": string, // Union field |
Campos | |
---|---|
text
|
O texto a ser inserido.
Inserir um caractere de nova linha criará implicitamente um novo
Os estilos do texto inserido serão determinados automaticamente, geralmente preservando o estilo do texto vizinho. Na maioria dos casos, o estilo do texto inserido corresponderá ao texto imediatamente anterior ao índice de inserção. Alguns caracteres de controle (U+0000-U+0008, U+000C-U+001F) e caracteres da Área de uso particular de 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 no corpo do documento. |
Local
Um local específico no documento.
Representação JSON |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
Campos | |
---|---|
segmentId
|
O ID do cabeçalho, rodapé ou nota de rodapé em que o local está. Um ID de segmento vazio significa 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
|
tabId
|
A guia em que o local está. Quando omitida, a solicitação é aplicada à primeira guia. Em um documento com uma única guia:
Em um documento com várias guias:
|
EndOfSegmentLocation
Local no final do corpo, cabeçalho, rodapé ou nota de rodapé. O local está imediatamente antes da última linha nova no segmento do documento.
Representação JSON |
---|
{ "segmentId": string, "tabId": string } |
Campos | |
---|---|
segmentId
|
O ID do cabeçalho, rodapé ou nota de rodapé em que o local está. Um ID de segmento vazio significa o corpo do documento. |
tabId
|
A guia em que o local está. Quando omitida, a solicitação é aplicada à primeira guia. Em um documento com uma única guia:
Em um documento com várias guias:
|
UpdateTextStyleRequest
Atualizar 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 do pai, esse estilo será definido como herdado.
Certas mudanças no estilo de texto podem causar outras alterações para refletir o comportamento do editor do Documentos. Consulte a documentação
|
fields
|
Os campos que precisam ser atualizados.
É necessário especificar pelo menos um campo. A raiz
Por exemplo, para atualizar o estilo de texto para negrito, defina
Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas deixe o campo sem definição. |
Campo de união
insertion_location : O tipo de intervalo usado em que o estilo do texto será atualizado.
insertion_location
pode ser apenas uma das seguintes opções:
|
|
range
|
O intervalo do texto a ser estilizado. O intervalo pode ser estendido para incluir novas linhas adjacentes. Se o intervalo contiver totalmente um parágrafo pertencente a uma lista, o marcador do parágrafo também será atualizado com o estilo de texto correspondente. Não é possível inserir os intervalos em uma UpdateTextStyleRequest relativa. |
CreateParagraphBulletsRequest
Cria marcadores para todos os parágrafos que se sobrepõem ao intervalo especificado.
O nível de aninhamento de cada parágrafo será determinado pela contagem das guias à frente de cada parágrafo. Para evitar excesso de espaço entre o marcador e o parágrafo correspondente, essas guias são removidas pela solicitação. Isso pode alterar os índices de partes do texto.
Se o parágrafo imediatamente anterior à atualização estiver em uma lista com uma predefinição correspondente, os parágrafos que estão sendo atualizados serão adicionados à lista anterior.
Representação JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
O intervalo em que a predefinição de marcador será aplicada. |
bulletPreset
|
Os tipos de marcadores a serem usados. |
BulletGlyphPreset
Padrões predefinidos de símbolos de marcadores 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 vazio, correspondente a um ponto de código Unicode U+274f -
CIRCLE
: um círculo vazio correspondente a um ponto de código Unicode U+25cb -
DIAMOND
: um losango sólido correspondente a um ponto de código Unicode U+25c6 -
DIAMONDX
: um losango com um 'x', correspondente a um ponto de código Unicode U+2756 -
HOLLOWDIAMOND
: um losango vazio, correspondente a um ponto de código Unicode U+25c7 -
DISC
: um círculo sólido que corresponde 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 apenas um dígito são prefixados com zero, como "01", "02" ou "03". Números com mais de um dígito não têm o prefixo zero. -
ROMAN
: um algarismo romano em letra minúscula, como "i", "ii" ou "iii". -
UPPERROMAN
: um numeral romano maiúsculo, 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 glifo de marcador não foi especificada. |
BULLET_DISC_CIRCLE_SQUARE
|
Uma lista com marcadores
DISC ,
CIRCLE
e
SQUARE
símbolo de marcador para os três primeiros níveis de aninhamento da lista.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
Uma lista com marcadores
DIAMONDX ,
ARROW3D
e
SQUARE
símbolo de marcador para os três primeiros níveis de aninhamento da lista.
|
BULLET_CHECKBOX
|
Uma lista com marcadores
CHECKBOX
marcadores de marcadores para todos os níveis de aninhamento de lista.
|
BULLET_ARROW_DIAMOND_DISC
|
Uma lista com marcadores
ARROW ,
DIAMOND
e
DISC
símbolo de marcador para os três primeiros níveis de aninhamento da lista.
|
BULLET_STAR_CIRCLE_SQUARE
|
Uma lista com marcadores
STAR ,
CIRCLE
e
SQUARE
símbolo de marcador para os três primeiros níveis de aninhamento da lista.
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
Uma lista com marcadores
ARROW3D ,
CIRCLE
e
SQUARE
símbolo de marcador para os três primeiros níveis de aninhamento da lista.
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
Uma lista com marcadores
LEFTTRIANGLE ,
DIAMOND
e
DISC
símbolo de marcador para os três primeiros níveis de aninhamento da lista.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
Uma lista com marcadores
DIAMONDX ,
HOLLOWDIAMOND
e
SQUARE
símbolo de marcador para os três primeiros níveis de aninhamento da lista.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
Uma lista com marcadores
DIAMOND ,
CIRCLE
e
SQUARE
símbolo de marcador para os três primeiros níveis de aninhamento da lista.
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
Uma lista numerada com
DECIMAL ,
ALPHA
e
ROMAN
glifos numéricos para os primeiros três níveis de aninhamento de lista, seguidos por pontos.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
Uma lista numerada com
DECIMAL ,
ALPHA
e
ROMAN
glifos numéricos para os primeiros três níveis de aninhamento da lista, seguidos por parênteses.
|
NUMBERED_DECIMAL_NESTED
|
Uma lista numerada com
DECIMAL
glifos numéricos separados por pontos, em que cada nível de aninhamento usa o glifo do nível de aninhamento anterior como prefixo. Por exemplo: "1.", "1.1.", "2.", "2.2.".
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
Uma lista numerada com
UPPERALPHA ,
ALPHA
e
ROMAN
glifos numéricos para os primeiros três níveis de aninhamento de lista, seguidos por pontos.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL
|
Uma lista numerada com
UPPERROMAN ,
UPPERALPHA
e
DECIMAL
glifos numéricos para os primeiros três níveis de aninhamento de lista, seguidos por pontos.
|
NUMBERED_ZERODECIMAL_ALPHA_ROMAN
|
Uma lista numerada com
ZERODECIMAL ,
ALPHA
e
ROMAN
glifos numéricos para os primeiros três níveis de aninhamento de lista, seguidos por pontos.
|
DeleteParagraphBulletsRequest
Exclui os marcadores de todos os parágrafos que se sobrepõem ao intervalo especificado.
O nível de aninhamento de cada parágrafo será visualmente preservado com a adição de 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 fazem 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 aplicar o nome. |
DeleteNamedRangeRequest
Exclui um
NamedRange
:
Representação JSON |
---|
{ "tabsCriteria": { object ( |
Campos | |
---|---|
tabsCriteria
|
Opcional. Os critérios usados para especificar em quais guias a exclusão do intervalo deve ocorrer. Quando omitida, a exclusão do intervalo será aplicada a todas as guias. Em um documento com uma única guia:
Em um documento com várias guias:
|
Campo de união
named_range_reference : O valor que determina os intervalos a serem excluídos. 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. |
UpdateParagraphStyleRequest
Atualizar o estilo de todos os parágrafos que se sobrepõem ao intervalo especificado.
Representação JSON |
---|
{ "paragraphStyle": { object ( |
Campos | |
---|---|
paragraphStyle
|
Os estilos a serem definidos nos parágrafos.
Certas mudanças no estilo de parágrafo podem causar outras alterações para refletir o comportamento do Editor do Documentos. Consulte a documentação
|
fields
|
Os campos que precisam ser atualizados.
É necessário especificar pelo menos um campo. 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 deixe o campo sem definição. |
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 para definir o estilo. |
DeleteContentRangeRequest
Exclui o conteúdo do documento.
Representação JSON |
---|
{
"range": {
object (
|
Campos | |
---|---|
range
|
O intervalo de conteúdo a ser excluído. Excluir texto que ultrapasse um limite de parágrafo pode resultar em alterações em estilos de parágrafo, listas, objetos posicionados e favoritos à 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 de solicitação 400 inválida será retornado. Alguns exemplos de solicitações de exclusão inválidas incluem:
|
InsertInlineImageRequest
Insere um
InlineObject
que contém uma imagem em um determinado local.
Representação JSON |
---|
{ "uri": string, "objectSize": { object ( |
Campos | |
---|---|
uri
|
URI da imagem. A imagem é buscada uma vez no momento da inserção, e uma cópia é armazenada para exibição no documento. As imagens precisam ter menos de 50 MB, não podem exceder 25 megapixels e estar no formato PNG, JPEG ou GIF.
O URI fornecido precisa estar acessível publicamente e ter no máximo 2 KB de comprimento. O URI em si é salvo com a imagem e exposto por meio da
|
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 na resolução. * Se uma dimensão for especificada, a outra vai 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 a proporção. |
Campo de união
insertion_location : O local onde 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 dentro de uma nota de rodapé ou equação. |
endOfSegmentLocation
|
Insere o texto no final de um cabeçalho, rodapé ou no corpo do documento. Não é possível inserir imagens inline dentro de 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 onde 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 inicial da tabela estará no índice do local especificado + 1.
A tabela precisa ser inserida dentro dos limites de uma
Não é possível inserir tabelas dentro de uma nota de rodapé ou equação. |
endOfSegmentLocation
|
Insere a tabela no final do cabeçalho, rodapé ou corpo do documento especificado. Um caractere de nova linha será inserido antes da tabela inserida. Não é possível inserir tabelas dentro de 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 em que as linhas serão inseridas. Uma nova linha será inserida acima (ou abaixo) da linha onde 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 será inserida abaixo do local da célula de referência.
|
TableCellLocation
Localização 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 linha igual a 1. |
columnIndex
|
O índice de colunas baseado em zero. Por exemplo, a segunda coluna da tabela tem um índice de coluna igual a 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 em que as colunas serão inseridas. Uma nova coluna será inserida à esquerda (ou direita) da coluna onde está a célula de referência. 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 a nova coluna 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 da qual 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 da qual a coluna será excluída. A coluna que esta célula abrange 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 por 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 no documento.
A quebra de página precisa ser inserida dentro dos limites de um
Não é possível inserir quebras de página em uma tabela, equação, nota de rodapé, cabeçalho ou rodapé. Como as quebras de página só podem ser inseridas no corpo, o
|
endOfSegmentLocation
|
Insere a quebra de página no final do corpo do documento.
Não é possível inserir quebras de página dentro de uma nota de rodapé, cabeçalho ou rodapé. Como as quebras de página só podem ser inseridas no corpo, o
|
DeletePositionedObjectRequest
Exclui um
PositionedObject
do documento.
Representação JSON |
---|
{ "objectId": string, "tabId": string } |
Campos | |
---|---|
objectId
|
O ID do objeto posicionado a ser excluído. |
tabId
|
A guia em que o objeto posicionado a ser excluído está. Quando omitida, a solicitação é aplicada à primeira guia. Em um documento com uma única guia:
Em um documento com várias guias:
|
UpdateTableColumnPropertiesRequest
Atualiza o
TableColumnProperties
de 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 baseados em zero cuja propriedade precisa 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.
É necessário especificar pelo menos um campo. A raiz
Por exemplo, para atualizar a largura da coluna, defina
|
UpdateTableCellStyleRequest
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 compartilhar uma borda com uma célula adjacente, a propriedade de borda correspondente da célula adjacente também será 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.
É necessário especificar pelo menos um campo. A raiz
Por exemplo, para atualizar a cor de fundo das células da tabela, defina
Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas deixe o campo sem definição. |
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 ao 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 da tabela. |
TableRange
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 necessariamente formam um retângulo. Por exemplo, digamos que temos uma tabela 3 x 3 em que todas as células da última linha estão mescladas. A tabela tem esta aparência:
[ ][ ][ ]
[ ][ ][ ]
[ ]
Um intervalo da tabela com localização da célula da tabela = (tableStartLocation, linha = 0, coluna = 0), período da linha = 3 e período da coluna = 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
|
A extensão da linha do intervalo da tabela. |
columnSpan
|
A extensão de colunas do intervalo da tabela. |
UpdateTableRowStyleRequest
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 linhas 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.
É necessário especificar pelo menos um campo. A raiz
Por exemplo, para atualizar a altura mínima da linha, defina
|
ReplaceImageRequest
Substitui uma imagem existente por uma nova.
A substituição de uma imagem remove algumas
image effects
da imagem existente para espelhar o comportamento do editor do Documentos Google.
Representação JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
Campos | |
---|---|
imageObjectId
|
O ID da imagem que será substituída. O ID pode ser recuperado com a resposta de uma solicitação GET. |
uri
|
URI da nova imagem. A imagem é buscada uma vez no momento da inserção, e uma cópia é armazenada para exibição no 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 da
|
imageReplaceMethod
|
O método de substituição. |
tabId
|
A guia na qual está a imagem a ser substituída. Quando omitida, a solicitação é aplicada à primeira guia. Em um documento com uma única guia:
Em um documento com várias guias:
|
ImageReplaceMethod
Método de substituição de imagem.
Enums | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
Método de substituição de imagem não especificado. Não use esse valor. |
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á o mesmo da imagem original. |
UpdateDocumentStyleRequest
Atualiza o
DocumentStyle
:
Representação JSON |
---|
{
"documentStyle": {
object (
|
Campos | |
---|---|
documentStyle
|
Os estilos a serem definidos no documento.
Algumas mudanças no estilo de um documento podem causar outras mudanças de modo a refletir o comportamento do editor do Documentos. Consulte a documentação
|
fields
|
Os campos que precisam ser atualizados.
É necessário especificar pelo menos um campo. A raiz
Por exemplo, para atualizar o plano de fundo, defina
|
tabId
|
A guia que contém o estilo a ser atualizado. Quando omitida, a solicitação se aplica à primeira guia. Em um documento com uma única guia:
Em um documento com várias guias:
|
MergeTableCellsRequest
Mescla células em uma
Table
:
Representação JSON |
---|
{
"tableRange": {
object (
|
Campos | |
---|---|
tableRange
|
O intervalo da tabela que especifica quais células dela serão mescladas. Qualquer texto nas células que estão sendo mescladas será concatenado e armazenado no "head" célula do intervalo. Esta é a célula superior esquerda do intervalo quando a direção do conteúdo é da esquerda para a direita e 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 cobre células que já estão mescladas ou onde a tabela é não retangular), um erro de solicitação 400 inválida será retornado. |
UnmergeTableCellsRequest
Cancela a mesclagem de células em uma
Table
:
Representação JSON |
---|
{
"tableRange": {
object (
|
Campos | |
---|---|
tableRange
|
O intervalo da tabela que especifica quais células da tabela devem ser mescladas. A mesclagem de todas as células mescladas neste intervalo será cancelada. Além disso, as células já 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, ele permanecerá no "cabeçalho" célula do bloco resultante de células não mesclados. A "cabeça" célula é a célula superior esquerda quando a direção do conteúdo é da esquerda para a direita e, caso contrário, a célula superior direita. |
CreateHeaderRequest
Cria um
Header
: O novo cabeçalho é aplicado
SectionStyle
no local do
SectionBreak
se especificado, caso contrário, é aplicado ao
DocumentStyle
Se um cabeçalho do tipo especificado já existir, será retornado um erro de solicitação 400 inválida.
Representação JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type
|
O tipo de cabeçalho a ser criado. |
sectionBreakLocation
|
A localização do
|
CreateFootnoteRequest
Cria um
Footnote
segmento e insere uma nova
FootnoteReference
no local determinado.
A nova
Footnote
contém 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 onde a referência da nota de rodapé será inserida.
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 no documento.
A referência à nota de rodapé precisa ser inserida dentro dos limites de uma
As referências de nota de rodapé não podem ser inseridas dentro de uma equação, cabeçalho, rodapé ou nota de rodapé. Como as referências da nota de rodapé só podem ser inseridas no corpo, o
|
endOfSegmentLocation
|
Insere a referência da nota de rodapé no final do corpo do documento.
Não é possível inserir referências de rodapé dentro de um cabeçalho, rodapé ou nota de rodapé. Como as referências da nota de rodapé só podem ser inseridas no corpo, o
|
ReplaceNamedRangeContentRequest
Substitui o conteúdo do
NamedRange
ou
NamedRanges
com o conteúdo de substituição fornecido.
Uma pessoa
NamedRange
podem consistir em múltiplos conjuntos de dados
ranges
. 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 qualquer intervalo resultaria em uma estrutura de documento inválida, um erro de solicitação 400 inválida será retornado.
Representação JSON |
---|
{ "tabsCriteria": { object ( |
Campos | |
---|---|
tabsCriteria
|
Opcional. Os critérios usados para especificar em quais guias a substituição ocorre. Quando omitido, a substituição se aplica a todas as guias. Em um documento com uma única guia:
Em um documento com várias guias:
|
Campo de união
replacement_content : O conteúdo que substituirá o conteúdo 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, o erro 400 de solicitação inválida será retornado. |
namedRangeName
|
O nome
Se houver vários
|
UpdateSectionStyleRequest
Atualiza o
SectionStyle
:
Representação JSON |
---|
{ "range": { object ( |
Campos | |
---|---|
range
|
O intervalo sobrepondo as seções ao estilo.
Como as quebras de seção só podem ser inseridas no corpo, o
|
sectionStyle
|
Os estilos a serem definidos na seção.
Certas alterações de estilo de seção podem causar outras alterações para refletir o comportamento do editor do Documentos Google. Consulte a documentação
|
fields
|
Os campos que precisam ser atualizados.
É necessário especificar pelo menos um campo. 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 a quebra será inserida.
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
Não é possível inserir quebras de seção em uma tabela, equação, nota de rodapé, cabeçalho ou rodapé. Como as quebras de seção só podem ser inseridas no corpo, a
|
endOfSegmentLocation
|
Insere uma nova linha e uma quebra de seção no final do corpo do documento.
Não é possível inserir quebras de seção dentro de uma nota de rodapé, cabeçalho ou rodapé. Como as quebras de seção só podem ser inseridas no corpo, o
|
DeleteHeaderRequest
Exclui um
Header
do documento.
Representação JSON |
---|
{ "headerId": string, "tabId": string } |
Campos | |
---|---|
headerId
|
O ID do cabeçalho a ser excluído. Se esse cabeçalho for definido
|
tabId
|
A guia contendo o cabeçalho a ser excluído. Quando omitida, a solicitação é aplicada à primeira guia. Em um documento com uma única guia:
Em um documento com várias guias:
|
PinTableHeaderRowsRequest
Atualiza o número de linhas de cabeçalho fixadas 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 que serão fixadas. 0 indica que todas as linhas estão liberadas. |