Documentation

Google_Service_Webmasters_Resource_Sitemaps extends Google_Service_Resource
in package

The "sitemaps" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes a sitemap from this site. (sitemaps.delete)
get()  : Google_Service_Webmasters_WmxSitemap
Retrieves information about a specific sitemap. (sitemaps.get)
listSitemaps()  : Google_Service_Webmasters_SitemapsListResponse
Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
submit()  : mixed
Submits a sitemap for a site. (sitemaps.submit)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a sitemap from this site. (sitemaps.delete)

public delete(string $siteUrl, string $feedpath[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$siteUrl : string

The site's URL, including protocol. For example: http://www.example.com/

$feedpath : string

The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

get()

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

public get(string $siteUrl, string $feedpath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Webmasters_WmxSitemap
Parameters
$siteUrl : string

The site's URL, including protocol. For example: http://www.example.com/

$feedpath : string

The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Webmasters_WmxSitemap —

listSitemaps()

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

public listSitemaps(string $siteUrl[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Webmasters_SitemapsListResponse

(sitemaps.listSitemaps)

Parameters
$siteUrl : string

The site's URL, including protocol. For example: http://www.example.com/

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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()

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

public submit(string $siteUrl, string $feedpath[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$siteUrl : string

The site's URL, including protocol. For example: http://www.example.com/

$feedpath : string

The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results