Google Docs

Visão geral

O Google Docs é um processador de texto baseado na nuvem com colaboração em tempo real, histórico de versões e integração com outros aplicativos do Google Workspace. Com a integração no SquadOS, seus agentes podem criar documentos a partir de texto simples ou Markdown, editar conteúdo existente, pesquisar arquivos, exportar PDFs e automatizar fluxos de trabalho completos de documentação diretamente via API.

• Site oficial: https://docs.google.com/
• Documentação na Composio: docs.composio.dev/toolkits/googledocs

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
Conta Google	Sim	Autorização via OAuth 2.0 gerenciada pela Composio. Nenhuma chave manual é necessária — basta autorizar o acesso durante a conexão.

Como obter a credencial

O Google Docs usa OAuth 2.0 gerenciado pela Composio. Não é necessário criar chaves manualmente:

1. Clique em Conectar no SquadOS (veja a seção abaixo).
2. Você será redirecionado para a página de autorização do Google.
3. Faça login com a conta Google que deseja conectar.
4. Revise as permissões solicitadas e clique em Permitir.
5. Após a autorização, você volta automaticamente ao SquadOS com a conta conectada.

Dica

Se sua organização usa o Google Workspace, certifique-se de que a conta tem permissão para autorizar aplicativos de terceiros. Em caso de erro “App is blocked”, seu administrador do Workspace pode precisar aprovar o acesso.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Google Docs.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso (OAuth).
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Perguntas frequentes

Como configurar credenciais OAuth próprias para o Google Docs?

Para um guia passo a passo sobre como criar e configurar suas próprias credenciais OAuth do Google com a Composio, consulte How to create OAuth2 credentials for Google Apps.

Por que vejo “App is blocked” ao conectar o Google Docs?

O cliente OAuth está solicitando escopos que o Google não verificou para aquele cliente. Isso geralmente ocorre ao adicionar escopos extras além dos padrões. Remova os escopos adicionais da configuração de autenticação ou crie seu próprio aplicativo OAuth e submeta os escopos para verificação.

Por que recebo o erro “Google Docs API has not been used in project”?

Ao usar credenciais OAuth próprias, a API do Google Docs precisa estar habilitada no projeto do Google Cloud que possui essas credenciais. Habilite-a no Google Cloud Console em APIs & Services, aguarde alguns minutos e tente novamente.

Por que recebo “Error 400: invalid_scope”?

Os escopos solicitados são inválidos ou estão formatados incorretamente na URL de autorização. Verifique os valores de escopo na documentação de escopos OAuth do Google.

Por que a tela de consentimento OAuth mostra “Composio” em vez do meu app?

Por padrão, a tela de consentimento usa o app OAuth da Composio. Para exibir o nome e o logotipo do seu próprio app, crie seu próprio app OAuth e configure uma URL de redirecionamento personalizada.

Por que recebo erros 401 nas chamadas de ferramentas?

O token de acesso do usuário não é mais válido. Causas comuns: o usuário revogou o acesso, alterou a senha ou o 2FA, uma política do administrador do Workspace mudou, ou o limite de tokens de atualização do Google (~50 por conta) foi excedido. Reconectar o usuário geralmente resolve o problema.

Por que recebo “Quota Exhausted” ou “rate limit exhausted”?

O Google impõe cotas por minuto e diárias. Se você estiver usando o app OAuth padrão da Composio, compartilha essa cota com outros usuários. Use suas próprias credenciais OAuth para obter uma cota dedicada e adicione retentativas com backoff exponencial.

Ações disponíveis

Copiar documento do Google

GOOGLEDOCS_COPY_DOCUMENT

Cria uma cópia de um documento Google existente. Use para duplicar um documento, por exemplo, ao usar um documento existente como modelo. O documento copiado terá um título padrão (ex.: ‘Cópia de [título original]’) se nenhum título novo for fornecido, e será colocado na pasta raiz do Google Drive do usuário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
title	string	Não	O título para o novo documento copiado. Se não fornecido, o título será ‘Cópia de [título do documento original]’.
document_id	string	Sim	O ID do documento Google a ser copiado.
include_shared_drives	boolean	Não	Se deve suportar a cópia de documentos de drives compartilhados. Padrão: True.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar documento

GOOGLEDOCS_CREATE_DOCUMENT

Cria um novo documento do Google Docs usando o título fornecido como nome de arquivo e insere o texto inicial no início, se não estiver vazio, retornando o ID e os metadados do documento (excluindo o conteúdo do corpo).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
text	string	Não	Conteúdo de texto inicial opcional a inserir no início do novo documento. Se não fornecido, um documento vazio será criado. Para textos muito grandes (mais de 50.000 caracteres), o texto será inserido em partes para evitar limites da API.
title	string	Sim	Título para o novo documento, usado como nome de arquivo no Google Drive.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar documento em branco (Obsoleto)

GOOGLEDOCS_CREATE_DOCUMENT2

OBSOLETO: Use GOOGLEDOCS_CREATE_DOCUMENT em vez disso. Cria um documento do Google Docs em branco com um título especificado. Use quando precisar criar um novo documento vazio.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
title	string	Sim	O título do documento a criar. Será usado como nome do documento no Google Drive.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar documento em Markdown

GOOGLEDOCS_CREATE_DOCUMENT_MARKDOWN

Cria um novo documento do Google Docs, opcionalmente inicializando-o com um título e conteúdo fornecido como texto Markdown.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
title	string	Sim	O título para o novo documento do Google Docs.
image_assets	array	Não	Imagens enviadas opcionalmente que o Markdown pode referenciar pelo nome. Use a sintaxe de imagem Markdown como . URLs de imagem HTTPS públicas no Markdown não precisam de image_assets.
markdown_text	string	Não	O conteúdo inicial do documento, formatado como Markdown. Também aceita ‘content’ como alias. Suporta títulos, listas reais do Google Docs incluindo listas aninhadas, múltiplas tabelas Markdown, marcadores de lista de tarefas, imagens via URLs publicamente acessíveis ou uploads de image_assets correspondentes (comprimento máximo de URL de 2 KB após resolução; formatos: JPEG, PNG, GIF; SVG não suportado), citações em bloco, blocos de código, hiperlinks e formatação de texto (negrito, itálico, etc.). Se vazio ou omitido, cria o documento apenas com o título.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar rodapé

GOOGLEDOCS_CREATE_FOOTER

Cria um novo rodapé em um documento Google. Use quando precisar adicionar um rodapé, especificando opcionalmente seu tipo e a seção à qual se aplica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string ("DEFAULT")	Sim	O tipo de rodapé a criar.
document_id	string	Sim	O ID do documento no qual criar o rodapé.
section_break_location	object	Não	A localização da quebra de seção imediatamente anterior à seção cujo estilo este rodapé deve pertencer. Se não definido ou referir-se à primeira quebra de seção no documento, o rodapé se aplica ao estilo do documento.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar nota de rodapé

GOOGLEDOCS_CREATE_FOOTNOTE

Cria uma nova nota de rodapé em um documento Google. Use quando precisar adicionar uma nota de rodapé em uma localização específica ou ao final do corpo do documento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
location	object	Não	Insere a referência da nota de rodapé em um índice específico do documento. O segmentId neste objeto de localização deve estar vazio, pois notas de rodapé só podem ser inseridas no corpo do documento.
documentId	string	Sim	O ID do documento no qual criar a nota de rodapé.
endOfSegmentLocation	object	Não	Insere a referência da nota de rodapé ao final do corpo do documento. O segmentId neste objeto EndOfSegmentLocation deve estar vazio.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar cabeçalho

GOOGLEDOCS_CREATE_HEADER

Cria um novo cabeçalho em um documento Google, opcionalmente com conteúdo de texto. Use quando precisar adicionar um cabeçalho a um documento. Você pode fornecer: document_id (ID do documento, obrigatório), type (tipo de cabeçalho; DEFAULT é o cabeçalho padrão), text (conteúdo de texto opcional) e section_break_location (localização opcional para cabeçalhos específicos de seção).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
text	string	Não	Conteúdo de texto opcional a adicionar ao cabeçalho após a criação. Se fornecido, o texto será inserido no cabeçalho no índice 0.
type	string ("HEADER_FOOTER_TYPE_UNSPECIFIED" ou "DEFAULT")	Não	O tipo de cabeçalho a criar. Use DEFAULT para o cabeçalho padrão do documento. Apenas um cabeçalho DEFAULT pode existir por documento; se já existir um, o ID do cabeçalho existente será retornado.
documentId	string	Sim	O ID do documento no qual criar o cabeçalho.
sectionBreakLocation	object	Não	A localização da quebra de seção que inicia a seção à qual este cabeçalho deve pertencer. Necessário apenas para cabeçalhos específicos de seção.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar intervalo nomeado

GOOGLEDOCS_CREATE_NAMED_RANGE

Cria um novo intervalo nomeado em um documento Google. Use para atribuir um nome a uma parte específica do documento para referência mais fácil ou manipulação programática.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	O nome para o novo intervalo nomeado. Deve ter entre 1 e 256 caracteres.
tabId	string	Não	Opcional. O ID da aba do documento que contém este intervalo. Quando omitido, o Google Docs aplica a requisição à primeira aba.
documentId	string	Sim	O ID do documento onde o intervalo nomeado será criado.
rangeEndIndex	integer	Sim	O índice de fim do intervalo com base zero.
rangeSegmentId	string	Não	Opcional. O ID do cabeçalho, rodapé ou nota de rodapé. Vazio para o corpo do documento.
rangeStartIndex	integer	Sim	O índice de início do intervalo com base zero.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar marcadores de parágrafo

GOOGLEDOCS_CREATE_PARAGRAPH_BULLETS

Adiciona marcadores a parágrafos dentro de um intervalo especificado em um documento Google. Use quando precisar formatar uma lista ou um conjunto de parágrafos como pontos de marcador.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tabId	string	Não	ID de aba opcional a aplicar ao createParagraphBullets.range.tabId. Quando omitido, o Google Docs aplica a requisição à primeira aba.
document_id	string	Sim	O ID do documento a atualizar.
createParagraphBullets	object	Sim	O corpo da requisição para criar marcadores de parágrafo no documento.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir intervalo de conteúdo do documento

GOOGLEDOCS_DELETE_CONTENT_RANGE

Exclui um intervalo de conteúdo de um documento Google. Use quando precisar remover uma parte específica de texto ou outros elementos estruturais dentro de um documento. Nota: cada segmento (corpo, cabeçalho, rodapé, nota de rodapé) no Google Docs termina com um caractere de nova linha final que não pode ser excluído. Certifique-se de que o endIndex não inclua esta nova linha final.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
range	object	Sim	O intervalo de conteúdo a excluir. Excluir texto entre limites de parágrafo pode mesclar parágrafos e afetar estilos. Certas exclusões podem invalidar a estrutura do documento. IMPORTANTE: o endIndex não deve incluir o caractere de nova linha final ao fim de um segmento.
document_id	string	Sim	O ID do documento do qual excluir o conteúdo. Este ID pode ser encontrado na URL do Google Doc.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir rodapé

GOOGLEDOCS_DELETE_FOOTER

Exclui um rodapé de um documento Google. Use quando precisar remover um rodapé de uma seção específica ou o rodapé padrão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tab_id	string	Não	A aba que contém o rodapé a excluir. Quando omitido, a requisição é aplicada à primeira aba.
footer_id	string	Sim	O ID do rodapé a excluir. Os IDs de rodapé são strings geradas pelo sistema criadas pelo Google Docs. Obtenha um ID de rodapé válido da resposta de GOOGLEDOCS_CREATE_FOOTER ou de GOOGLEDOCS_GET_DOCUMENT_BY_ID. Não use valores inventados ou de espaço reservado.
document_id	string	Sim	O ID do documento do qual excluir o rodapé.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir cabeçalho

GOOGLEDOCS_DELETE_HEADER

Exclui o cabeçalho da seção especificada ou o cabeçalho padrão se nenhuma seção for especificada. Use para remover um cabeçalho de um documento Google.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tab_id	string	Não	A aba que contém o cabeçalho a excluir. Quando omitido, a requisição é aplicada à primeira aba.
header_id	string	Sim	O ID do cabeçalho a excluir. Se este cabeçalho estiver definido no DocumentStyle, a referência a ele é removida, resultando em nenhum cabeçalho desse tipo para a primeira seção do documento. Se estiver definido em um SectionStyle, a referência é removida e o cabeçalho desse tipo passa a ser continuado da seção anterior.
document_id	string	Sim	O ID do documento do qual excluir o cabeçalho.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir intervalo nomeado

GOOGLEDOCS_DELETE_NAMED_RANGE

Exclui um intervalo nomeado de um documento Google. Use quando precisar remover um intervalo nomeado previamente definido por seu ID ou nome.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
document_id	string	Sim	O ID do documento.
deleteNamedRange	object	Sim	Especifica o intervalo nomeado a excluir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir marcadores de parágrafo

GOOGLEDOCS_DELETE_PARAGRAPH_BULLETS

Remove marcadores de parágrafos dentro de um intervalo especificado em um documento Google. Use quando precisar limpar a formatação de marcadores de uma seção de um documento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
range	object	Sim	O intervalo do documento do qual excluir os marcadores de parágrafo. O intervalo é aplicado ao corpo do documento por padrão. Para especificar um segmento diferente (ex.: cabeçalho, rodapé), inclua segment_id no objeto de intervalo.
tab_id	string	Não	O ID da aba em que o intervalo está. Se omitido, aplica-se à primeira aba ou à aba singular em um documento de aba única.
document_id	string	Sim	O ID do documento a atualizar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir coluna da tabela

GOOGLEDOCS_DELETE_TABLE_COLUMN

Exclui uma coluna de uma tabela em um documento Google. Use quando precisar remover uma coluna específica de uma tabela existente dentro de um documento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
requests	array	Sim	Uma lista de requisições a serem aplicadas ao documento.
document_id	string	Sim	O ID do documento do qual excluir a coluna da tabela.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir linha da tabela

GOOGLEDOCS_DELETE_TABLE_ROW

Exclui uma linha de uma tabela em um documento Google. Use quando precisar remover uma linha específica de uma tabela existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
documentId	string	Sim	O ID do documento.
tableCellLocation	object	Sim	A localização da célula da tabela de referência a partir da qual a linha será excluída.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Exportar documento Google como PDF

GOOGLEDOCS_EXPORT_DOCUMENT_AS_PDF

Exporta um arquivo do Google Docs como PDF usando a API do Google Drive. Use quando precisar gerar uma versão PDF de um documento do Google Docs para download ou distribuição. Nota: o Google Drive impõe um limite de 10 MB no conteúdo exportado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
file_id	string	Sim	O ID do arquivo do Google Docs a exportar como PDF. É o mesmo que o ID do documento para arquivos do Google Docs — geralmente uma string alfanumérica de 44 caracteres. Extraia-o de uma URL do Google Docs: https://docs.google.com/document/d/<id-do-arquivo>/edit
filename	string	Não	Nome de arquivo sugerido opcional para o PDF exportado (ex.: relatorio.pdf). Se não fornecido, um nome de arquivo padrão será gerado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter documento por ID

GOOGLEDOCS_GET_DOCUMENT_BY_ID

Recupera um documento Google existente pelo seu ID; retornará erro se o documento não for encontrado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	O identificador único para um documento nativo do Google Docs (geralmente uma string alfanumérica de 44 caracteres). Aceita tanto um ID de documento quanto uma URL completa do Google Docs. IMPORTANTE: esta ferramenta funciona apenas com documentos nativos do Google Docs, não com arquivos Office (DOCX, XLSX, etc.) armazenados no Google Drive. Use GOOGLEDOCS_SEARCH_DOCUMENTS para encontrar documentos disponíveis.
includeTabsContent	boolean	Não	Quando true, solicita includeTabsContent=true para que a resposta inclua document.tabs com conteúdo de todas as abas. Quando false, o Google Docs retorna os campos de conteúdo da primeira aba (legado).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter texto simples do documento

GOOGLEDOCS_GET_DOCUMENT_PLAINTEXT

Recupera um documento Google pelo ID e retorna uma renderização em texto simples. Converte a estrutura do documento em texto simples, incluindo parágrafos, listas e tabelas, sem exigir que os clientes percorram o JSON complexo da API Docs.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tab_ids	array	Não	IDs de abas opcionais a incluir quando include_tabs_content=true. Abas filhas aninhadas são pesquisadas recursivamente.
document_id	string	Sim	O identificador único do documento Google. Aceita tanto um ID de documento quanto uma URL completa do Google Docs. Este parâmetro também aceita id como alias.
include_tables	boolean	Não	Se deve incluir o conteúdo de tabelas na saída de texto simples. As tabelas são renderizadas com delimitadores de células e linhas configuráveis.
include_footers	boolean	Não	Se deve incluir o texto de rodapé na saída de texto simples. Os rodapés são anexados com um separador de seção claro.
include_headers	boolean	Não	Se deve incluir o texto de cabeçalho na saída de texto simples. Os cabeçalhos são anexados com um separador de seção claro.
include_footnotes	boolean	Não	Se deve incluir o texto de notas de rodapé na saída de texto simples. As notas são anexadas com um separador de seção claro.
table_row_delimiter	string	Não	O delimitador a usar entre as linhas da tabela (padrão: caractere de nova linha).
include_tabs_content	boolean	Não	Quando true, busca o documento usando includeTabsContent=true para renderizar todas as abas. Quando false, apenas o conteúdo do corpo principal é renderizado.
table_cell_delimiter	string	Não	O delimitador a usar entre as células da tabela (padrão: caractere de tabulação).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir imagem inline

GOOGLEDOCS_INSERT_INLINE_IMAGE

Insere uma imagem de um URI especificado em uma localização específica de um documento Google como imagem inline. Use quando precisar adicionar uma imagem a um documento de forma programática.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uri	string	Sim	O URI da imagem. Deve ser uma URL de imagem direta e publicamente acessível (sem redirecionamentos ou links de visualização). As imagens devem ter menos de 50 MB, não exceder 25 megapixels e estar no formato PNG, JPEG ou GIF (SVG não suportado). O URI pode ter no máximo 2 KB de comprimento.
location	object	Sim	A localização no documento onde inserir a imagem. O campo index é obrigatório para especificar o ponto de inserção.
documentId	string	Sim	O ID do documento a atualizar.
objectSize	object	Não	O tamanho da imagem. Se não especificado, a imagem é renderizada em seu tamanho intrínseco.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir quebra de página

GOOGLEDOCS_INSERT_PAGE_BREAK

Insere uma quebra de página em um documento Google. Use quando precisar iniciar novo conteúdo em uma página nova, como ao final de um capítulo ou seção.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
documentId	string	Sim	O ID do documento a atualizar.
insertPageBreak	string	Sim	Os detalhes para a requisição insertPageBreak.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir tabela no documento

GOOGLEDOCS_INSERT_TABLE_ACTION

Insere uma tabela em um documento Google. Use quando precisar adicionar uma nova tabela em uma localização específica ou ao final de um segmento (como corpo do documento, cabeçalho ou rodapé) em um documento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
rows	integer	Sim	O número de linhas na tabela.
index	integer	Não	O índice com base zero onde a tabela será inserida, em unidades de código UTF-16. IMPORTANTE: o índice deve ser estritamente menor que o índice final do segmento. Para inserir ao final de um segmento, omita este parâmetro e defina insertAtEndOfSegment como true.
tabId	string	Não	A aba em que a localização está. Quando omitido, a requisição é aplicada à primeira aba.
columns	integer	Sim	O número de colunas na tabela.
segmentId	string	Não	O ID do cabeçalho, rodapé ou nota de rodapé em que a localização está. Um ID de segmento vazio indica o corpo do documento.
documentId	string	Sim	O ID do documento a atualizar.
insertAtEndOfSegment	boolean	Não	Se true, insere a tabela ao final do segmento. Esta é a forma recomendada de anexar conteúdo ao final de um segmento. Se false ou omitido e index não for fornecido, o padrão é inserir ao final do corpo do documento.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir coluna na tabela

GOOGLEDOCS_INSERT_TABLE_COLUMN

Insere uma nova coluna em uma tabela de um documento Google. Use quando precisar adicionar uma coluna a uma tabela existente em uma localização específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
requests	array	Sim	Uma lista de requisições de inserção de coluna em tabela. Múltiplas requisições podem ser enviadas em uma única chamada para inserir colunas em diferentes localizações no documento.
document_id	string	Sim	O ID do documento a atualizar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir texto no documento

GOOGLEDOCS_INSERT_TEXT_ACTION

Insere uma string de texto em uma localização especificada dentro de um documento Google. Use quando precisar adicionar novo conteúdo de texto a um documento existente. IMPORTANTE: há duas formas de especificar a localização de inserção: (1) use insertion_index para inserir em uma posição específica (índice 1 é seguro para o início do documento); (2) use append_to_end=true para anexar texto ao final do documento (recomendado para anexar). RESTRIÇÃO CRÍTICA: ao usar insertion_index, o índice DEVE estar dentro dos limites de um parágrafo EXISTENTE. O índice também deve ser estritamente menor que o índice final do documento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tab_id	string	Não	O ID da aba do documento na qual inserir o texto. Quando omitido, o Google Docs aplica a requisição à primeira aba.
segment_id	string	Não	O ID do cabeçalho, rodapé ou nota de rodapé no qual inserir o texto. Deixe vazio ou omita para inserir no corpo do documento.
document_id	string	Sim	O ID do documento no qual inserir o texto.
append_to_end	boolean	Não	Defina como true para anexar texto ao final do corpo do documento. Quando true, o parâmetro insertion_index é ignorado. Esta é a forma recomendada de adicionar texto ao final de um documento.
text_to_insert	string	Sim	A string de texto a inserir. Alternativamente, pode ser fornecida como text.
insertion_index	integer	Não	O índice com base zero em unidades de código UTF-16 onde o texto será inserido. Alternativamente, pode ser fornecido como index. RESTRIÇÕES CRÍTICAS: (1) o índice DEVE estar dentro dos limites de um parágrafo EXISTENTE; (2) o índice DEVE ser estritamente menor que o índice final do documento. O índice 1 é o mínimo válido e seguro para inserir no início do documento. Para adicionar texto com segurança sem preocupações com o índice, defina append_to_end como true.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter gráficos da planilha

GOOGLEDOCS_LIST_SPREADSHEET_CHARTS

Recupera uma lista de todos os gráficos de uma planilha do Google Sheets especificada. Use quando precisar obter IDs de gráficos e suas especificações para incorporação ou referência em outro lugar, como no Google Docs.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
spreadsheet_id	string	Sim	O ID da planilha do Google Sheets da qual recuperar os gráficos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Substituir todo o texto do documento

GOOGLEDOCS_REPLACE_ALL_TEXT

Substitui todas as ocorrências de uma string de texto especificada por outra string de texto em todo um documento Google. Use quando precisar realizar uma operação global de localizar e substituir dentro de um documento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tab_ids	array	Não	Opcional. Uma lista de IDs de abas específicas nos quais realizar a substituição. Se não fornecido, a substituição ocorre em todas as abas.
find_text	string	Sim	O texto a pesquisar no documento. Não pode estar vazio.
match_case	boolean	Não	Indica se a pesquisa deve diferenciar maiúsculas de minúsculas. Padrão: false (não diferencia).
document_id	string	Sim	O ID do documento a atualizar.
replace_text	string	Sim	O texto que substituirá o texto encontrado.
search_by_regex	boolean	Não	Opcional. Se true, o find_text é tratado como uma expressão regular. Padrão: false.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Substituir imagem no documento

GOOGLEDOCS_REPLACE_IMAGE

Substitui uma imagem específica em um documento por uma nova imagem de um URI. Use quando precisar atualizar uma imagem existente dentro de um documento Google.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
document_id	string	Sim	O ID do documento que contém a imagem a substituir.
replace_image	object	Sim	Os detalhes da requisição de substituição de imagem.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Pesquisar documentos

GOOGLEDOCS_SEARCH_DOCUMENTS

Pesquisa documentos Google usando vários filtros, incluindo nome, conteúdo, intervalos de datas e mais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Não	Consulta de pesquisa para filtrar documentos. Forneça: (1) texto simples para pesquisar no conteúdo do documento (ex.: ‘relatório trimestral’), que pesquisará fullText; ou (2) sintaxe de consulta da API do Drive com operadores como name contains, fullText contains, combinados com and, or, not. Deixe vazio para obter todos os documentos.
order_by	string	Não	Ordenar resultados por campo. Opções comuns: modifiedTime desc, modifiedTime asc, name, createdTime desc.
page_token	string	Não	Token para continuar uma requisição de pesquisa anterior na próxima página. Use o next_page_token da resposta anterior para recuperar resultados adicionais.
max_results	integer	Não	Número máximo de documentos a retornar por página (1–100). Padrão: 10.
starred_only	boolean	Não	Se deve retornar apenas documentos marcados com estrela. Padrão: false.
created_after	string	Não	Retornar documentos criados após esta data. Use o formato RFC 3339, como 2024-01-01T00:00:00Z.
modified_after	string	Não	Retornar documentos modificados após esta data. Use o formato RFC 3339, como 2024-01-01T00:00:00Z.
shared_with_me	boolean	Não	Se deve retornar apenas documentos compartilhados com o usuário atual. Padrão: false.
include_trashed	boolean	Não	Se deve incluir documentos na lixeira. Padrão: false.
response_detail	string ("minimal" ou "full")	Não	Nível de detalhe na resposta. minimal retorna apenas campos essenciais (id, name, modifiedTime, webViewLink). full retorna metadados abrangentes, incluindo permissões, proprietários, timestamps e outras informações detalhadas.
include_shared_drives	boolean	Não	Se deve incluir documentos de drives compartilhados aos quais você tem acesso. Padrão: true.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Desfazer mesclagem de células da tabela

GOOGLEDOCS_UNMERGE_TABLE_CELLS

Desfaz a mesclagem de células previamente mescladas em uma tabela. Use quando precisar reverter células mescladas em uma tabela de documento Google de volta aos seus estados de célula individuais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
documentId	string	Sim	O ID do documento no qual desfazer a mesclagem de células da tabela.
tableRange	object	Sim	O intervalo da tabela especificando quais células desfazer a mesclagem.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar documento em lote (Obsoleto)

GOOGLEDOCS_UPDATE_DOCUMENT_BATCH

OBSOLETO: Use UpdateExistingDocument em vez disso. Aplica uma ou mais atualizações a um documento Google. Use quando precisar realizar operações em lote em um documento, como inserir texto, atualizar estilos ou modificar a estrutura do documento. Suporta mais de 35 tipos de requisição, incluindo insertText, replaceAllText, updateTextStyle, createParagraphBullets, insertTable, createHeader/Footer e mais. Cada requisição é validada antes de ser aplicada. Se qualquer requisição for inválida, toda a operação falha e nada é aplicado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
requests	array	Sim	Uma lista de atualizações a aplicar ao documento. Cada dicionário de requisição deve conter exatamente uma chave de tipo de requisição (ex.: insertText, replaceAllText, updateTextStyle, createParagraphBullets). Consulte https://developers.google.com/docs/api/reference/rest/v1/documents/request para todos os tipos.
document_id	string	Sim	O ID do documento a atualizar.
write_control	object	Não	Fornece controle sobre como as requisições de escrita são executadas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar documento em Markdown

GOOGLEDOCS_UPDATE_DOCUMENT_MARKDOWN

Substitui todo o conteúdo de um documento Google Docs existente por novo texto Markdown; requer permissões de edição no documento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	O identificador único do documento Google Docs a atualizar. Aceita tanto um ID de documento quanto uma URL completa do Google Docs.
tab_id	string	Não	ID de aba opcional para substituir com o Markdown renderizado. Quando omitido, a primeira aba é atualizada.
markdown	string	Sim	Conteúdo Markdown que substituirá todo o conteúdo existente do documento. Suporta recursos Markdown padrão.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar seção do documento em Markdown

GOOGLEDOCS_UPDATE_DOCUMENT_SECTION_MARKDOWN

Insere ou substitui uma seção de um documento Google Docs com conteúdo Markdown. Use quando precisar atualizar apenas uma seção do documento especificando os índices de início e fim opcionais. Suporta formatação Markdown completa.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
tab_id	string	Não	ID de aba opcional para atualizar com o Markdown renderizado. Quando omitido, a primeira aba é atualizada.
end_index	integer	Não	Índice de fim com base um do conteúdo a substituir (exclusivo); deve ser maior ou igual a start_index. Se não fornecido, o conteúdo é inserido em start_index sem substituir o conteúdo existente. Importante: use os índices exatos de GOOGLEDOCS_GET_DOCUMENT_BY_ID sem modificação. A API do Google Docs não permite excluir o último caractere de nova linha de um segmento.
document_id	string	Sim	O ID único do documento Google Docs a atualizar. String alfanumérica encontrada na URL do documento: https://docs.google.com/document/d/<id-do-documento>/edit. Também aceita os aliases id, doc_id, documentId ou docId.
start_index	integer	Não	Índice com base um em unidades de código UTF-16 onde inserir ou iniciar a substituição. Se não fornecido, o conteúdo será anexado ao final do documento. Use 1 para inserir no início do documento.
markdown_text	string	Sim	Conteúdo Markdown a inserir ou substituir na seção do documento. Conteúdo grande é automaticamente dividido em lotes menores para evitar limites da API. Também aceita os aliases markdown, content, text, body, markdownText ou markdown_content.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar estilo do documento

GOOGLEDOCS_UPDATE_DOCUMENT_STYLE

Atualiza o estilo geral do documento, como tamanho da página, margens e direção padrão do texto. Use quando precisar modificar as configurações de estilo global de um documento Google.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
fields	string	Não	Uma lista separada por vírgulas de campos a atualizar (usando nomes camelCase da API, como marginTop, pageSize). Use * para atualizar automaticamente apenas os campos que têm valores definidos em document_style.
tab_id	string	Não	O ID da aba para a qual atualizar o estilo. Se não fornecido, a primeira aba é usada.
document_id	string	Sim	O ID do documento a atualizar.
document_style	object	Sim	O objeto DocumentStyle com as novas configurações de estilo.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar documento existente

GOOGLEDOCS_UPDATE_EXISTING_DOCUMENT

Aplica edições programáticas, como inserção de texto, exclusão ou formatação, a um documento Google especificado usando o método batchUpdate da API.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
edit_docs	array	Sim	(Obrigatório) Uma lista de requisições a executar no documento. Cada requisição deve ser um dicionário contendo exatamente UM dos tipos de requisição válidos. Tipos comuns: replaceAllText, insertText, updateTextStyle, createParagraphBullets, deleteParagraphBullets, createNamedRange, deleteNamedRange, updateParagraphStyle, deleteContentRange, insertInlineImage, insertTable, insertTableRow, insertTableColumn, deleteTableRow, deleteTableColumn, insertPageBreak, deletePositionedObject, updateTableColumnProperties, updateTableCellStyle, updateTableRowStyle, replaceImage, updateDocumentStyle, mergeTableCells, unmergeTableCells, createHeader, createFooter, createFootnote, replaceNamedRangeContent, updateSectionStyle, insertSectionBreak, deleteHeader, deleteFooter, pinTableHeaderRows, addDocumentTab, deleteTab, updateDocumentTabProperties, insertPerson. Não use tipos de requisição de outras APIs do Google (Slides, Sheets, etc.). Para esquemas completos, consulte https://developers.google.com/docs/api/reference/rest/v1/documents/batchUpdate. IDs de segmento internos kix. NÃO são válidos e causarão erros. IDs de aba inválidos também causam erros — obtenha IDs válidos via GOOGLEDOCS_GET_DOCUMENT_BY_ID. Para múltiplas inserções em posições específicas, processe em ORDEM INVERSA de índice (maior primeiro).
document_id	string	Sim	(Obrigatório) O identificador único do documento Google Docs a ser atualizado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar estilo de linha da tabela

GOOGLEDOCS_UPDATE_TABLE_ROW_STYLE

Atualiza o estilo de uma linha de tabela em um documento Google. Use quando precisar modificar a aparência de linhas específicas dentro de uma tabela, como definir altura mínima de linha ou marcar linhas como cabeçalhos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
documentId	string	Sim	O ID do documento a atualizar.
updateTableRowStyle	object	Sim	O corpo da requisição para atualizar o estilo da linha da tabela.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.