Documentation

Google_Service_SearchConsole_Resource_Sites extends Google_Service_Resource
in package

The "sites" collection of methods.

Typical usage is: $searchconsoleService = new Google_Service_SearchConsole(...); $sites = $searchconsoleService->sites;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
add()  : mixed
Adds a site to the set of the user's sites in Search Console. (sites.add)
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
Removes a site from the set of the user's Search Console sites.
get()  : Google_Service_SearchConsole_WmxSite
Retrieves information about specific site. (sites.get)
listSites()  : Google_Service_SearchConsole_SitesListResponse
Lists the user's Search Console sites. (sites.listSites)
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 —

add()

Adds a site to the set of the user's sites in Search Console. (sites.add)

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

The URL of the site to add.

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

Optional parameters.

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

Removes a site from the set of the user's Search Console sites.

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

(sites.delete)

Parameters
$siteUrl : string

The URI of the property as defined in Search Console. Examples: http://www.example.com/ or sc-domain:example.com.

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

Optional parameters.

Return values
mixed —

get()

Retrieves information about specific site. (sites.get)

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

The URI of the property as defined in Search Console. Examples: http://www.example.com/ or sc-domain:example.com.

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

Optional parameters.

Return values
Google_Service_SearchConsole_WmxSite —

convertToArrayAndStripNulls()

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

Search results