gogol-urlshortener-0.0.1: Google URL Shortener SDK.

Copyright(c) 2015 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.URLShortener.Types

Contents

Description

 

Synopsis

Service Configuration

uRLShortenerService :: Service 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 :: OAuthScope Source

Manage your goo.gl short URLs

URL

data URL Source

Instances

url :: URL Source

Creates a value of URL with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

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.

uKind :: Lens' URL Text Source

The fixed string "urlshortener#url".

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

uId :: Lens' URL (Maybe Text) Source

Short URL, e.g. "http://goo.gl/l6MS".

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.

Constructors

AnalyticsClicks

ANALYTICS_CLICKS Returns short URL click counts.

Full

FULL Returns short URL click counts.

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.

Constructors

UGPAnalyticsClicks

ANALYTICS_CLICKS Returns only click counts.

UGPAnalyticsTopStrings

ANALYTICS_TOP_STRINGS Returns only top string counts.

UGPFull

FULL Returns the creation timestamp and all available analytics.

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.

uhKind :: Lens' URLHistory Text Source

The fixed string "urlshortener#urlHistory".

uhItems :: Lens' URLHistory [URL] Source

A list of URL resources.