Webmaster Tools

Reference Guide

This document provides detailed reference information for the Webmaster Tools Data API.

Audience

This document is intended for programmers who want to write client applications that can interact with Google Webmaster Tools.

It's a reference document; it assumes you understand the concepts presented in the developer's guide, and the general ideas behind the Google Data APIs protocol and Sitemaps.

Contents

  1. Audience
  2. Webmaster Tools feeds
    1. Sites feed
    2. Keywords feed
    3. Sitemaps feed
    4. Messages feed
    5. Crawl Issues feed
  3. Webmaster Tools element reference
    1. Sites feed
    2. Keywords feed
    3. Sitemaps feed
    4. Messages feed
    5. Crawl Issues feed
  4. Webmaster Tools Schema Reference

Webmaster Tools feeds

The Webmaster Tools Data API currently provides the following representations of Webmaster Tools data:

Description
Feed ID
URL
Site data sites https://www.google.com/webmasters/tools/feeds/sites/
Keyword data keywords https://www.google.com/webmasters/tools/feeds/keywords/
Sitemaps data sitemaps siteID/sitemaps" target="_top">https://www.google.com/webmasters/tools/feeds/siteID/sitemaps/
Message Center messages data messages https://www.google.com/webmasters/tools/feeds/messages/
Crawl Errors feed crawlissues https://www.google.com/webmasters/tools/feeds/siteID/crawlissues/

Sites feed

The Sites feed lists sites in an authenticated user account:

https://www.google.com/webmasters/tools/feeds/sites/

To access individual entries, add the SiteID, which is your site URL encoded using URL encoding:

https://www.google.com/webmasters/tools/feeds/sites/SiteID/

For example, to access entries for the site http://www.example.com/, use the following URL:

https://www.google.com/webmasters/tools/feeds/sites/http%3A%2F%2Fwww%2Eexample%2Ecom%2F

Keywords feed

The Keywords feed represents a snapshot of how Google sees your site. It lists keywords found on your site (internal) as well as in the anchor text of external links to your site:

https://www.google.com/webmasters/tools/feeds/keywords/

To retrieve the Keywords feed, add the SiteID, which is your site URL encoded using URL encoding:

https://www.google.com/webmasters/tools/feeds/http%3A%2F%2Fwww%2Eexample%2Ecom%2F/keywords/

Sitemaps feed

The Sitemaps feed lists the Sitemaps sbumitted for a specified site in an authenticated user account:

https://www.google.com/webmasters/tools/feeds/siteID/sitemaps/

For example, to view a list of Sitemaps for the site http://www.example.com/, add your SiteID, which is your site URL encoded using URL encoding:

https://www.google.com/webmasters/tools/feeds/http%3A%2F%2Fwww%2Eexample%2Ecom%2F/sitemaps/

To access an individual Sitemap entry, you need to specify both SiteID and SitemapID. The SitemapID is the full Sitemap URL encoded using URL encoding. For example, to access an entry (in this example, http://www.example.com/sitemap.xml) submitted for the site http://www.example.com, use the following URL:

https://www.google.com/webmasters/tools/feeds/http%3A%2F%2Fwww%2Eexample%2Ecom%2F/sitemaps/
  http%3A%2F%2Fwww%2Eexample%2Ecom%2Fsitemap%2Exml/ 

Messages feed

The Messages feed lists the messages that the user has received via the Message Center in Google Webmaster Tools:

https://www.google.com/webmasters/tools/feeds/messages/

To access individual messages, add the MessageID, which is the the URL of the message encoded using URL encoding, plus the token that identifies each message:

https://www.google.com/webmasters/tools/feeds/messages/messageID/

For example, to view a message with the ID AB9YKzKy-cxuP3jKPovozsi1ZQ6iFz5RJjMNlXxkVvVklU_dJ58iz5xG2bJPH3V-xaHPSrz1cvBCGpJ99Gn5KwVKnksi6iXZSA, use the following URL:

https://www.google.com/webmasters/tools/feeds/messages/http%3A%2F%2F
www%2Eegoogle%2Ecom%2Fwebmasters%2Ftools%2Ffeeds%2Fmessages%2FAB9YKzKy-cxuP3jKPovozsi1ZQ6iFz5RJjMNlXxkVvVklU_dJ5
8iz5xG2bJPH3V-xaHPSrz1cvBCGpJ99Gn5KwVKnksi6iXZSA

Crawl feed

The Crawl Issues feed lists issues that Googlebot found when crawling your verified site:

https://www.google.com/webmasters/tools/feeds/crawlissues/

To retrieve the Crawl Issues feed, add the SiteID, which is your site URL encoded using URL encoding:

https://www.google.com/webmasters/tools/feeds/http%3A%2F%2Fwww%2Eexample%2Ecom%2F/crawlissues/

Webmaster Tools elements reference

For information about the elements used in Google Data APIs, see the Atom specification and the Google extensions.

In addition to these standard elements, the Webmaster Tools Data API uses the wt namespace for extension elements. The schema URL for the wt namespace is http://schemas.google.com/webmasters/tools/2007. Elements and attributes in the wt namespace are used to describe properties of sites and associated Sitemaps.

Sites feed

wt:crawl-rate

Indicates the desired crawl rate (the time Google will spend crawling your site). Accepted values are normal, slower, and faster. Some of the values may not be available for a particular site. More information about crawl rate.

Example
<wt:crawl-rate>slower</wt:crawl-rate>

wt:geolocation

Indicates the country or region associated with the website. Note that the values must be one of the accepted country codes. Only sites with a geographically neutral top-level domain (such as .com, .net, .edu, or .gov) can be associated with a location. Sites with country-specific domains, such as www.google.ie, are already associated with a geographic location. More information about setting a geographic target.

Example
<wt:geolocation>FR</wt:geolocation>

wt:preferred-domain

Indicates the domain you would like used to index your pages. If the value is none, Google will treat www.example.com and http://example.com as different sites. If the value is preferwww, we'll treat http://example.com as if it were http://www.example.com. If the value is prefernowww, we'll treat www.example.com as if it were http://example.com. More information about setting your preferred domain.

Example
<wt:preferred-domain>preferwww</wt:preferred-domain>

wt:verification-method

Indicates the verification method (HTML file or meta tag) used to verify ownership of the site. Each site entry in the Sites feed will have two <wt:verification-method> elements, one for each verification method.

Attributes
type The type of verification. Can be either htmlpage or metatag.
file-content The file content for HTML file verification.
in-use Deprecated.
Example
<wt:verification-method type="metatag" in-use="false"><meta name="google-site-verification" content="a2Ai" /></wt:verification-method>
<wt:verification-method type="htmlpage" in-use="true" file-content="google-site-verification: 456456-google.html">456456-google.html</wt:verification-method>

wt:verified

Boolean value (xs:boolean) indicating whether the site ownership has been verified by one of the two accepted verification methods (uploading an HTML page with a specified filename and content, or adding a specified meta tag to the site's home page). More information about site verification.

Example
<wt:verified>false</verified>
<wt:date>2008-09-18T20:49:57.108</wt:date>

Keywords feed

wt:keyword

Lists a keyword

Attributes
source Indicates whether Google found the keyword in the content of your own site or in the anchor text of external links to your site. Can be either internal or external.
Example
<wt:keyword>true source='internal'></wt:keyword>

Sitemaps feed

mobile:mobile

The <mobile:mobile/> element indicates a Mobile Sitemap. More information about Mobile Sitemaps.

Example
<mobile:mobile/>

wt:sitemap-last-downloaded

Indicates the most recent date the Sitemap was downloaded by Google. The date format is YYYY-M-DT00:00:00.000Z, as specified in RFC 3399.

Example
<wt:sitemap-last-downloaded>2006-11-18T19:27:32.543Z</wt:sitemap-last-downloaded>

wt:sitemap-mobile

The <wt:sitemap-mobile> element contains a list of <wt:markup-language> elements, specifying the acceptable values (HTML, WML, and CHTML) for the <wt:sitemap-mobile-markup-language> element required when submitting a Mobile Sitemap. More information about Mobile Sitemaps.

Example
<wt:sitemap-mobile>
<wt:markup-language>HTML</wt:markup-language> </wt:sitemap-mobile>

wt:sitemap-mobile-markup-language

The <wt:sitemap-mobile-markup-language> specifies the markup language. Acceptable values (HTML, WML, and CHTML) are listed in the <wt:sitemap-mobile> element of the Sitemap feed.

Example
<wt:sitemap-mobile-markup-language>HTML</wt:sitemap-mobile-markup-language>

wt:sitemap-news

The <wt:sitemap-news> element contains a list of <wt:publication-label> elements specifying the acceptable values (in the example below, Publication1) for the <wt:sitemap-news-publication-label> element required when submitting a News Sitemap. More information about News Sitemaps.

Example
<wt:sitemap-news>
<wt:publication-label>Publication1</wt:publication-label> </wt:sitemap-news>

wt:sitemap-news-publication-label

Specifies the publication label. Allowed values are listed in the <wt:sitemap-news> element of the Sitemap feed.

Example
<wt:sitemap-news-publication-label>Irish Times</wt:sitemap-news-publication-label> 

wt:sitemap-type

Indicates the type of Sitemap. Allowed values include WEB, VIDEO, or CODE. It is not used when submitting News or Mobile Sitemaps.

Example
<wt:sitemap-type>WEB</wt:sitemap-type>

wt:sitemap-url-count

Indicates the number of URLs contained in the Sitemap.

Example
<wt:sitemap-url-count>126</wt:sitemap-url-count>

Messages feed

wt:body

Lists the body of the message sent to the Message Center in Webmaster Tools.

Example
<wt:body body='We've received a request from a site owner to change the
rate at which Googlebot crawls this site: http://www.example.com/  - Old crawl
rate: Slower  - New crawl rate: Normal  This new crawl rate will stay in effect
for 90 days.  A faster crawl will enable us to crawl your site more quickly,
but may put more load on your server. If you find that this is the case, you
can change the crawl rate again:  1. On the Dashboard, select the site you want.
2. On the Dashboard, under Tools, click Crawl rate.  '></wt:body>

wt:date

Indicates the date in which the message was sent to the Message Center in Webmaster Tools. This may not be the same as the updated value for the entry.

Example

wt:language

Indicates the language of the message subject and body. Must be one of two-character language codes described in ISO 639-2. Supported languages.

Example
<wt:language language='en'></wt:language>

wt:read

Indicates whether the message has been marked as read. Possible values are true and false.

Example
<wt:read>true</wt:read>

wt:subject

Lists the subject of the message sent to the Message Center in Webmaster Tools.

Example
<wt:subject subject='Crawl rate change request for http://www.example.com/'>

Crawl Issues feed

wt:crawl-type

Indicates the type of crawl. Allowed values include:

  • web-crawl
  • mobile-crawl-CHTML
  • mobile-operator-crawl
  • mobile-xHTML-WML-crawl
  • news-crawl

Not all crawl types will be available for all sites. For example, news-crawl issues are available only for sites included in the Google News index.

Example
<crawl-type>web-crawl</crawl-type>

wt:issue-type

The issue-type element indicates the type of issue found when crawling your site. Possible values include:

  • http-error
  • in-sitemap
  • news-error
  • not-followed
  • not-found
  • restricted-robots-txt
  • timed-out
  • unreachable
Example
<issue-type>http-error</issue-type>

wt:issue-detail

The detail element indicates the type of issue found when crawling your site. Allowed values include, but are not limited to:

  • 4xx error
  • 404 (Not found)
  • DNS lookup timeout
  • Domain name not found
  • Failed to connect
  • Network unreachable
  • Redirect error
  • URL restricted by robots.txt

Not all errors may be actual problems. For example, you may have chosen to deliberately block crawlers from some pages. If that's the case, there's no need to address URLs restricted by robots.txt errors for these pages. More information about HTTP status codes.

Example:
<detail>404 (Not found)</detail>

wt:linked-from

Indicates the URL on which the problem link was found.

Example:
<linked-from>http://www.example.com/recipes/bread.html</linked-from>

wt:date-detected

The date the crawl issue was first detected.

Example:
  <e-detected>2008-11-17T01:06:10.000<date-detected>

Webmaster Tools Schema Reference

  1. Messages Feed
  2. Sitemaps Feed
  3. Sites Feed

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.