Google_Service_Webmasters_Sitemaps_Resource Class Reference

The "sitemaps" collection of methods. More...

Inheritance diagram for Google_Service_Webmasters_Sitemaps_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($siteUrl, $feedpath, $optParams=array())
	Deletes a sitemap from this site.
	get ($siteUrl, $feedpath, $optParams=array())
	Retrieves information about a specific sitemap.
	listSitemaps ($siteUrl, $optParams=array())
	Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
	submit ($siteUrl, $feedpath, $optParams=array())
	Submits a sitemap for a site.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "sitemaps" collection of methods.

Typical usage is: $webmastersService = new Google_Service_Webmasters(...); $sitemaps = $webmastersService->sitemaps;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

delete()

Google_Service_Webmasters_Sitemaps_Resource::delete	(		$siteUrl,
			$feedpath,
			$optParams = array() )

Deletes a sitemap from this site.

(sitemaps.delete)

Parameters

string	$siteUrl	The site's URL, including protocol. For example: http://www.example.com/
string	$feedpath	The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
array	$optParams	Optional parameters.

get()

Google_Service_Webmasters_Sitemaps_Resource::get	(		$siteUrl,
			$feedpath,
			$optParams = array() )

Retrieves information about a specific sitemap.

(sitemaps.get)

Parameters

string	$siteUrl	The site's URL, including protocol. For example: http://www.example.com/
string	$feedpath	The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
array	$optParams	Optional parameters.

Return values

Google_Service_Webmasters_WmxSitemap

listSitemaps()

Google_Service_Webmasters_Sitemaps_Resource::listSitemaps	(		$siteUrl,
			$optParams = array() )

Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).

(sitemaps.listSitemaps)

Parameters

string	$siteUrl	The site's URL, including protocol. For example: http://www.example.com/
array	$optParams	Optional parameters.

@opt_param string sitemapIndex A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml

Return values

Google_Service_Webmasters_SitemapsListResponse

submit()

Google_Service_Webmasters_Sitemaps_Resource::submit	(		$siteUrl,
			$feedpath,
			$optParams = array() )

Submits a sitemap for a site.

(sitemaps.submit)

Parameters

string	$siteUrl	The site's URL, including protocol. For example: http://www.example.com/
string	$feedpath	The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml
array	$optParams	Optional parameters.

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Webmasters.php