Sitemap
Busque e regenere o sitemap do seu projeto para que os mecanismos de busca possam descobrir e indexar suas páginas.
Mais informações sobre a interface do módulo: https://doc.oneentry.cloud/docs/category/sitemap (abre em uma nova aba)
O módulo Sitemap busca e regenera o sitemap do seu projeto OneEntry. updateSitemap(body) o gera, e getSitemap() resolve para as URLs dos arquivos de sitemap gerados.
Início rápido
Inicialize o módulo a partir de defineOneEntry:
const { } = defineOneEntry( , { });
Busque as URLs dos arquivos de sitemap gerados:
// Resolves to an array of sitemap file URLs (string[]).
const sitemaps = await Sitemap.getSitemap();
if ('statusCode' in sitemaps) throw new Error(sitemaps.message);
sitemaps.forEach((url) => {
console.log(url);
});
Leitura e geração
getSitemap() resolve para um array de URLs de arquivos de sitemap (string[]), por exemplo:
[
'https://your-project.oneentry.cloud/cloud-static/files/project/sitemap/sitemap-000.xml'
]
O sitemap não é gerado automaticamente. Chame updateSitemap(body) após adicionar ou alterar significativamente páginas, ou após mudar a estrutura do site.
updateSitemap() lê apenas body.baseUrls: um objeto que associa cada código de idioma ativo à URL base pública do site nesse idioma, por exemplo { en_US: "https://example.com/", ru_RU: "https://example.com/ru/" }. Toda chave precisa ser um código de idioma ativo, ou a chamada falha com um erro 400 (Invalid or inactive locale). Inclua en_US: a URL dele se torna o <loc> de cada entrada, e os outros idiomas são adicionados como links alternativos hreflang. A plataforma não grava lastmod, changefreq nem priority, então os outros campos de ISitemapQuery (url, lastmod, changefreq, priority) não têm efeito.
O sitemap lista todas as páginas que têm URL, além de cada produto sob cada página de catálogo à qual ele pertence. Cada execução exclui os arquivos gerados anteriormente e grava novos, com até 50.000 URLs por arquivo (sitemap-000.xml, sitemap-001.xml, …).
Envio aos mecanismos de busca
O módulo não envia o sitemap aos mecanismos de busca. Gere-o com updateSitemap(body), obtenha as URLs dos arquivos com getSitemap() e envie-as no Google Search Console (em Sitemaps) ou no Bing Webmaster Tools.
Métodos
| Método | Descrição |
|---|---|
| getSitemap() | Obter as URLs dos arquivos de sitemap |
| updateSitemap() | Regenerar o sitemap |
Relacionados
- Módulo Pages: as páginas incluídas no sitemap
- Módulo System: utilitários de API em nível de sistema