Copyright | (c) 2015-2025 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+gogol@gmail.com> Toni Cebrián <toni@tonicebrian.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | GHC2021 |
Gogol.URLShortener.Types
Description
Synopsis
- uRLShortenerService :: ServiceConfig
- type Urlshortener'FullControl = "https://www.googleapis.com/auth/urlshortener"
- data AnalyticsSnapshot = AnalyticsSnapshot {
- browsers :: Maybe [StringCount]
- countries :: Maybe [StringCount]
- longUrlClicks :: Maybe Int64
- platforms :: Maybe [StringCount]
- referrers :: Maybe [StringCount]
- shortUrlClicks :: Maybe Int64
- newAnalyticsSnapshot :: AnalyticsSnapshot
- data AnalyticsSummary = AnalyticsSummary {}
- newAnalyticsSummary :: AnalyticsSummary
- data StringCount = StringCount {}
- newStringCount :: StringCount
- data Url = Url {}
- newUrl :: Url
- data UrlHistory = UrlHistory {
- items :: Maybe [Url]
- itemsPerPage :: Maybe Int32
- kind :: Text
- nextPageToken :: Maybe Text
- totalItems :: Maybe Int32
- newUrlHistory :: UrlHistory
- newtype UrlGetProjection where
- UrlGetProjection { }
- pattern UrlGetProjection_ANALYTICSCLICKS :: UrlGetProjection
- pattern UrlGetProjection_ANALYTICSTOPSTRINGS :: UrlGetProjection
- pattern UrlGetProjection_Full :: UrlGetProjection
- newtype UrlListProjection where
- UrlListProjection { }
- pattern UrlListProjection_ANALYTICSCLICKS :: UrlListProjection
- pattern UrlListProjection_Full :: UrlListProjection
Configuration
uRLShortenerService :: ServiceConfig Source #
Default request referring to version v1
of the URL Shortener API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
type Urlshortener'FullControl = "https://www.googleapis.com/auth/urlshortener" Source #
Manage your goo.gl short URLs
Types
AnalyticsSnapshot
data AnalyticsSnapshot Source #
Constructors
AnalyticsSnapshot | |
Fields
|
Instances
newAnalyticsSnapshot :: AnalyticsSnapshot Source #
Creates a value of AnalyticsSnapshot
with the minimum fields required to make a request.
AnalyticsSummary
data AnalyticsSummary Source #
Constructors
AnalyticsSummary | |
Fields
|
Instances
FromJSON AnalyticsSummary Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Methods parseJSON :: Value -> Parser AnalyticsSummary # parseJSONList :: Value -> Parser [AnalyticsSummary] # | |||||
ToJSON AnalyticsSummary Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Methods toJSON :: AnalyticsSummary -> Value # toEncoding :: AnalyticsSummary -> Encoding # toJSONList :: [AnalyticsSummary] -> Value # toEncodingList :: [AnalyticsSummary] -> Encoding # omitField :: AnalyticsSummary -> Bool # | |||||
Generic AnalyticsSummary Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Associated Types
Methods from :: AnalyticsSummary -> Rep AnalyticsSummary x # to :: Rep AnalyticsSummary x -> AnalyticsSummary # | |||||
Show AnalyticsSummary Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Methods showsPrec :: Int -> AnalyticsSummary -> ShowS # show :: AnalyticsSummary -> String # showList :: [AnalyticsSummary] -> ShowS # | |||||
Eq AnalyticsSummary Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Methods (==) :: AnalyticsSummary -> AnalyticsSummary -> Bool # (/=) :: AnalyticsSummary -> AnalyticsSummary -> Bool # | |||||
type Rep AnalyticsSummary Source # | |||||
Defined in Gogol.URLShortener.Internal.Product type Rep AnalyticsSummary = D1 ('MetaData "AnalyticsSummary" "Gogol.URLShortener.Internal.Product" "gogol-urlshortener-1.0.0-Eavoe52yh8RBZydGcJO1Xz" 'False) (C1 ('MetaCons "AnalyticsSummary" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalyticsSnapshot)) :*: S1 ('MetaSel ('Just "day") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalyticsSnapshot))) :*: (S1 ('MetaSel ('Just "month") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalyticsSnapshot)) :*: (S1 ('MetaSel ('Just "twoHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalyticsSnapshot)) :*: S1 ('MetaSel ('Just "week") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalyticsSnapshot)))))) |
newAnalyticsSummary :: AnalyticsSummary Source #
Creates a value of AnalyticsSummary
with the minimum fields required to make a request.
StringCount
data StringCount Source #
Constructors
StringCount | |
Instances
FromJSON StringCount Source # | |||||
Defined in Gogol.URLShortener.Internal.Product | |||||
ToJSON StringCount Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Methods toJSON :: StringCount -> Value # toEncoding :: StringCount -> Encoding # toJSONList :: [StringCount] -> Value # toEncodingList :: [StringCount] -> Encoding # omitField :: StringCount -> Bool # | |||||
Generic StringCount Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Associated Types
| |||||
Show StringCount Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Methods showsPrec :: Int -> StringCount -> ShowS # show :: StringCount -> String # showList :: [StringCount] -> ShowS # | |||||
Eq StringCount Source # | |||||
Defined in Gogol.URLShortener.Internal.Product | |||||
type Rep StringCount Source # | |||||
Defined in Gogol.URLShortener.Internal.Product type Rep StringCount = D1 ('MetaData "StringCount" "Gogol.URLShortener.Internal.Product" "gogol-urlshortener-1.0.0-Eavoe52yh8RBZydGcJO1Xz" 'False) (C1 ('MetaCons "StringCount" 'PrefixI 'True) (S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int64)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newStringCount :: StringCount Source #
Creates a value of StringCount
with the minimum fields required to make a request.
Url
Constructors
Url | |
Fields
|
Instances
FromJSON Url Source # | |||||
Defined in Gogol.URLShortener.Internal.Product | |||||
ToJSON Url Source # | |||||
Generic Url Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Associated Types
| |||||
Show Url Source # | |||||
Eq Url Source # | |||||
type Rep Url Source # | |||||
Defined in Gogol.URLShortener.Internal.Product type Rep Url = D1 ('MetaData "Url" "Gogol.URLShortener.Internal.Product" "gogol-urlshortener-1.0.0-Eavoe52yh8RBZydGcJO1Xz" 'False) (C1 ('MetaCons "Url" 'PrefixI 'True) ((S1 ('MetaSel ('Just "analytics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalyticsSummary)) :*: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "longUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) |
UrlHistory
data UrlHistory Source #
Constructors
UrlHistory | |
Fields
|
Instances
FromJSON UrlHistory Source # | |||||
Defined in Gogol.URLShortener.Internal.Product | |||||
ToJSON UrlHistory Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Methods toJSON :: UrlHistory -> Value # toEncoding :: UrlHistory -> Encoding # toJSONList :: [UrlHistory] -> Value # toEncodingList :: [UrlHistory] -> Encoding # omitField :: UrlHistory -> Bool # | |||||
Generic UrlHistory Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Associated Types
| |||||
Show UrlHistory Source # | |||||
Defined in Gogol.URLShortener.Internal.Product Methods showsPrec :: Int -> UrlHistory -> ShowS # show :: UrlHistory -> String # showList :: [UrlHistory] -> ShowS # | |||||
Eq UrlHistory Source # | |||||
Defined in Gogol.URLShortener.Internal.Product | |||||
type Rep UrlHistory Source # | |||||
Defined in Gogol.URLShortener.Internal.Product type Rep UrlHistory = D1 ('MetaData "UrlHistory" "Gogol.URLShortener.Internal.Product" "gogol-urlshortener-1.0.0-Eavoe52yh8RBZydGcJO1Xz" 'False) (C1 ('MetaCons "UrlHistory" 'PrefixI 'True) ((S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Url])) :*: S1 ('MetaSel ('Just "itemsPerPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int32))) :*: (S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "totalItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int32)))))) |
newUrlHistory :: UrlHistory Source #
Creates a value of UrlHistory
with the minimum fields required to make a request.
UrlGetProjection
newtype UrlGetProjection Source #
Additional information to return.
Constructors
UrlGetProjection | |
Fields |
Bundled Patterns
pattern UrlGetProjection_ANALYTICSCLICKS :: UrlGetProjection | Returns only click counts. |
pattern UrlGetProjection_ANALYTICSTOPSTRINGS :: UrlGetProjection | Returns only top string counts. |
pattern UrlGetProjection_Full :: UrlGetProjection | Returns the creation timestamp and all available analytics. |
Instances
FromJSON UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods parseJSON :: Value -> Parser UrlGetProjection # parseJSONList :: Value -> Parser [UrlGetProjection] # | |||||
FromJSONKey UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum | |||||
ToJSON UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods toJSON :: UrlGetProjection -> Value # toEncoding :: UrlGetProjection -> Encoding # toJSONList :: [UrlGetProjection] -> Value # toEncodingList :: [UrlGetProjection] -> Encoding # omitField :: UrlGetProjection -> Bool # | |||||
ToJSONKey UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum | |||||
Generic UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Associated Types
Methods from :: UrlGetProjection -> Rep UrlGetProjection x # to :: Rep UrlGetProjection x -> UrlGetProjection # | |||||
Read UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods readsPrec :: Int -> ReadS UrlGetProjection # readList :: ReadS [UrlGetProjection] # | |||||
Show UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods showsPrec :: Int -> UrlGetProjection -> ShowS # show :: UrlGetProjection -> String # showList :: [UrlGetProjection] -> ShowS # | |||||
Eq UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods (==) :: UrlGetProjection -> UrlGetProjection -> Bool # (/=) :: UrlGetProjection -> UrlGetProjection -> Bool # | |||||
Ord UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods compare :: UrlGetProjection -> UrlGetProjection -> Ordering # (<) :: UrlGetProjection -> UrlGetProjection -> Bool # (<=) :: UrlGetProjection -> UrlGetProjection -> Bool # (>) :: UrlGetProjection -> UrlGetProjection -> Bool # (>=) :: UrlGetProjection -> UrlGetProjection -> Bool # max :: UrlGetProjection -> UrlGetProjection -> UrlGetProjection # min :: UrlGetProjection -> UrlGetProjection -> UrlGetProjection # | |||||
Hashable UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum | |||||
FromHttpApiData UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods parseUrlPiece :: Text -> Either Text UrlGetProjection # | |||||
ToHttpApiData UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods toUrlPiece :: UrlGetProjection -> Text # toEncodedUrlPiece :: UrlGetProjection -> Builder # toHeader :: UrlGetProjection -> ByteString # toQueryParam :: UrlGetProjection -> Text # | |||||
type Rep UrlGetProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum type Rep UrlGetProjection = D1 ('MetaData "UrlGetProjection" "Gogol.URLShortener.Internal.Sum" "gogol-urlshortener-1.0.0-Eavoe52yh8RBZydGcJO1Xz" 'True) (C1 ('MetaCons "UrlGetProjection" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromUrlGetProjection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) |
UrlListProjection
newtype UrlListProjection Source #
Additional information to return.
Constructors
UrlListProjection | |
Fields |
Bundled Patterns
pattern UrlListProjection_ANALYTICSCLICKS :: UrlListProjection | Returns short URL click counts. |
pattern UrlListProjection_Full :: UrlListProjection | Returns short URL click counts. |
Instances
FromJSON UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods parseJSON :: Value -> Parser UrlListProjection # parseJSONList :: Value -> Parser [UrlListProjection] # | |||||
FromJSONKey UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum | |||||
ToJSON UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods toJSON :: UrlListProjection -> Value # toEncoding :: UrlListProjection -> Encoding # toJSONList :: [UrlListProjection] -> Value # toEncodingList :: [UrlListProjection] -> Encoding # omitField :: UrlListProjection -> Bool # | |||||
ToJSONKey UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum | |||||
Generic UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Associated Types
Methods from :: UrlListProjection -> Rep UrlListProjection x # to :: Rep UrlListProjection x -> UrlListProjection # | |||||
Read UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods readsPrec :: Int -> ReadS UrlListProjection # readList :: ReadS [UrlListProjection] # | |||||
Show UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods showsPrec :: Int -> UrlListProjection -> ShowS # show :: UrlListProjection -> String # showList :: [UrlListProjection] -> ShowS # | |||||
Eq UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods (==) :: UrlListProjection -> UrlListProjection -> Bool # (/=) :: UrlListProjection -> UrlListProjection -> Bool # | |||||
Ord UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods compare :: UrlListProjection -> UrlListProjection -> Ordering # (<) :: UrlListProjection -> UrlListProjection -> Bool # (<=) :: UrlListProjection -> UrlListProjection -> Bool # (>) :: UrlListProjection -> UrlListProjection -> Bool # (>=) :: UrlListProjection -> UrlListProjection -> Bool # max :: UrlListProjection -> UrlListProjection -> UrlListProjection # min :: UrlListProjection -> UrlListProjection -> UrlListProjection # | |||||
Hashable UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum | |||||
FromHttpApiData UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods parseUrlPiece :: Text -> Either Text UrlListProjection # parseHeader :: ByteString -> Either Text UrlListProjection # | |||||
ToHttpApiData UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum Methods toUrlPiece :: UrlListProjection -> Text # toEncodedUrlPiece :: UrlListProjection -> Builder # toHeader :: UrlListProjection -> ByteString # toQueryParam :: UrlListProjection -> Text # | |||||
type Rep UrlListProjection Source # | |||||
Defined in Gogol.URLShortener.Internal.Sum type Rep UrlListProjection = D1 ('MetaData "UrlListProjection" "Gogol.URLShortener.Internal.Sum" "gogol-urlshortener-1.0.0-Eavoe52yh8RBZydGcJO1Xz" 'True) (C1 ('MetaCons "UrlListProjection" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromUrlListProjection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) |