1. class
  2. Google
  3. \
  4. Service
  5. \
  6. SearchConsole
  7. \
  8. Resource
  9. \
  10. Sitemaps

Sitemaps

class Sitemaps extends Resource (View source)

The "sitemaps" collection of methods.

Typical usage is:

 $searchconsoleService = new Google\Service\SearchConsole(...);
 $sitemaps = $searchconsoleService->sitemaps;

Methods

delete(string $siteUrl, string $feedpath, array $optParams = [])

Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap. (sitemaps.delete)

WmxSitemap
get(string $siteUrl, string $feedpath, array $optParams = [])

Retrieves information about a specific sitemap. (sitemaps.get)

SitemapsListResponse
listSitemaps(string $siteUrl, array $optParams = [])

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

submit(string $siteUrl, string $feedpath, array $optParams = [])

Submits a sitemap for a site. (sitemaps.submit)

Details

at line 45
delete(string $siteUrl, string $feedpath, array $optParams = [])

Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap. (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.

Exceptions

Exception

at line 62
WmxSitemap get(string $siteUrl, string $feedpath, array $optParams = [])

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 Value

WmxSitemap

Exceptions

Exception

at line 82
SitemapsListResponse listSitemaps(string $siteUrl, array $optParams = [])

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.

Return Value

SitemapsListResponse

Exceptions

Exception

at line 98
submit(string $siteUrl, string $feedpath, array $optParams = [])

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 actual sitemap. For example: http://www.example.com/sitemap.xml.
array $optParams

Optional parameters.

Exceptions

Exception