Sitemaps: list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
認証が必要です
そのサイトに関して送信された sitemaps-entries またはサイトマップ インデックス ファイル(リクエストで sitemapIndex
が指定されている場合)のリストを取得します。
こちらから今すぐお試しください。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/webmasters/v3/sites/siteUrl/sitemaps
パラメータ
url
パラメータ名 |
値 | 説明 |
パスパラメータ |
siteUrl |
string |
Search Console で定義されているプロパティの URL。次に例を示します。
http://www.example.com/
(URL プレフィックスプロパティ)
または sc-domain:example.com
(ドメイン プロパティ)。
|
省略可能なクエリ パラメータ |
sitemapIndex |
string |
サイトのサイトマップ インデックスの URL。例: http://www.example.com/sitemapindex.xml
|
承認
このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です(認証と承認の詳細をご確認ください)。
スコープ |
https://www.googleapis.com/auth/webmasters.readonly |
https://www.googleapis.com/auth/webmasters |
リクエスト本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-08-26 UTC。
[null,null,["最終更新日 2024-08-26 UTC。"],[[["\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."]]