Sitemaps
Stay organized with collections
Save and categorize content based on your preferences.
For a list of methods for this resource, see the end of this page.
Resource representations
Sitemap
Contains detailed information about a specific URL submitted as a sitemap.
{
"path": string,
"lastSubmitted": datetime,
"isPending": boolean,
"isSitemapsIndex": boolean,
"type": string,
"lastDownloaded": datetime,
"warnings": long,
"errors": long,
"contents": [
{
"type": string,
"submitted": long,
"indexed": long
}
]
}
| Property name |
Value |
Description |
Notes |
contents[] |
list |
The various content types in the sitemap. |
|
contents[].indexed |
N/A |
Deprecated; do not use. |
|
contents[].submitted |
long |
The number of URLs in the sitemap (of the content type). |
|
contents[].type |
string |
The specific type of content in this sitemap. For example: web.
Acceptable values are:
- "
androidApp"
- "
image"
- "
iosApp"
- "
mobile"
- "
news"
- "
pattern"
- "
video"
- "
web"
|
|
errors |
long |
Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly. |
|
isPending |
boolean |
If true, the sitemap has not been processed. |
|
isSitemapsIndex |
boolean |
If true, the sitemap is a collection of sitemaps. |
|
lastDownloaded |
datetime |
Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd). |
|
lastSubmitted |
datetime |
Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd). |
|
path |
string |
The url of the sitemap. |
|
type |
string |
The type of the sitemap. For example: rssFeed.
Acceptable values are:
- "
atomFeed"
- "
notSitemap"
- "
patternSitemap"
- "
rssFeed"
- "
sitemap"
- "
urlList"
|
|
warnings |
long |
Number 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 the sitemaps-entries submitted for this site, or included in the sitemap index file (if
sitemapIndex is specified in the request).
- submit
- Submits a sitemap for a site.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-23 UTC.
[null,null,["Last updated 2024-07-23 UTC."],[[["\u003cp\u003eThe Sitemap resource provides detailed information about URLs submitted through a sitemap file, including submission date, download date, and error/warning counts.\u003c/p\u003e\n"],["\u003cp\u003eThe resource representation includes properties for content types, error/warning numbers, and sitemap metadata like path, type, and processing status.\u003c/p\u003e\n"],["\u003cp\u003eA sitemap can contain various content types, including web pages, images, videos, news articles, mobile pages and Android/iOS apps.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage sitemaps through dedicated methods to delete, retrieve information, list, and submit them.\u003c/p\u003e\n"]]],["This resource provides details about a submitted sitemap, including its `path`, `lastSubmitted` and `lastDownloaded` dates, and whether it's `isPending` or an `isSitemapsIndex`. It lists `contents` with types like `web`, `image`, or `video`, and the number of `submitted` URLs per type. It also reports `errors` and `warnings`. Key actions include the ability to `delete`, `get`, `list`, or `submit` a sitemap.\n"],null,["# Sitemaps\n\n\u003cbr /\u003e\n\nFor a list of [methods](#methods) for this resource, see the end of this page.\n\nResource representations\n------------------------\n\n### Sitemap\n\nContains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).\n\n```gdscript\n{\n \"path\": string,\n \"lastSubmitted\": datetime,\n \"isPending\": boolean,\n \"isSitemapsIndex\": boolean,\n \"type\": string,\n \"lastDownloaded\": datetime,\n \"warnings\": long,\n \"errors\": long,\n \"contents\": [\n {\n \"type\": string,\n \"submitted\": long,\n \"indexed\": long\n }\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `contents[]` | `list` | The various content types in the sitemap. | |\n| contents[].`indexed` | `N/A` | *Deprecated; do not use.* | |\n| contents[].`submitted` | `long` | The number of URLs in the sitemap (of the content type). | |\n| contents[].`type` | `string` | The specific type of content in this sitemap. For example: `web`. \u003cbr /\u003e Acceptable values are: - \"`androidApp`\" - \"`image`\" - \"`iosApp`\" - \"`mobile`\" - \"`news`\" - \"`pattern`\" - \"`video`\" - \"`web`\" | |\n| `errors` | `long` | Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly. | |\n| `isPending` | `boolean` | If true, the sitemap has not been processed. | |\n| `isSitemapsIndex` | `boolean` | If true, the sitemap is a collection of sitemaps. | |\n| `lastDownloaded` | `datetime` | Date \\& time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd). | |\n| `lastSubmitted` | `datetime` | Date \\& time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd). | |\n| `path` | `string` | The url of the sitemap. | |\n| `type` | `string` | The type of the sitemap. For example: `rssFeed`. \u003cbr /\u003e Acceptable values are: - \"`atomFeed`\" - \"`notSitemap`\" - \"`patternSitemap`\" - \"`rssFeed`\" - \"`sitemap`\" - \"`urlList`\" | |\n| `warnings` | `long` | Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps. | |\n\nMethods\n-------\n\n[delete](/webmaster-tools/v1/sitemaps/delete)\n: Deletes a sitemap from this site.\n\n[get](/webmaster-tools/v1/sitemaps/get)\n: Retrieves information about a specific sitemap.\n\n[list](/webmaster-tools/v1/sitemaps/list)\n: Lists the [sitemaps-entries](/webmaster-tools/v1/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).\n\n[submit](/webmaster-tools/v1/sitemaps/submit)\n: Submits a sitemap for a site."]]
