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 |
Lets you create, inspect, and manage goo.gl short URLs
Synopsis
- uRLShortenerService :: ServiceConfig
- urlShortenerScope :: Proxy '["https://www.googleapis.com/auth/urlshortener"]
- type URLShortenerAPI = URLInsertResource :<|> (URLListResource :<|> URLGetResource)
- module Network.Google.Resource.URLShortener.URL.Get
- module Network.Google.Resource.URLShortener.URL.Insert
- module Network.Google.Resource.URLShortener.URL.List
- data URL
- url :: URL
- uStatus :: Lens' URL (Maybe Text)
- uKind :: Lens' URL Text
- uCreated :: Lens' URL (Maybe Text)
- uAnalytics :: Lens' URL (Maybe AnalyticsSummary)
- uLongURL :: Lens' URL (Maybe Text)
- uId :: Lens' URL (Maybe Text)
- data StringCount
- stringCount :: StringCount
- scCount :: Lens' StringCount (Maybe Int64)
- scId :: Lens' StringCount (Maybe Text)
- data URLListProjection
- data AnalyticsSnapshot
- analyticsSnapshot :: AnalyticsSnapshot
- asPlatforms :: Lens' AnalyticsSnapshot [StringCount]
- asShortURLClicks :: Lens' AnalyticsSnapshot (Maybe Int64)
- asReferrers :: Lens' AnalyticsSnapshot [StringCount]
- asCountries :: Lens' AnalyticsSnapshot [StringCount]
- asLongURLClicks :: Lens' AnalyticsSnapshot (Maybe Int64)
- asBrowsers :: Lens' AnalyticsSnapshot [StringCount]
- data AnalyticsSummary
- analyticsSummary :: AnalyticsSummary
- asWeek :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot)
- asAllTime :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot)
- asDay :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot)
- asTwoHours :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot)
- asMonth :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot)
- data URLGetProjection
- data URLHistory
- urlHistory :: URLHistory
- uhTotalItems :: Lens' URLHistory (Maybe Int32)
- uhNextPageToken :: Lens' URLHistory (Maybe Text)
- uhItemsPerPage :: Lens' URLHistory (Maybe Int32)
- uhKind :: Lens' URLHistory Text
- uhItems :: Lens' URLHistory [URL]
Service 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
urlShortenerScope :: Proxy '["https://www.googleapis.com/auth/urlshortener"] Source #
Manage your goo.gl short URLs
API Declaration
type URLShortenerAPI = URLInsertResource :<|> (URLListResource :<|> URLGetResource) Source #
Represents the entirety of the methods and resources available for the URL Shortener API service.
Resources
urlshortener.url.get
urlshortener.url.insert
urlshortener.url.list
Types
URL
Instances
Eq URL Source # | |
Data URL Source # | |
Defined in Network.Google.URLShortener.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URL -> c URL # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URL # dataTypeOf :: URL -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c URL) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URL) # gmapT :: (forall b. Data b => b -> b) -> URL -> URL # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URL -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URL -> r # gmapQ :: (forall d. Data d => d -> u) -> URL -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> URL -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> URL -> m URL # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URL -> m URL # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URL -> m URL # | |
Show URL Source # | |
Generic URL Source # | |
ToJSON URL Source # | |
Defined in Network.Google.URLShortener.Types.Product | |
FromJSON URL Source # | |
type Rep URL Source # | |
Defined in Network.Google.URLShortener.Types.Product type Rep URL = D1 (MetaData "URL" "Network.Google.URLShortener.Types.Product" "gogol-urlshortener-0.4.0-Bdh5132xSli1UeVEi8MZus" False) (C1 (MetaCons "URL'" PrefixI True) ((S1 (MetaSel (Just "_uStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_uKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_uCreated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_uAnalytics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AnalyticsSummary)) :*: (S1 (MetaSel (Just "_uLongURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) |
uStatus :: Lens' URL (Maybe Text) Source #
Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example.
uCreated :: Lens' URL (Maybe Text) Source #
Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
uAnalytics :: Lens' URL (Maybe AnalyticsSummary) Source #
A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
uLongURL :: Lens' URL (Maybe Text) Source #
Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".
StringCount
data StringCount Source #
Instances
stringCount :: StringCount Source #
Creates a value of StringCount
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scCount :: Lens' StringCount (Maybe Int64) Source #
Number of clicks for this top entry, e.g. for this particular country or browser.
scId :: Lens' StringCount (Maybe Text) Source #
Label assigned to this top entry, e.g. "US" or "Chrome".
URLListProjection
data URLListProjection Source #
Additional information to return.
AnalyticsClicks |
|
Full |
|
Instances
AnalyticsSnapshot
data AnalyticsSnapshot Source #
Instances
analyticsSnapshot :: AnalyticsSnapshot Source #
Creates a value of AnalyticsSnapshot
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asPlatforms :: Lens' AnalyticsSnapshot [StringCount] Source #
Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
asShortURLClicks :: Lens' AnalyticsSnapshot (Maybe Int64) Source #
Number of clicks on this short URL.
asReferrers :: Lens' AnalyticsSnapshot [StringCount] Source #
Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
asCountries :: Lens' AnalyticsSnapshot [StringCount] Source #
Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
asLongURLClicks :: Lens' AnalyticsSnapshot (Maybe Int64) Source #
Number of clicks on all goo.gl short URLs pointing to this long URL.
asBrowsers :: Lens' AnalyticsSnapshot [StringCount] Source #
Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
AnalyticsSummary
data AnalyticsSummary Source #
Instances
analyticsSummary :: AnalyticsSummary Source #
Creates a value of AnalyticsSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asWeek :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot) Source #
Click analytics over the last week.
asAllTime :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot) Source #
Click analytics over all time.
asDay :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot) Source #
Click analytics over the last day.
asTwoHours :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot) Source #
Click analytics over the last two hours.
asMonth :: Lens' AnalyticsSummary (Maybe AnalyticsSnapshot) Source #
Click analytics over the last month.
URLGetProjection
data URLGetProjection Source #
Additional information to return.
UGPAnalyticsClicks |
|
UGPAnalyticsTopStrings |
|
UGPFull |
|
Instances
URLHistory
data URLHistory Source #
Instances
urlHistory :: URLHistory Source #
Creates a value of URLHistory
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uhTotalItems :: Lens' URLHistory (Maybe Int32) Source #
Total number of short URLs associated with this user (may be approximate).
uhNextPageToken :: Lens' URLHistory (Maybe Text) Source #
A token to provide to get the next page of results.
uhItemsPerPage :: Lens' URLHistory (Maybe Int32) Source #
Number of items returned with each full "page" of results. Note that the last page could have fewer items than the "itemsPerPage" value.