Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size: 1201 lines (34 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 22 classes

Google_Service_Webmasters:: (1 method):
  __construct()

Google_Service_Webmasters_Searchanalytics_Resource:: (1 method):
  query()

Google_Service_Webmasters_Sitemaps_Resource:: (4 methods):
  delete()
  get()
  listSitemaps()
  submit()

Google_Service_Webmasters_Sites_Resource:: (4 methods):
  add()
  delete()
  get()
  listSites()

Google_Service_Webmasters_Urlcrawlerrorscounts_Resource:: (1 method):
  query()

Google_Service_Webmasters_Urlcrawlerrorssamples_Resource:: (3 methods):
  get()
  listUrlcrawlerrorssamples()
  markAsFixed()

Google_Service_Webmasters_ApiDataRow:: (10 methods):
  setClicks()
  getClicks()
  setCtr()
  getCtr()
  setImpressions()
  getImpressions()
  setKeys()
  getKeys()
  setPosition()
  getPosition()

Google_Service_Webmasters_ApiDimensionFilter:: (6 methods):
  setDimension()
  getDimension()
  setExpression()
  getExpression()
  setOperator()
  getOperator()

Google_Service_Webmasters_ApiDimensionFilterGroup:: (4 methods):
  setFilters()
  getFilters()
  setGroupType()
  getGroupType()

Google_Service_Webmasters_SearchAnalyticsQueryRequest:: (14 methods):
  setAggregationType()
  getAggregationType()
  setDimensionFilterGroups()
  getDimensionFilterGroups()
  setDimensions()
  getDimensions()
  setEndDate()
  getEndDate()
  setRowLimit()
  getRowLimit()
  setSearchType()
  getSearchType()
  setStartDate()
  getStartDate()

Google_Service_Webmasters_SearchAnalyticsQueryResponse:: (4 methods):
  setResponseAggregationType()
  getResponseAggregationType()
  setRows()
  getRows()

Google_Service_Webmasters_SitemapsListResponse:: (2 methods):
  setSitemap()
  getSitemap()

Google_Service_Webmasters_SitesListResponse:: (2 methods):
  setSiteEntry()
  getSiteEntry()

Google_Service_Webmasters_UrlCrawlErrorCount:: (4 methods):
  setCount()
  getCount()
  setTimestamp()
  getTimestamp()

Google_Service_Webmasters_UrlCrawlErrorCountsPerType:: (6 methods):
  setCategory()
  getCategory()
  setEntries()
  getEntries()
  setPlatform()
  getPlatform()

Google_Service_Webmasters_UrlCrawlErrorsCountsQueryResponse:: (2 methods):
  setCountPerTypes()
  getCountPerTypes()

Google_Service_Webmasters_UrlCrawlErrorsSample:: (10 methods):
  setFirstDetected()
  getFirstDetected()
  setLastCrawled()
  getLastCrawled()
  setPageUrl()
  getPageUrl()
  setResponseCode()
  getResponseCode()
  setUrlDetails()
  getUrlDetails()

Google_Service_Webmasters_UrlCrawlErrorsSamplesListResponse:: (2 methods):
  setUrlCrawlErrorSample()
  getUrlCrawlErrorSample()

Google_Service_Webmasters_UrlSampleDetails:: (4 methods):
  setContainingSitemaps()
  getContainingSitemaps()
  setLinkedFromUrls()
  getLinkedFromUrls()

Google_Service_Webmasters_WmxSite:: (4 methods):
  setPermissionLevel()
  getPermissionLevel()
  setSiteUrl()
  getSiteUrl()

Google_Service_Webmasters_WmxSitemap:: (18 methods):
  setContents()
  getContents()
  setErrors()
  getErrors()
  setIsPending()
  getIsPending()
  setIsSitemapsIndex()
  getIsSitemapsIndex()
  setLastDownloaded()
  getLastDownloaded()
  setLastSubmitted()
  getLastSubmitted()
  setPath()
  getPath()
  setType()
  getType()
  setWarnings()
  getWarnings()

Google_Service_Webmasters_WmxSitemapContent:: (6 methods):
  setIndexed()
  getIndexed()
  setSubmitted()
  getSubmitted()
  setType()
  getType()


Class: Google_Service_Webmasters  - X-Ref

Service definition for Webmasters (v3).

<p>
Lets you view Google Webmaster Tools data for your verified sites.</p>

<p>
For more information about this service, see the API
<a href="https://developers.google.com/webmaster-tools/" target="_blank">Documentation</a>
</p>

__construct(Google_Client $client)   X-Ref
Constructs the internal representation of the Webmasters service.

param: Google_Client $client

Class: Google_Service_Webmasters_Searchanalytics_Resource  - X-Ref

The "searchanalytics" collection of methods.
Typical usage is:
<code>
$webmastersService = new Google_Service_Webmasters(...);
$searchanalytics = $webmastersService->searchanalytics;
</code>

query($siteUrl, Google_Service_Webmasters_SearchAnalyticsQueryRequest $postBody, $optParams = array()   X-Ref
Query your data with filters and parameters that you define. Returns zero or
more rows grouped by the row keys that you define. You must define a date
range of one or more days.

When date is one of the group by values, any days without data are omitted
from the result list. If you need to know which days have data, issue a broad
date range query grouped by date for any metric, and see which day rows are
returned. (searchanalytics.query)

param: string $siteUrl The site's URL, including protocol. For example:
param: Google_SearchAnalyticsQueryRequest $postBody
param: array $optParams Optional parameters.
return: Google_Service_Webmasters_SearchAnalyticsQueryResponse

Class: Google_Service_Webmasters_Sitemaps_Resource  - X-Ref

The "sitemaps" collection of methods.
Typical usage is:
<code>
$webmastersService = new Google_Service_Webmasters(...);
$sitemaps = $webmastersService->sitemaps;
</code>

delete($siteUrl, $feedpath, $optParams = array()   X-Ref
Deletes a sitemap from this site. (sitemaps.delete)

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

get($siteUrl, $feedpath, $optParams = array()   X-Ref
Retrieves information about a specific sitemap. (sitemaps.get)

param: string $siteUrl The site's URL, including protocol. For example:
param: string $feedpath The URL of the actual sitemap. For example:
param: array $optParams Optional parameters.
return: Google_Service_Webmasters_WmxSitemap

listSitemaps($siteUrl, $optParams = array()   X-Ref
Lists the sitemaps-entries submitted for this site, or included in the
sitemap index file (if sitemapIndex is specified in the request).
(sitemaps.listSitemaps)

param: string $siteUrl The site's URL, including protocol. For example:
param: array $optParams Optional parameters.
return: Google_Service_Webmasters_SitemapsListResponse

submit($siteUrl, $feedpath, $optParams = array()   X-Ref
Submits a sitemap for a site. (sitemaps.submit)

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

Class: Google_Service_Webmasters_Sites_Resource  - X-Ref

The "sites" collection of methods.
Typical usage is:
<code>
$webmastersService = new Google_Service_Webmasters(...);
$sites = $webmastersService->sites;
</code>

add($siteUrl, $optParams = array()   X-Ref
Adds a site to the set of the user's sites in Webmaster Tools. (sites.add)

param: string $siteUrl The URL of the site to add.
param: array $optParams Optional parameters.

delete($siteUrl, $optParams = array()   X-Ref
Removes a site from the set of the user's Webmaster Tools sites.
(sites.delete)

param: string $siteUrl The URI of the property as defined in Search Console.
param: array $optParams Optional parameters.

get($siteUrl, $optParams = array()   X-Ref
Retrieves information about specific site. (sites.get)

param: string $siteUrl The URI of the property as defined in Search Console.
param: array $optParams Optional parameters.
return: Google_Service_Webmasters_WmxSite

listSites($optParams = array()   X-Ref
Lists the user's Webmaster Tools sites. (sites.listSites)

param: array $optParams Optional parameters.
return: Google_Service_Webmasters_SitesListResponse

Class: Google_Service_Webmasters_Urlcrawlerrorscounts_Resource  - X-Ref

The "urlcrawlerrorscounts" collection of methods.
Typical usage is:
<code>
$webmastersService = new Google_Service_Webmasters(...);
$urlcrawlerrorscounts = $webmastersService->urlcrawlerrorscounts;
</code>

query($siteUrl, $optParams = array()   X-Ref
Retrieves a time series of the number of URL crawl errors per error category
and platform. (urlcrawlerrorscounts.query)

param: string $siteUrl The site's URL, including protocol. For example:
param: array $optParams Optional parameters.
return: Google_Service_Webmasters_UrlCrawlErrorsCountsQueryResponse

Class: Google_Service_Webmasters_Urlcrawlerrorssamples_Resource  - X-Ref

The "urlcrawlerrorssamples" collection of methods.
Typical usage is:
<code>
$webmastersService = new Google_Service_Webmasters(...);
$urlcrawlerrorssamples = $webmastersService->urlcrawlerrorssamples;
</code>

get($siteUrl, $url, $category, $platform, $optParams = array()   X-Ref
Retrieves details about crawl errors for a site's sample URL.
(urlcrawlerrorssamples.get)

param: string $siteUrl The site's URL, including protocol. For example:
param: string $url The relative path (without the site) of the sample URL. It
param: string $category The crawl error category. For example:
param: string $platform The user agent type (platform) that made the request.
param: array $optParams Optional parameters.
return: Google_Service_Webmasters_UrlCrawlErrorsSample

listUrlcrawlerrorssamples($siteUrl, $category, $platform, $optParams = array()   X-Ref
Lists a site's sample URLs for the specified crawl error category and
platform. (urlcrawlerrorssamples.listUrlcrawlerrorssamples)

param: string $siteUrl The site's URL, including protocol. For example:
param: string $category The crawl error category. For example:
param: string $platform The user agent type (platform) that made the request.
param: array $optParams Optional parameters.
return: Google_Service_Webmasters_UrlCrawlErrorsSamplesListResponse

markAsFixed($siteUrl, $url, $category, $platform, $optParams = array()   X-Ref
Marks the provided site's sample URL as fixed, and removes it from the
samples list. (urlcrawlerrorssamples.markAsFixed)

param: string $siteUrl The site's URL, including protocol. For example:
param: string $url The relative path (without the site) of the sample URL. It
param: string $category The crawl error category. For example:
param: string $platform The user agent type (platform) that made the request.
param: array $optParams Optional parameters.

Class: Google_Service_Webmasters_ApiDataRow  - X-Ref

setClicks($clicks)   X-Ref
No description

getClicks()   X-Ref
No description

setCtr($ctr)   X-Ref
No description

getCtr()   X-Ref
No description

setImpressions($impressions)   X-Ref
No description

getImpressions()   X-Ref
No description

setKeys($keys)   X-Ref
No description

getKeys()   X-Ref
No description

setPosition($position)   X-Ref
No description

getPosition()   X-Ref
No description

Class: Google_Service_Webmasters_ApiDimensionFilter  - X-Ref

setDimension($dimension)   X-Ref
No description

getDimension()   X-Ref
No description

setExpression($expression)   X-Ref
No description

getExpression()   X-Ref
No description

setOperator($operator)   X-Ref
No description

getOperator()   X-Ref
No description

Class: Google_Service_Webmasters_ApiDimensionFilterGroup  - X-Ref

setFilters($filters)   X-Ref
No description

getFilters()   X-Ref
No description

setGroupType($groupType)   X-Ref
No description

getGroupType()   X-Ref
No description

Class: Google_Service_Webmasters_SearchAnalyticsQueryRequest  - X-Ref

setAggregationType($aggregationType)   X-Ref
No description

getAggregationType()   X-Ref
No description

setDimensionFilterGroups($dimensionFilterGroups)   X-Ref
No description

getDimensionFilterGroups()   X-Ref
No description

setDimensions($dimensions)   X-Ref
No description

getDimensions()   X-Ref
No description

setEndDate($endDate)   X-Ref
No description

getEndDate()   X-Ref
No description

setRowLimit($rowLimit)   X-Ref
No description

getRowLimit()   X-Ref
No description

setSearchType($searchType)   X-Ref
No description

getSearchType()   X-Ref
No description

setStartDate($startDate)   X-Ref
No description

getStartDate()   X-Ref
No description

Class: Google_Service_Webmasters_SitemapsListResponse  - X-Ref

setSitemap($sitemap)   X-Ref
No description

getSitemap()   X-Ref
No description

Class: Google_Service_Webmasters_UrlCrawlErrorCount  - X-Ref

setCount($count)   X-Ref
No description

getCount()   X-Ref
No description

setTimestamp($timestamp)   X-Ref
No description

getTimestamp()   X-Ref
No description

Class: Google_Service_Webmasters_UrlCrawlErrorCountsPerType  - X-Ref

setCategory($category)   X-Ref
No description

getCategory()   X-Ref
No description

setEntries($entries)   X-Ref
No description

getEntries()   X-Ref
No description

setPlatform($platform)   X-Ref
No description

getPlatform()   X-Ref
No description

Class: Google_Service_Webmasters_UrlCrawlErrorsSample  - X-Ref

setFirstDetected($firstDetected)   X-Ref
No description

getFirstDetected()   X-Ref
No description

setLastCrawled($lastCrawled)   X-Ref
No description

getLastCrawled()   X-Ref
No description

setPageUrl($pageUrl)   X-Ref
No description

getPageUrl()   X-Ref
No description

setResponseCode($responseCode)   X-Ref
No description

getResponseCode()   X-Ref
No description

setUrlDetails(Google_Service_Webmasters_UrlSampleDetails $urlDetails)   X-Ref
No description

getUrlDetails()   X-Ref
No description

Class: Google_Service_Webmasters_WmxSite  - X-Ref

setPermissionLevel($permissionLevel)   X-Ref
No description

getPermissionLevel()   X-Ref
No description

setSiteUrl($siteUrl)   X-Ref
No description

getSiteUrl()   X-Ref
No description

Class: Google_Service_Webmasters_WmxSitemap  - X-Ref

setContents($contents)   X-Ref
No description

getContents()   X-Ref
No description

setErrors($errors)   X-Ref
No description

getErrors()   X-Ref
No description

setIsPending($isPending)   X-Ref
No description

getIsPending()   X-Ref
No description

setIsSitemapsIndex($isSitemapsIndex)   X-Ref
No description

getIsSitemapsIndex()   X-Ref
No description

setLastDownloaded($lastDownloaded)   X-Ref
No description

getLastDownloaded()   X-Ref
No description

setLastSubmitted($lastSubmitted)   X-Ref
No description

getLastSubmitted()   X-Ref
No description

setPath($path)   X-Ref
No description

getPath()   X-Ref
No description

setType($type)   X-Ref
No description

getType()   X-Ref
No description

setWarnings($warnings)   X-Ref
No description

getWarnings()   X-Ref
No description

Class: Google_Service_Webmasters_WmxSitemapContent  - X-Ref

setIndexed($indexed)   X-Ref
No description

getIndexed()   X-Ref
No description

setSubmitted($submitted)   X-Ref
No description

getSubmitted()   X-Ref
No description

setType($type)   X-Ref
No description

getType()   X-Ref
No description