gogol-indexing-0.4.0: Google Indexing SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Indexing

Contents

Description

Notifies Google when your web pages change.

See: Indexing API Reference

Synopsis

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
Eq PublishURLNotificationResponse Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Data PublishURLNotificationResponse Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PublishURLNotificationResponse -> c PublishURLNotificationResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PublishURLNotificationResponse #

toConstr :: PublishURLNotificationResponse -> Constr #

dataTypeOf :: PublishURLNotificationResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PublishURLNotificationResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PublishURLNotificationResponse) #

gmapT :: (forall b. Data b => b -> b) -> PublishURLNotificationResponse -> PublishURLNotificationResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PublishURLNotificationResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PublishURLNotificationResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> PublishURLNotificationResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PublishURLNotificationResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PublishURLNotificationResponse -> m PublishURLNotificationResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PublishURLNotificationResponse -> m PublishURLNotificationResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PublishURLNotificationResponse -> m PublishURLNotificationResponse #

Show PublishURLNotificationResponse Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Generic PublishURLNotificationResponse Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Associated Types

type Rep PublishURLNotificationResponse :: Type -> Type #

ToJSON PublishURLNotificationResponse Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

FromJSON PublishURLNotificationResponse Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

type Rep PublishURLNotificationResponse Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

type Rep PublishURLNotificationResponse = D1 (MetaData "PublishURLNotificationResponse" "Network.Google.Indexing.Types.Product" "gogol-indexing-0.4.0-5wowHjNGXCH8wA73fTmgxO" True) (C1 (MetaCons "PublishURLNotificationResponse'" PrefixI True) (S1 (MetaSel (Just "_punrURLNotificationMetadata") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URLNotificationMetadata))))

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

URL_NOTIFICATION_TYPE_UNSPECIFIED Unspecified.

URLUpdated

URL_UPDATED The given URL (Web document) has been updated.

URLDeleted

URL_DELETED The given URL (Web document) has been deleted.

Instances
Enum URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Eq URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Data URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URLNotificationType -> c URLNotificationType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URLNotificationType #

toConstr :: URLNotificationType -> Constr #

dataTypeOf :: URLNotificationType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c URLNotificationType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URLNotificationType) #

gmapT :: (forall b. Data b => b -> b) -> URLNotificationType -> URLNotificationType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URLNotificationType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URLNotificationType -> r #

gmapQ :: (forall d. Data d => d -> u) -> URLNotificationType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> URLNotificationType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> URLNotificationType -> m URLNotificationType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URLNotificationType -> m URLNotificationType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URLNotificationType -> m URLNotificationType #

Ord URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Read URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Show URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Generic URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Associated Types

type Rep URLNotificationType :: Type -> Type #

Hashable URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

ToJSON URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

FromJSON URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

FromHttpApiData URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

ToHttpApiData URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

type Rep URLNotificationType Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

type Rep URLNotificationType = D1 (MetaData "URLNotificationType" "Network.Google.Indexing.Types.Sum" "gogol-indexing-0.4.0-5wowHjNGXCH8wA73fTmgxO" False) (C1 (MetaCons "URLNotificationTypeUnspecified" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "URLUpdated" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "URLDeleted" PrefixI False) (U1 :: Type -> Type)))

Xgafv

data Xgafv Source #

V1 error format.

Constructors

X1

1 v1 error format

X2

2 v2 error format

Instances
Enum Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Eq Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Methods

(==) :: Xgafv -> Xgafv -> Bool #

(/=) :: Xgafv -> Xgafv -> Bool #

Data Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Xgafv -> c Xgafv #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Xgafv #

toConstr :: Xgafv -> Constr #

dataTypeOf :: Xgafv -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Xgafv) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Xgafv) #

gmapT :: (forall b. Data b => b -> b) -> Xgafv -> Xgafv #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Xgafv -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Xgafv -> r #

gmapQ :: (forall d. Data d => d -> u) -> Xgafv -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Xgafv -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Xgafv -> m Xgafv #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Xgafv -> m Xgafv #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Xgafv -> m Xgafv #

Ord Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Methods

compare :: Xgafv -> Xgafv -> Ordering #

(<) :: Xgafv -> Xgafv -> Bool #

(<=) :: Xgafv -> Xgafv -> Bool #

(>) :: Xgafv -> Xgafv -> Bool #

(>=) :: Xgafv -> Xgafv -> Bool #

max :: Xgafv -> Xgafv -> Xgafv #

min :: Xgafv -> Xgafv -> Xgafv #

Read Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Show Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Methods

showsPrec :: Int -> Xgafv -> ShowS #

show :: Xgafv -> String #

showList :: [Xgafv] -> ShowS #

Generic Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Associated Types

type Rep Xgafv :: Type -> Type #

Methods

from :: Xgafv -> Rep Xgafv x #

to :: Rep Xgafv x -> Xgafv #

Hashable Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

Methods

hashWithSalt :: Int -> Xgafv -> Int #

hash :: Xgafv -> Int #

ToJSON Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

FromJSON Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

FromHttpApiData Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

ToHttpApiData Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

type Rep Xgafv Source # 
Instance details

Defined in Network.Google.Indexing.Types.Sum

type Rep Xgafv = D1 (MetaData "Xgafv" "Network.Google.Indexing.Types.Sum" "gogol-indexing-0.4.0-5wowHjNGXCH8wA73fTmgxO" False) (C1 (MetaCons "X1" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "X2" PrefixI False) (U1 :: Type -> Type))

URLNotificationMetadata

data URLNotificationMetadata Source #

Summary of the most recent Indexing API notifications successfully received, for a given URL.

See: urlNotificationMetadata smart constructor.

Instances
Eq URLNotificationMetadata Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Data URLNotificationMetadata Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URLNotificationMetadata -> c URLNotificationMetadata #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URLNotificationMetadata #

toConstr :: URLNotificationMetadata -> Constr #

dataTypeOf :: URLNotificationMetadata -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c URLNotificationMetadata) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URLNotificationMetadata) #

gmapT :: (forall b. Data b => b -> b) -> URLNotificationMetadata -> URLNotificationMetadata #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URLNotificationMetadata -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URLNotificationMetadata -> r #

gmapQ :: (forall d. Data d => d -> u) -> URLNotificationMetadata -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> URLNotificationMetadata -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> URLNotificationMetadata -> m URLNotificationMetadata #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URLNotificationMetadata -> m URLNotificationMetadata #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URLNotificationMetadata -> m URLNotificationMetadata #

Show URLNotificationMetadata Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Generic URLNotificationMetadata Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Associated Types

type Rep URLNotificationMetadata :: Type -> Type #

ToJSON URLNotificationMetadata Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

FromJSON URLNotificationMetadata Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

type Rep URLNotificationMetadata Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

type Rep URLNotificationMetadata = D1 (MetaData "URLNotificationMetadata" "Network.Google.Indexing.Types.Product" "gogol-indexing-0.4.0-5wowHjNGXCH8wA73fTmgxO" False) (C1 (MetaCons "URLNotificationMetadata'" PrefixI True) (S1 (MetaSel (Just "_unmLatestUpdate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe URLNotification)) :*: (S1 (MetaSel (Just "_unmLatestRemove") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe URLNotification)) :*: S1 (MetaSel (Just "_unmURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

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`.

unmURL :: Lens' URLNotificationMetadata (Maybe Text) Source #

URL to which this metadata refers.

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
Eq URLNotification Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Data URLNotification Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URLNotification -> c URLNotification #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URLNotification #

toConstr :: URLNotification -> Constr #

dataTypeOf :: URLNotification -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c URLNotification) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URLNotification) #

gmapT :: (forall b. Data b => b -> b) -> URLNotification -> URLNotification #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URLNotification -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URLNotification -> r #

gmapQ :: (forall d. Data d => d -> u) -> URLNotification -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> URLNotification -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> URLNotification -> m URLNotification #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URLNotification -> m URLNotification #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URLNotification -> m URLNotification #

Show URLNotification Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Generic URLNotification Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

Associated Types

type Rep URLNotification :: Type -> Type #

ToJSON URLNotification Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

FromJSON URLNotification Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

type Rep URLNotification Source # 
Instance details

Defined in Network.Google.Indexing.Types.Product

type Rep URLNotification = D1 (MetaData "URLNotification" "Network.Google.Indexing.Types.Product" "gogol-indexing-0.4.0-5wowHjNGXCH8wA73fTmgxO" False) (C1 (MetaCons "URLNotification'" PrefixI True) (S1 (MetaSel (Just "_unURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_unNotifyTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')) :*: S1 (MetaSel (Just "_unType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe URLNotificationType)))))

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.