Sitemaps: list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
需要授權
列出為這個網站提交的 sitemaps-entries,或是包含在 Sitemap 索引檔案中 (如果在要求中指定了 sitemapIndex
)。
立即試用。
要求
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 |
網站 Sitemap 索引的網址。例如:http://www.example.com/sitemapindex.xml
|
授權
這項要求需要至少擁有下列其中一個範圍的授權 (進一步瞭解驗證和授權)。
範圍 |
https://www.googleapis.com/auth/webmasters.readonly |
https://www.googleapis.com/auth/webmasters |
要求主體
請勿使用這個方法提供請求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
試試看!
使用下方的 APIs Explorer,針對即時資料呼叫這個方法,看看會有什麼結果。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-08-24 (世界標準時間)。
[null,null,["上次更新時間:2024-08-24 (世界標準時間)。"],[[["\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."]]