| Copyright | (c) 2015-2016 Brendan Hay | 
|---|---|
| License | Mozilla Public License, v. 2.0. | 
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> | 
| Stability | auto-generated | 
| Portability | non-portable (GHC extensions) | 
| Safe Haskell | None | 
| Language | Haskell2010 | 
Network.Google.Indexing
Contents
Description
Notifies Google when your web pages change.
Synopsis
- indexingService :: ServiceConfig
- indexingScope :: Proxy '["https://www.googleapis.com/auth/indexing"]
- type IndexingAPI = URLNotificationsGetMetadataResource :<|> URLNotificationsPublishResource
- module Network.Google.Resource.Indexing.URLNotifications.GetMetadata
- module Network.Google.Resource.Indexing.URLNotifications.Publish
- data PublishURLNotificationResponse
- publishURLNotificationResponse :: PublishURLNotificationResponse
- punrURLNotificationMetadata :: Lens' PublishURLNotificationResponse (Maybe URLNotificationMetadata)
- data URLNotificationType
- data Xgafv
- data URLNotificationMetadata
- urlNotificationMetadata :: URLNotificationMetadata
- unmLatestUpdate :: Lens' URLNotificationMetadata (Maybe URLNotification)
- unmLatestRemove :: Lens' URLNotificationMetadata (Maybe URLNotification)
- unmURL :: Lens' URLNotificationMetadata (Maybe Text)
- data URLNotification
- urlNotification :: URLNotification
- unURL :: Lens' URLNotification (Maybe Text)
- unNotifyTime :: Lens' URLNotification (Maybe UTCTime)
- unType :: Lens' URLNotification (Maybe URLNotificationType)
Service Configuration
indexingService :: ServiceConfig Source #
Default request referring to version v3 of the Indexing API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
indexingScope :: Proxy '["https://www.googleapis.com/auth/indexing"] Source #
Submit data to Google for indexing
API Declaration
type IndexingAPI = URLNotificationsGetMetadataResource :<|> URLNotificationsPublishResource Source #
Represents the entirety of the methods and resources available for the Indexing API service.
Resources
indexing.urlNotifications.getMetadata
indexing.urlNotifications.publish
Types
PublishURLNotificationResponse
data PublishURLNotificationResponse Source #
Output for PublishUrlNotification
See: publishURLNotificationResponse smart constructor.
Instances
publishURLNotificationResponse :: PublishURLNotificationResponse Source #
Creates a value of PublishURLNotificationResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
punrURLNotificationMetadata :: Lens' PublishURLNotificationResponse (Maybe URLNotificationMetadata) Source #
Description of the notification events received for this URL.
URLNotificationType
data URLNotificationType Source #
The URL life cycle event that Google is being notified about.
Constructors
| URLNotificationTypeUnspecified | 
 | 
| URLUpdated | 
 | 
| URLDeleted | 
 | 
Instances
Xgafv
V1 error format.
Instances
URLNotificationMetadata
data URLNotificationMetadata Source #
Summary of the most recent Indexing API notifications successfully received, for a given URL.
See: urlNotificationMetadata smart constructor.
Instances
urlNotificationMetadata :: URLNotificationMetadata Source #
Creates a value of URLNotificationMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
unmLatestUpdate :: Lens' URLNotificationMetadata (Maybe URLNotification) Source #
Latest notification received with type `URL_UPDATED`.
unmLatestRemove :: Lens' URLNotificationMetadata (Maybe URLNotification) Source #
Latest notification received with type `URL_REMOVED`.
URLNotification
data URLNotification Source #
`UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document.
See: urlNotification smart constructor.
Instances
urlNotification :: URLNotification Source #
Creates a value of URLNotification with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
unURL :: Lens' URLNotification (Maybe Text) Source #
The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google.
unNotifyTime :: Lens' URLNotification (Maybe UTCTime) Source #
Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time.
unType :: Lens' URLNotification (Maybe URLNotificationType) Source #
The URL life cycle event that Google is being notified about.