Sitemaps: get

  • Retrieves data for a specified sitemap using its URL and the site's URL as registered in Google Search Console.

  • Requires authorization with either https://www.googleapis.com/auth/webmasters.readonly or https://www.googleapis.com/auth/webmasters scope.

  • Uses an HTTP GET request with feedpath and siteUrl as path parameters.

  • Returns a Sitemaps resource with information about the requested sitemap if successful.

Requires authorization

Retrieves information about a specific sitemap. Try it now.

Request

HTTP request

GET https://www.googleapis.com/webmasters/v3/sites/siteUrl/sitemaps/feedpath

Parameters

Parameter name Value Description
Path parameters
feedpath string The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
siteUrl string The URL of the property as defined in Search Console. For example: http://www.example.com/ (URL-prefix property), or sc-domain:example.com (Domain property).

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/webmasters.readonly
https://www.googleapis.com/auth/webmasters

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Sitemaps resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

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.