Sitemaps

  • The Sitemap resource provides detailed information about URLs submitted through a sitemap file, including submission date, download date, and error/warning counts.

  • The resource representation includes properties for content types, error/warning numbers, and sitemap metadata like path, type, and processing status.

  • A sitemap can contain various content types, including web pages, images, videos, news articles, mobile pages and Android/iOS apps.

  • You can manage sitemaps through dedicated methods to delete, retrieve information, list, and submit them.

For a list ofmethods for this resource, see the end of this page.

Resource representations

Sitemap

Contains detailed information about a specific URL submitted as asitemap.

{"path":string,"lastSubmitted":datetime,"isPending":boolean,"isSitemapsIndex":boolean,"type":string,"lastDownloaded":datetime,"warnings":long,"errors":long,"contents":[{"type":string,"submitted":long,"indexed":long}]}
Property nameValueDescriptionNotes
contents[]listThe various content types in the sitemap.
contents[].indexedN/ADeprecated; do not use.
contents[].submittedlongThe number of URLs in the sitemap (of the content type).
contents[].typestringThe specific type of content in this sitemap. For example:web.

Acceptable values are:
  • "androidApp"
  • "image"
  • "iosApp"
  • "mobile"
  • "news"
  • "pattern"
  • "video"
  • "web"
errorslongNumber of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
isPendingbooleanIf true, the sitemap has not been processed.
isSitemapsIndexbooleanIf true, the sitemap is a collection of sitemaps.
lastDownloadeddatetimeDate & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
lastSubmitteddatetimeDate & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
pathstringThe url of the sitemap.
typestringThe type of the sitemap. For example:rssFeed.

Acceptable values are:
  • "atomFeed"
  • "notSitemap"
  • "patternSitemap"
  • "rssFeed"
  • "sitemap"
  • "urlList"
warningslongNumber of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.

Methods

delete
Deletes a sitemap from this site.
get
Retrieves information about a specific sitemap.
list
Lists thesitemaps-entries submitted for this site, or included in the sitemap index file (ifsitemapIndex is specified in the request).
submit
Submits a sitemap for a site.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-07-23 UTC.