Google_Service_Indexing_Resource_UrlNotifications
extends Google_Service_Resource
in package
The "urlNotifications" collection of methods.
Typical usage is:
$indexingService = new Google_Service_Indexing(...);
$urlNotifications = $indexingService->urlNotifications;
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.
- getMetadata() : Google_Service_Indexing_UrlNotificationMetadata
- Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications.
- publish() : Google_Service_Indexing_PublishUrlNotificationResponse
- Notifies that a URL has been updated or deleted. (urlNotifications.publish)
- convertToArrayAndStripNulls() : mixed
Properties
$client
private
Google_Client
$client
$methods
private
array<string|int, mixed>
$methods
$resourceName
private
string
$resourceName
$rootUrl
private
string
$rootUrl
$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
Tags
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
Return values
string —$requestUrl
getMetadata()
Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications.
public
getMetadata([array<string|int, mixed> $optParams = array() ]) : Google_Service_Indexing_UrlNotificationMetadata
Includes the latest UrlNotification received via this API.
(urlNotifications.getMetadata)
Parameters
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Tags
Return values
Google_Service_Indexing_UrlNotificationMetadata —publish()
Notifies that a URL has been updated or deleted. (urlNotifications.publish)
public
publish(Google_Service_Indexing_UrlNotification $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Indexing_PublishUrlNotificationResponse
Parameters
- $postBody : Google_Service_Indexing_UrlNotification
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Indexing_PublishUrlNotificationResponse —convertToArrayAndStripNulls()
protected
convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
- $o : mixed