Requests

{

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

object (ReplaceAllTextRequest)

Substitui todas as ocorrências do texto especificado.

object (InsertTextRequest)

Insere texto no local especificado.

object (UpdateTextStyleRequest)

Atualiza o estilo de texto no intervalo especificado.

object (CreateParagraphBulletsRequest)

Cria marcadores para parágrafos.

object (DeleteParagraphBulletsRequest)

Exclui marcadores de parágrafos.

object (CreateNamedRangeRequest)

Cria um intervalo nomeado.

object (DeleteNamedRangeRequest)

Exclui um intervalo nomeado.

object (UpdateParagraphStyleRequest)

Atualiza o estilo de parágrafo no intervalo especificado.

object (DeleteContentRangeRequest)

Exclui o conteúdo do documento.

object (InsertInlineImageRequest)

Insere uma imagem inline no local especificado.

object (InsertTableRequest)

Insere uma tabela no local especificado.

object (InsertTableRowRequest)

Insere uma linha vazia em uma tabela.

object (InsertTableColumnRequest)

Insere uma coluna vazia em uma tabela.

object (DeleteTableRowRequest)

Exclui uma linha de uma tabela.

object (DeleteTableColumnRequest)

Exclui uma coluna de uma tabela.

object (InsertPageBreakRequest)

Insere uma quebra de página no local especificado.

object (DeletePositionedObjectRequest)

Exclui um objeto posicionado do documento.

object (UpdateTableColumnPropertiesRequest)

Atualiza as propriedades das colunas em uma tabela.

object (UpdateTableCellStyleRequest)

Atualiza o estilo das células da tabela.

object (UpdateTableRowStyleRequest)

Atualiza o estilo da linha em uma tabela.

object (ReplaceImageRequest)

Substitui uma imagem no documento.

object (UpdateDocumentStyleRequest)

Atualiza o estilo do documento.

object (MergeTableCellsRequest)

Mescla células em uma tabela.

object (UnmergeTableCellsRequest)

Cancela a mesclagem de células em uma tabela.

object (CreateHeaderRequest)

Cria um cabeçalho.

object (CreateFooterRequest)

Cria um rodapé.

object (CreateFootnoteRequest)

Cria uma nota de rodapé.

object (ReplaceNamedRangeContentRequest)

Substitui o conteúdo em um intervalo nomeado.

object (UpdateSectionStyleRequest)

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

object (InsertSectionBreakRequest)

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

object (DeleteHeaderRequest)

Exclui um cabeçalho do documento.

object (DeleteFooterRequest)

Exclui um rodapé do documento.

object (PinTableHeaderRowsRequest)

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

{
  "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.
}

string

O texto que substituirá o texto correspondente.

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

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

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

Em um documento com várias guias:

• Se fornecido, a substituição se aplica às guias especificadas.

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

object (SubstringMatchCriteria)

Encontra texto no documento que corresponde a essa substring.

{
  "text": string,
  "matchCase": boolean
}

string

O texto a ser pesquisado no documento.

boolean

Indica se a pesquisa deve respeitar a capitalização:

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

{
  "tabIds": [
    string
  ]
}

string

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

{
  "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.
}

string

O texto a ser inserido.

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

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.

object (Location)

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

O texto precisa ser inserido dentro dos limites de um Paragraph: Por exemplo, o texto não pode ser inserido 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.

object (EndOfSegmentLocation)

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

{
  "segmentId": string,
  "index": integer,
  "tabId": string
}

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.

integer

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

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

string

A guia em que o local está. Quando omitida, a solicitação é aplicada à primeira guia.

Em um documento com uma única guia:

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

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

Em um documento com várias guias:

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

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

{
  "segmentId": string,
  "tabId": string
}

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.

string

A guia em que o local está. Quando omitida, a solicitação é aplicada à primeira guia.

Em um documento com uma única guia:

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

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

Em um documento com várias guias:

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

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

{
  "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.
}

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.

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

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. A raiz textStyle está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

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

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

object (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.

{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}

object (Range)

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

enum (BulletGlyphPreset)

Os tipos de marcadores a serem usados.

{
  "range": {
    object (Range)
  }
}

object (Range)

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

{
  "name": string,
  "range": {
    object (Range)
  }
}

string

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

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

object (Range)

O intervalo ao qual aplicar o nome.

{
  "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.
}

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

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

• Se omitido, a exclusão do intervalo será aplicada à guia singular.

Em um documento com várias guias:

• Se fornecido, a exclusão do intervalo se aplica às guias especificadas.

• Se não for informado, a exclusão do intervalo vai ser aplicada a todas as guias.

string

O ID do intervalo nomeado a ser excluído.

string

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

{
  "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.
}

object (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 ParagraphStyle para mais informações.

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. A raiz paragraphStyle está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

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

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

object (Range)

O intervalo que se sobrepõe aos parágrafos para definir o estilo.

{
  "range": {
    object (Range)
  }
}

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

• Exclusão de uma unidade de código de um par alternativo.
• Exclusão do último caractere de nova linha de um Body, Header, Footer, Footnote, TableCell ou TableOfContents.
• Excluir o início ou o fim de um Table, TableOfContents ou Equation sem excluir o elemento inteiro.
• Excluindo o caractere de nova linha antes de um Table, TableOfContents ou SectionBreak sem excluir o elemento.
• Exclusão de linhas ou células individuais de uma tabela. É permitido excluir o conteúdo de uma célula da tabela.

{
  "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.
}

string

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 ImageProperties.content_uri .

object (Size)

O tamanho da imagem no documento. Essa propriedade é opcional, e o tamanho final da imagem no documento é determinado pelas seguintes regras: * Se a largura e a altura não forem especificadas, o tamanho padrão da imagem será calculado com base 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.

object (Location)

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

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

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

object (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é.

{
  "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.
}

integer

O número de linhas na tabela.

integer

O número de colunas na tabela.

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 inicial da tabela estará no índice do local especificado + 1.

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

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

object (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é.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}

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

boolean

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}

object (Location)

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

integer

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

integer

O índice de colunas baseado em zero. Por exemplo, a segunda coluna da tabela tem um índice de coluna igual a 1.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}

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

boolean

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

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (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.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (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.

{

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

object (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 Paragraph: Por exemplo, ela não pode ser inserida 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 segment ID deve estar vazio.

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

{
  "objectId": string,
  "tabId": string
}

string

O ID do objeto posicionado a ser excluído.

string

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:

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

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

Em um documento com várias guias:

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}

object (Location)

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

integer

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.

object (TableColumnProperties)

As propriedades da coluna da tabela a serem atualizadas.

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

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. A raiz tableColumnProperties está implícito e não deve ser especificado. Um "*" pode ser usado como uma forma abreviada para listar todos os campos.

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

{
  "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.
}

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

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. A raiz tableCellStyle está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

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

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

object (TableRange)

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

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.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}

object (TableCellLocation)

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

integer

A extensão da linha do intervalo da tabela.

integer

A extensão de colunas do intervalo da tabela.

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}

object (Location)

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

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.

object (TableRowStyle)

Os estilos a serem definidos nas linhas.

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. A raiz tableRowStyle está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

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

{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}

string

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

string

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 ImageProperties.source_uri .

enum (ImageReplaceMethod)

O método de substituição.

string

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:

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

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

Em um documento com várias guias:

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

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

{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}

object (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 DocumentStyle para mais informações.

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. A raiz documentStyle está implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

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

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 no singular.

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

Em um documento com várias guias:

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

• Se não for informado, a solicitação se aplicará à primeira guia do documento.

{
  "tableRange": {
    object (TableRange)
  }
}

object (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.

{
  "tableRange": {
    object (TableRange)
  }
}

object (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.

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

O tipo de cabeçalho a ser criado.

object (Location)

A localização do SectionBreak que começa a seção a que este cabeçalho deve pertencer. Se "sectionBreakLocation" não estiver definido ou se fizer referência à primeira quebra de seção no corpo do documento, o cabeçalho será aplicado ao DocumentStyle

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

O tipo de rodapé a ser criado.

object (Location)

A localização do SectionBreak imediatamente à seção cuja SectionStyle a que este rodapé deve pertencer. Se ela for deixada sem definição ou se referir à primeira quebra de seção no documento, o rodapé será aplicado ao estilo do documento.

{

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

object (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 Paragraph: Por exemplo, ela não pode ser inserida 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 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 segment ID deve estar vazio.

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

{
  "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.
}

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

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

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

Em um documento com várias guias:

• Se fornecido, a substituição se aplica às guias especificadas.

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

string

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

string

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.

string

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

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

{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}

object (Range)

O intervalo sobrepondo as seções ao estilo.

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

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 Google. Consulte a documentação SectionStyle para mais informações.

string (FieldMask format)

Os campos que precisam ser atualizados.

É necessário especificar pelo menos um campo. A raiz sectionStyle fica implícito e não deve ser especificado. Um único "*" pode ser usado como uma forma abreviada para listar todos os campos.

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

{
  "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.
}

enum (SectionType)

O tipo de seção a ser inserida.

object (Location)

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

A quebra de seção precisa ser inserida dentro dos limites de um Paragraph: Por exemplo, ela não pode ser inserida 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, a segment ID deve estar vazio.

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

{
  "headerId": string,
  "tabId": string
}

string

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

string

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:

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

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

Em um documento com várias guias:

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

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

{
  "footerId": string,
  "tabId": string
}

string

ID do rodapé a ser excluído. Se esse rodapé for definido DocumentStyle, a referência a esse rodapé será removida, e não haverá nenhum rodapé desse tipo na primeira seção do documento. Se esse rodapé for definido SectionStyle, a referência a esse rodapé será removida e o rodapé desse tipo será mantido da seção anterior.

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 no singular.

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

Em um documento com várias guias:

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}

object (Location)

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

integer

O número de linhas da tabela que serão fixadas. 0 indica que todas as linhas estão liberadas.