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 de um dos tipos a seguir:
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 do 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 células em uma tabela.

unmergeTableCells

object (UnmergeTableCellsRequest)

Desfaz 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 da 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.

ReplaceAllTextRequest

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

Representação JSON 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // 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.

tabsCriteria

object (TabsCriteria)

Opcional. Os critérios usados para especificar em quais guias a substituição ocorre.

Se omitido, a substituição é aplicada a todas as guias.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a substituição será aplicada à guia única.

Em um documento com várias guias:

  • Se fornecido, a substituição será aplicada às guias especificadas.

  • Se omitido, a substituição será aplicada a todas as guias.

Campo de união criteria. Os critérios usados para corresponder ao texto a ser substituído. criteria pode ser apenas um dos seguintes:
containsText

object (SubstringMatchCriteria)

Encontra texto no documento que corresponde a essa 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 diferenciar maiúsculas e minúsculas:

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

TabsCriteria

Um critério que especifica em quais guias uma solicitação é executada.

Representação JSON 
{
  "tabIds": [
    string
  ]
}
Campos
tabIds[]

string

A lista de IDs de guias em que a solicitação é executada.

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.

Inserir um caractere de fim de 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 inseridos são determinados automaticamente, geralmente preservando o estilo do texto vizinho. 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 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 um dos seguintes:
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 (ou seja, entre a tabela e o parágrafo anterior). 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,
  "tabId": string
}
Campos
segmentId

string

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

integer

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

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

tabId

string

A guia em que o local está. Se omitido, o pedido é aplicado à primeira guia.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a solicitação se aplica à guia única.

Em um documento com várias guias:

  • Se fornecido, a solicitação se aplica à guia especificada.

  • Se omitido, a solicitação se aplica à primeira guia do documento.

EndOfSegmentLocation

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

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

string

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

string

A guia em que o local está. Se omitido, o pedido é aplicado à primeira guia.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a solicitação se aplica à guia única.

Em um documento com várias guias:

  • Se fornecido, a solicitação se aplica à guia especificada.

  • Se omitido, a solicitação se aplica à primeira guia do documento.

UpdateTextStyleRequest

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 do pai, esse estilo será definido como herdado.

Algumas mudanças no estilo de texto podem causar outras para refletir o comportamento do editor de documentos. Consulte a documentação de TextStyle para mais informações.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. A raiz textStyle está implícita e não precisa ser especificada. Um único "*" pode ser usado como atalho para listar todos os campos.

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

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

Campo de união insertion_location. O tipo de intervalo usado em que o estilo de texto será atualizado. insertion_location pode ser apenas de um dos tipos a seguir:
range

object (Range)

O intervalo do texto a ser estilizado.

O intervalo pode ser estendido para incluir novas linhas adjacentes.

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

Os intervalos não podem ser inseridos em um UpdateTextStyleRequest relativo.

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 espaço excessivo entre o marcador de posição e o parágrafo correspondente, essas guias iniciais são removidas por essa solicitação. Isso pode mudar os índices de partes do texto.

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

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

object (Range)

O intervalo em que a predefinição de marcador será aplicada.

bulletPreset

enum (BulletGlyphPreset)

Os tipos de glifos de marcador a serem usados.

BulletGlyphPreset

Padrões predefinidos de glifos 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 oco, 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, 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 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 um zero no prefixo.
  • ROMAN : um numeral romano minúsculo, 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 para os três primeiros níveis de aninhamento da lista.
BULLET_DIAMONDX_ARROW3D_SQUARE Uma lista com marcadores DIAMONDX, ARROW3D e SQUARE para os três primeiros níveis de aninhamento da lista.
BULLET_CHECKBOX Uma lista com marcadores com CHECKBOX glifos de marcadores para todos os níveis de aninhamento da lista.
BULLET_ARROW_DIAMOND_DISC Uma lista com marcadores ARROW, DIAMOND e DISC para os três primeiros níveis de aninhamento da lista.
BULLET_STAR_CIRCLE_SQUARE Uma lista com marcadores STAR, CIRCLE e SQUARE para os três primeiros níveis de aninhamento da lista.
BULLET_ARROW3D_CIRCLE_SQUARE Uma lista com marcadores ARROW3D, CIRCLE e SQUARE para os três primeiros níveis de aninhamento da lista.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Uma lista com marcadores com um símbolo de marcador LEFTTRIANGLE, DIAMOND e DISC para os três primeiros níveis de aninhamento da lista.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Uma lista com marcadores DIAMONDX, HOLLOWDIAMOND e SQUARE para os três primeiros níveis de aninhamento da lista.
BULLET_DIAMOND_CIRCLE_SQUARE Uma lista com marcadores DIAMOND, CIRCLE e SQUARE para os três primeiros níveis de aninhamento da 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 de listas, 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 DECIMAL glifos numéricos separados por pontos, em que cada nível de aninhamento usa o glifo do nível anterior como um 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 de listas, 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 de listas, 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 (Range)
  }
}
Campos
range

object (Range)

O intervalo de onde as balas serão excluídas.

CreateNamedRangeRequest

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

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

string

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

Os nomes precisam ter pelo menos 1 caractere e não mais de 256 caracteres, medidos em unidades de código UTF-16.

range

object (Range)

O intervalo em que o nome será aplicado.

DeleteNamedRangeRequest

Exclui um NamedRange.

Representação JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // 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
tabsCriteria

object (TabsCriteria)

Opcional. Os critérios usados para especificar em quais guias a exclusão do intervalo deve ocorrer. Se omitido, a exclusão de intervalo é aplicada a todas as guias.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia no singular.

  • Se omitido, a exclusão do intervalo se aplica à guia única.

Em um documento com várias guias:

  • Se fornecido, a exclusão de intervalo será aplicada às guias especificadas.

  • Se não for fornecido, a exclusão de intervalo será aplicada a todas as guias.

Campo de união named_range_reference. O valor que determina os intervalos a serem excluídos. É necessário definir exatamente um. named_range_reference pode ser apenas um dos seguintes:
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 especificado serão excluídos.

UpdateParagraphStyleRequest

Atualiza 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 mudanças no estilo do parágrafo podem causar outras para refletir o comportamento do editor de documentos. Consulte a documentação de ParagraphStyle para mais informações.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. A raiz paragraphStyle está implícita e não precisa ser especificada. Um único "*" pode ser usado como atalho para 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 de campo, mas deixe o campo indefinido.

Campo de união insertion_location. O tipo de intervalo usado em que o estilo do parágrafo será atualizado. insertion_location pode ser apenas de um dos tipos a seguir:
range

object (Range)

O intervalo que se sobrepõe aos parágrafos para estilizar.

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 ultrapassa o limite de um parágrafo pode resultar em mudanças nos estilos de parágrafo, listas, objetos posicionados e marcadores, já que os dois parágrafos são mesclados.

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

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

InsertInlineImageRequest

Insere um InlineObject contendo uma imagem no local especificado.

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 no documento. As imagens precisam ter menos de 50 MB, não podem exceder 25 megapixels e precisam estar em um dos formatos PNG, JPEG ou GIF.

O URI fornecido precisa ser acessível publicamente e ter no máximo 2 kB. O URI é salvo com a imagem e exposto pelo campo ImageProperties.content_uri.

objectSize

object (Size)

O tamanho que a imagem deve ter no documento. Essa propriedade é opcional, e o tamanho final da imagem no documento é determinado pelas seguintes regras: * Se nem a largura nem a altura forem especificadas, um tamanho padrão da imagem será calculado com base na resolução. * Se uma dimensão for especificada, a outra será calculada para preservar a proporção da imagem. * Se a largura e a altura forem especificadas, a imagem será redimensionada para caber nas dimensões fornecidas, mantendo a proporção.

Campo de união insertion_location. O local em que a imagem será inserida. insertion_location pode ser apenas um dos seguintes:
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, não é possível inseri-lo no índice inicial de uma tabela (ou seja, entre a tabela e o parágrafo anterior).

As imagens inline não podem ser inseridas 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 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 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 um dos seguintes:
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 será o índice de local especificado + 1.

A tabela precisa ser inserida dentro dos limites de um Paragraph existente. Por exemplo, não é possível inseri-lo no índice inicial de uma tabela (ou seja, entre uma tabela existente e o parágrafo anterior).

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

endOfSegmentLocation

object (EndOfSegmentLocation)

Insere a tabela no final do cabeçalho, rodapé ou corpo do documento. 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 em que 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 será inserida abaixo do local da célula de referência.

  • True : insere abaixo da célula.
  • False : insere 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 onde a tabela começa no documento.

rowIndex

integer

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

columnIndex

integer

O índice de colunas baseado em zero. Por exemplo, a segunda coluna na tabela tem um índice de coluna 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 em que 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 mesclada, uma nova coluna será inserida à esquerda (ou à direita) da célula mesclada.

insertRight

boolean

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

  • True : insira à direita.
  • False : insira à esquerda.

DeleteTableRowRequest

Exclui uma linha de uma tabela.

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

object (TableCellLocation)

A localização da célula da tabela de referência de onde a linha será excluída.

A linha que abrange essa célula 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 essa 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 da qual a coluna será excluída.

A coluna que abrange essa célula será excluída. Se for uma célula mesclada que abrange várias colunas, todas as colunas que a célula abrangerão serão excluídas. Se nenhuma coluna permanecer na tabela após essa 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 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 um dos seguintes:
location

object (Location)

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

O quebra de página precisa ser inserido dentro dos limites de um Paragraph existente. Por exemplo, não é possível inseri-lo no índice inicial de uma tabela (ou seja, entre a tabela e o parágrafo anterior).

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 campo segment ID precisa estar vazio.

endOfSegmentLocation

object (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 campo segment ID precisa estar vazio.

DeletePositionedObjectRequest

Exclui um PositionedObject do documento.

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

string

O ID do objeto posicionado a ser excluído.

tabId

string

A guia em que o objeto posicionado para exclusão está. Se omitido, o pedido é aplicado à primeira guia.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a solicitação se aplica à guia única.

Em um documento com várias guias:

  • Se fornecido, a solicitação se aplica à guia especificada.

  • Se omitido, a solicitação se aplica à primeira guia do documento.

UpdateTableColumnPropertiesRequest

Atualiza TableColumnProperties de 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 colunas com base em zero cuja propriedade precisa 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 400 de solicitação inválida será retornado.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. O tableColumnProperties raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como abreviação para listar todos os campos.

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

UpdateTableCellStyleRequest

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 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:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. O tableCellStyle raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para listar todos os campos.

Por exemplo, para atualizar a cor de fundo das células da tabela, defina fields como "backgroundColor".

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

Campo de união cells. As células que serão atualizadas. cells pode ser apenas um dos seguintes:
tableRange

object (TableRange)

O intervalo da tabela que representa o subconjunto da tabela em que 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 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 são mescladas. A tabela tem esta aparência: 

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

Um intervalo de tabelas com a localização da célula da tabela = (tableStartLocation, linha = 0, coluna = 0), o intervalo de linhas = 3 e o intervalo de colunas = 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)

A localização da célula em que o intervalo da tabela começa.

rowSpan

integer

A extensão da linha do intervalo da tabela.

columnSpan

integer

O intervalo de colunas do intervalo da tabela.

UpdateTableRowStyleRequest

Atualiza 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 linhas 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.

É necessário especificar pelo menos um campo. O tableRowStyle raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como abreviação para listar todos os campos.

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

ReplaceImageRequest

Substitui uma imagem por outra.

A substituição de uma imagem remove alguns image effects da imagem atual para refletir o comportamento do editor de documentos.

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

string

O ID da imagem que será substituída. O ID pode ser extraído da resposta de uma solicitação de busca.

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 no documento. As imagens precisam ter menos de 50 MB, não podem exceder 25 megapixels e precisam estar nos formatos PNG, JPEG ou GIF.

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

imageReplaceMethod

enum (ImageReplaceMethod)

O método de substituição.

tabId

string

A guia em que a imagem a ser substituída está. Se omitido, o pedido é aplicado à primeira guia.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a solicitação se aplica à guia única.

Em um documento com várias guias:

  • Se fornecido, a solicitação se aplica à guia especificada.

  • Se omitido, a solicitação se aplica à primeira guia do documento.

ImageReplaceMethod

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

Enums
IMAGE_REPLACE_METHOD_UNSPECIFIED Método de substituição de imagem não especificado. Esse valor não deve 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á o mesmo da imagem original.

UpdateDocumentStyleRequest

Atualiza o DocumentStyle.

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

object (DocumentStyle)

Os estilos a serem definidos no documento.

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

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. O documentStyle raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como abreviação para listar todos os campos.

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

tabId

string

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:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a solicitação se aplica à guia única.

Em um documento com várias guias:

  • Se fornecido, a solicitação se aplica à guia especificada.

  • Se não for fornecida, a solicitação se aplica à primeira guia do documento.

MergeTableCellsRequest

Mescla células em um Table.

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

object (TableRange)

O intervalo da tabela que especifica quais células da tabela serão mescladas.

Qualquer texto nas células mescladas será concatenado e armazenado na célula "cabeça" do intervalo. Essa é 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, caso contrário.

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

Desfaz a mesclagem de células em um Table.

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

object (TableRange)

O intervalo de tabela que especifica quais células da tabela serão desunidas.

Todas as células mescladas nesse intervalo serão separadas, e as que já estão separadas não serão afetadas. Se o intervalo não tiver células mescladas, a solicitação não vai fazer nada.

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

CreateHeaderRequest

Cria um Header. O novo cabeçalho é aplicado ao SectionStyle no local do SectionBreak se especificado. Caso contrário, ele é 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 (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Campos
type

enum (HeaderFooterType)

O tipo de cabeçalho a ser criado.

sectionBreakLocation

object (Location)

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

HeaderFooterType

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, ele é aplicado ao DocumentStyle.

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

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 a que SectionStyle este rodapé deve pertencer. Se essa opção não estiver definida ou se se referir à primeira quebra de seção do documento, o rodapé será aplicado ao estilo do documento.

CreateFootnoteRequest

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

O novo segmento Footnote vai 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 um dos seguintes:
location

object (Location)

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

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

As referências de nota de rodapé não podem ser inseridas em 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 campo segment ID precisa estar vazio.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

As referências de nota de rodapé não podem ser inseridas em um 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.

ReplaceNamedRangeContentRequest

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

Uma NamedRange individual pode consistir em várias ranges descontínuas. 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 400 de solicitação inválida é retornado.

Representação JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // 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
tabsCriteria

object (TabsCriteria)

Opcional. Os critérios usados para especificar em quais guias a substituição ocorre. Quando omitida, a substituição se aplica a todas as guias.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a substituição será aplicada à guia única.

Em um documento com várias guias:

  • Se fornecido, a substituição será aplicada às guias especificadas.

  • Se omitido, a substituição será aplicada a todas as guias.

Campo de união replacement_content. O conteúdo que vai substituir o conteúdo atual do intervalo nomeado. replacement_content pode ser apenas um dos seguintes:
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 de um dos tipos a seguir:
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 400 de solicitação inválida será retornado.

namedRangeName

string

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

Se houver várias named ranges com o nome fornecido, o conteúdo de cada uma será substituído. Se não houver intervalos nomeados com o nome fornecido, a solicitação não será executada.

UpdateSectionStyleRequest

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 para estilizar.

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.

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

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. O sectionStyle raiz é implícito e não precisa ser especificado. Um único "*" pode ser usado como atalho para 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 em que o intervalo será inserido. insertion_location pode ser apenas um dos seguintes:
location

object (Location)

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

A quebra de seção precisa ser inserida dentro dos limites de um Paragraph. Por exemplo, não é possível inseri-lo no índice inicial de uma tabela (ou seja, entre a tabela e o parágrafo anterior).

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, o campo segment ID precisa estar vazio.

endOfSegmentLocation

object (EndOfSegmentLocation)

Insere uma nova linha e um intervalo 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,
  "tabId": 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 na ausência de um cabeçalho desse tipo na 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 a partir da seção anterior.

tabId

string

A guia contendo o cabeçalho a ser excluído. Se omitido, o pedido é aplicado à primeira guia.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a solicitação se aplica à guia única.

Em um documento com várias guias:

  • Se fornecido, a solicitação se aplica à guia especificada.

  • Se omitido, a solicitação se aplica à primeira guia do documento.

DeleteFooterRequest

Exclui um Footer do documento.

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

string

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

tabId

string

A guia que contém o rodapé a ser excluído. Quando omitida, a solicitação é aplicada à primeira guia.

Em um documento com uma única guia:

  • Se fornecido, precisa corresponder ao ID da guia única.

  • Se omitido, a solicitação se aplica à guia única.

Em um documento com várias guias:

  • Se fornecido, a solicitação se aplica à guia especificada.

  • Se omitido, a solicitação se aplica à primeira guia do documento.

PinTableHeaderRowsRequest

Atualiza o número de linhas de cabeçalho fixadas 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 de tabela a serem fixadas, em que 0 implica que todas as linhas estão desconectadas.