Sitemaps: list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
需要授权
列出为该网站提交的或包含在站点地图索引文件中(如果在请求中指定了 sitemapIndex
)的 sitemaps-entries。
立即试用。
请求
HTTP 请求
GET https://www.googleapis.com/webmasters/v3/sites/siteUrl/sitemaps
参数
url
参数名称 |
值 | 说明 |
路径参数 |
siteUrl |
string |
Search Console 中定义的资源网址。例如:
http://www.example.com/
(网址前缀资源),
或 sc-domain:example.com
(网域资源)。
|
可选的查询参数 |
sitemapIndex |
string |
网站的站点地图索引的网址。例如:http://www.example.com/sitemapindex.xml
|
授权
此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。
范围 |
https://www.googleapis.com/auth/webmasters.readonly |
https://www.googleapis.com/auth/webmasters |
请求正文
使用此方法时请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
试试看!
使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-08-29。
[null,null,["最后更新时间 (UTC):2024-08-29。"],[[["\u003cp\u003eLists sitemaps submitted for a site, including those in the sitemap index file.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific scopes for access.\u003c/p\u003e\n"],["\u003cp\u003eEmploys a simple GET request with optional parameters for filtering.\u003c/p\u003e\n"],["\u003cp\u003eResponse provides detailed information about each submitted sitemap.\u003c/p\u003e\n"],["\u003cp\u003eAllows users to try the API call directly using the provided explorer tool.\u003c/p\u003e\n"]]],["This API endpoint retrieves a list of sitemap entries for a specified site. The request, using `GET`, requires the `siteUrl` path parameter, which is the site's URL as defined in Search Console. Optionally, it takes a `sitemapIndex` query parameter to list entries within a specific sitemap index. Authorization is necessary using `webmasters.readonly` or `webmasters` scopes. A successful response returns a list of sitemap resources, each detailing a submitted URL. No request body is needed.\n"],null,["# Sitemaps: list\n\n**Requires [authorization](#auth)**\n\nLists 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[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/webmasters/v3/sites/siteUrl/sitemaps\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `siteUrl` | `string` | The URL of the property as defined in Search Console. For example: `http://www.example.com/` ([URL-prefix](https://support.google.com/webmasters/answer/34592#url_prefix_prop_tips) property), or `sc-domain:example.com` ([Domain](https://support.google.com/webmasters/answer/34592#domain_property) property). |\n| **Optional query parameters** |||\n| `sitemapIndex` | `string` | A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml` |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/webmaster-tools/v1/how-tos/authorizing)).\n\n| Scope |\n|-------------------------------------------------------|\n| `https://www.googleapis.com/auth/webmasters.readonly` |\n| `https://www.googleapis.com/auth/webmasters` |\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"sitemap\": [\n sitemaps Resource\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|---------------|--------|-----------------------------------------------------------------------------------------------------------------------------------|-------|\n| `sitemap[]` | `list` | Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184). | |\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]