Google Search Console

Visão geral

O Google Search Console é uma ferramenta gratuita do Google que permite monitorar, manter e depurar a presença do seu site nos resultados de pesquisa. Oferece dados sobre cliques, impressões, posição média e problemas de indexação. Com a integração no SquadOS, seus agentes podem consultar analytics de busca, inspecionar URLs, gerenciar sitemaps e monitorar propriedades cadastradas no Search Console de forma automatizada.

• Site oficial: https://search.google.com/search-console/
• Documentação na Composio: docs.composio.dev/toolkits/google_search_console

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar. O acesso é concedido diretamente pela conta Google, sem necessidade de gerar chaves de API manualmente.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
Conta Google	Sim	Conta Google com acesso ao Google Search Console. O consentimento é concedido via fluxo OAuth na página da Composio.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Google Search Console.
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 à sua conta Google.
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.)

Ações disponíveis

Adicionar site

GOOGLE_SEARCH_CONSOLE_ADD_SITE

Adiciona um site ao conjunto de sites do usuário no Google Search Console. Esta ação registra uma nova propriedade (site) no Search Console para o usuário autenticado. Após adicionar o site, será necessário verificar a propriedade por um dos métodos de verificação disponíveis. A URL do site deve estar corretamente formatada como propriedade de prefixo de URL (com protocolo) ou propriedade de domínio (com prefixo sc-domain).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
site_url	string	Sim	URL do site a adicionar ao Google Search Console. Para propriedades de prefixo de URL, use a URL completa com protocolo (ex.: https://www.example.com/). Para propriedades de domínio, use o formato sc-domain (ex.: sc-domain:example.com). O site precisará ser verificado após o cadastro.

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.

Remover site

GOOGLE_SEARCH_CONSOLE_DELETE_SITE

Remove um site da conta do usuário no Google Search Console. Esta ação exclui permanentemente uma propriedade de site da conta Search Console do usuário autenticado. A URL do site deve estar codificada em URL. Use quando precisar cancelar o monitoramento de um site no Search Console.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
site_url	string	Sim	URL do site a remover do Google Search Console. Para propriedades de prefixo de URL, use a URL completa com protocolo (ex.: http://www.example.com/). Para propriedades de domínio, use o formato sc-domain (ex.: sc-domain:example.com). O site deve estar atualmente registrado no Search Console pelo usuário autenticado.

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 site

GOOGLE_SEARCH_CONSOLE_GET_SITE

Recupera informações sobre um site específico no Search Console. Use quando precisar obter detalhes do site, incluindo nível de permissão de uma propriedade específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
site_url	string	Sim	URL da propriedade a recuperar, conforme definida no Search Console. Exemplos: http://www.example.com/ (para propriedade de prefixo de URL) ou sc-domain:example.com (para propriedade de domínio).

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 sitemap

GOOGLE_SEARCH_CONSOLE_GET_SITEMAP

Recupera metadados do sitemap (contagens de enviados/indexados, erros, avisos, timestamps da última submissão) de um sitemap específico no Search Console. Retorna apenas metadados, não o conteúdo XML bruto. Atenção: campos numéricos como errors, warnings, submitted e indexed podem ser retornados como strings; converta para inteiro antes de comparações. Valores como contents.indexed podem atrasar vários dias após a submissão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
feedpath	string	Sim	URL do sitemap a recuperar. Por exemplo: https://www.example.com/sitemap.xml
site_url	string	Sim	URL do site, incluindo protocolo. Por exemplo: https://www.example.com/. Para propriedades de domínio, use o formato sc-domain:example.com.

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.

Inspecionar URL

GOOGLE_SEARCH_CONSOLE_INSPECT_URL

Inspeciona uma URL em busca de problemas de indexação e status no Google Search Console. Os resultados podem refletir dados em cache com atraso de vários dias em relação às mudanças reais. Uso intensivo pode acionar erros de cota 429; limite o uso a URLs prioritárias.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
site_url	string	Sim	URL da propriedade conforme definida no Search Console. Propriedades de prefixo de URL devem incluir barra final. Por exemplo: https://www.example.com/
language_code	string	Não	Código de idioma IETF BCP-47 para localizar os resultados da inspeção. Por exemplo: en-US, es-ES, fr-FR
inspection_url	string	Sim	URL completamente qualificada a inspecionar. Deve ser uma página sob o site especificado em site_url. Por exemplo: https://www.example.com/page

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.

Listar sitemaps

GOOGLE_SEARCH_CONSOLE_LIST_SITEMAPS

Lista todos os sitemaps de um site no Google Search Console. Os campos errors, warnings, contents.submitted e contents.indexed da resposta podem ser retornados como strings; converta para inteiros antes de operações numéricas. Avalie esses campos junto com isPending para verificar a saúde do sitemap.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
site_url	string	Sim	URL do site, incluindo protocolo. Por exemplo: https://www.example.com/. Deve corresponder exatamente à string da propriedade no Search Console — inclua barra final para propriedades de prefixo de URL ou use o formato sc-domain:example.com para propriedades de domínio. Uma correspondência inexata retorna dados vazios silenciosamente.
sitemap_index	string	Não	URL do arquivo de índice de sitemap do site (ex.: http://www.example.com/sitemapindex.xml). Quando especificado, lista os sitemaps contidos neste arquivo de índice em vez de todos os sitemaps do site.

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.

Listar sites

GOOGLE_SEARCH_CONSOLE_LIST_SITES

Lista todos os sites verificados (propriedades) pertencentes ao usuário autenticado no Google Search Console. A resposta contém um array siteEntry — sempre itere sobre ele, nunca assuma um único objeto. Cada entrada inclui permissionLevel, que varia por site; não assuma acesso de proprietário para todas as propriedades retornadas. Ao chamar outras ferramentas, use o valor de site_url exatamente como retornado, incluindo protocolo, subdomínio, prefixo sc-domain: e barra final — qualquer desvio causa resultados vazios ou erros de permissão. Um siteEntry vazio pode indicar escopos OAuth ausentes ou nenhuma propriedade verificada. Propriedades recém-adicionadas podem não aparecer imediatamente por causa do atraso de propagaçã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.

Consultar analytics de busca

GOOGLE_SEARCH_CONSOLE_SEARCH_ANALYTICS_QUERY

Consulta o Google Search Console para obter dados de analytics de busca, incluindo métricas de cliques, impressões, CTR e posição. Retorna apenas URLs com pelo menos uma impressão; linhas ausentes não confirmam não-indexação. A posição é uma média ponderada por impressões.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
end_date	string	Sim	Data final do intervalo de datas da consulta, no formato YYYY-MM-DD.
site_url	string	Sim	URL do site, incluindo protocolo (ex.: https://www.example.com/) ou propriedade de domínio (ex.: sc-domain:example.com). Propriedades de prefixo de URL especificam protocolo e caminho exatos, enquanto propriedades de domínio agregam dados de todos os subdomínios e protocolos.
row_limit	integer	Não	Número máximo de linhas a retornar. Deve estar entre 1 e 25.000. Atenção: a API retorna os principais resultados ordenados por cliques (ou por data quando agrupado por data). Use start_row para paginação; pare quando as linhas da resposta forem menores que row_limit.
start_row	integer	Não	Primeira linha a retornar do conjunto de resultados. Usado para paginação.
data_state	string	Não	Estado dos dados a retornar. Valores aceitos: "final", "all", "hourly_all".
dimensions	array	Não	Dimensões pelas quais agrupar os dados. Os resultados são ordenados por cliques de forma decrescente, exceto quando agrupados por data (ordenados de forma crescente por data).
start_date	string	Sim	Data inicial do intervalo de datas da consulta, no formato YYYY-MM-DD. Os dados atrasam 2–3 dias (UTC); os 1–2 dias mais recentes podem estar incompletos. A retenção de dados é de aproximadamente 16 meses; intervalos mais antigos retornam zero linhas.
search_type	string	Não	Tipo de busca pelo qual filtrar os resultados. Valores aceitos: "web", "image", "video", "news", "discover", "googleNews".
aggregation_type	string	Não	Como os dados são agregados. Valores aceitos: "auto", "byPage", "byProperty", "byNewsShowcasePanel".
dimension_filter_groups	array	Não	Filtros opcionais a aplicar nas dimensões. Cada grupo de filtros contém um array de filtros com a estrutura: [{'filters': [{'dimension': 'country', 'operator': 'equals', 'expression': 'USA'}]}]. Operadores: equals, notEquals, contains, notContains, includingRegex, excludingRegex. Nomes de dimensão inválidos, operadores não suportados ou expressões incompatíveis retornam zero linhas sem erro — verifique cada filtro antes de confiar em resultados vazios.

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.

Enviar sitemap

GOOGLE_SEARCH_CONSOLE_SUBMIT_SITEMAP

Envia um sitemap ao Google Search Console para indexação. Esta ação registra ou resubmete um sitemap para uma propriedade verificada no Search Console. O arquivo de sitemap deve estar acessível na URL especificada e corretamente formatado como XML. Os tipos de sitemap suportados incluem sitemaps padrão, arquivos de índice de sitemap, feeds RSS e feeds Atom. O usuário autenticado deve ter permissões de proprietário ou usuário completo para a propriedade. Após a submissão, o Google rastreará e processará o sitemap conforme o cronograma de indexação padrão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
feedpath	string	Sim	URL completa do sitemap a enviar (ex.: https://www.example.com/sitemap.xml). Deve estar acessível e corretamente formatada como arquivo XML de sitemap válido. Também pode ser um arquivo de índice de sitemap ou URL de feed RSS/Atom. Deve corresponder exatamente à URL do sitemap registrado, incluindo protocolo, host, caminho e barra final; divergências retornam erros notFound ou invalid.
site_url	string	Sim	URL do site conforme registrada no Google Search Console. Para propriedades de prefixo de URL, use a URL completa com protocolo (ex.: https://www.example.com/). Para propriedades de domínio, use o formato sc-domain (ex.: sc-domain:example.com). O site deve estar verificado e ser de propriedade do usuário autenticado.

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.