Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Webmasters_Urlcrawlerrorssamples_Resource Class Reference

The "urlcrawlerrorssamples" collection of methods. More...

Inheritance diagram for Google_Service_Webmasters_Urlcrawlerrorssamples_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($siteUrl, $url, $category, $platform, $optParams=array())
 Retrieves details about crawl errors for a site's sample URL.
 
 listUrlcrawlerrorssamples ($siteUrl, $category, $platform, $optParams=array())
 Lists a site's sample URLs for the specified crawl error category and platform.
 
 markAsFixed ($siteUrl, $url, $category, $platform, $optParams=array())
 Marks the provided site's sample URL as fixed, and removes it from the samples list.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "urlcrawlerrorssamples" collection of methods.

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

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

◆ get()

Google_Service_Webmasters_Urlcrawlerrorssamples_Resource::get ( $siteUrl,
$url,
$category,
$platform,
$optParams = array() )

Retrieves details about crawl errors for a site's sample URL.

(urlcrawlerrorssamples.get)

Parameters
string$siteUrlThe site's URL, including protocol. For example: http://www.example.com/
string$urlThe relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename
string$categoryThe crawl error category. For example: authPermissions
string$platformThe user agent type (platform) that made the request. For example: web
array$optParamsOptional parameters.
Return values
Google_Service_Webmasters_UrlCrawlErrorsSample

◆ listUrlcrawlerrorssamples()

Google_Service_Webmasters_Urlcrawlerrorssamples_Resource::listUrlcrawlerrorssamples ( $siteUrl,
$category,
$platform,
$optParams = array() )

Lists a site's sample URLs for the specified crawl error category and platform.

(urlcrawlerrorssamples.listUrlcrawlerrorssamples)

Parameters
string$siteUrlThe site's URL, including protocol. For example: http://www.example.com/
string$categoryThe crawl error category. For example: authPermissions
string$platformThe user agent type (platform) that made the request. For example: web
array$optParamsOptional parameters.
Return values
Google_Service_Webmasters_UrlCrawlErrorsSamplesListResponse

◆ markAsFixed()

Google_Service_Webmasters_Urlcrawlerrorssamples_Resource::markAsFixed ( $siteUrl,
$url,
$category,
$platform,
$optParams = array() )

Marks the provided site's sample URL as fixed, and removes it from the samples list.

(urlcrawlerrorssamples.markAsFixed)

Parameters
string$siteUrlThe site's URL, including protocol. For example: http://www.example.com/
string$urlThe relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename
string$categoryThe crawl error category. For example: authPermissions
string$platformThe user agent type (platform) that made the request. For example: web
array$optParamsOptional parameters.

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