gapi-url
Small wrapper around Google Url Shortener API providing 'insert' and 'get' methods.
const gapiUrl = const API_KEY = '<your api key here>' // Shorten a URL { if err return console console // => shortened url: https://goo.gl/un5E} // Expand a shortened URL { if err return console console // => expanded url: https://github.com}
Installation
npm install gapi-url
Table of Contents generated with DocToc
API
shortenURL
Shortens the provided url
Parameters
apiKey
String api key of your google applicationlink
String that you want to shortencb
Function with following signaturefunction (err, shortenedLink)
expandURL
Expands the provided shortened url
Supported projections
- ANALYTICS_CLICKS: Returns only click counts
- ANALYTICS_TOP_STRINGS: Returns only top string counts
- FULL: Returns the creation timestamp and all available analytics
Parameters
apiKey
String api key of your google applicationshortened
String link that you want to expandprojection
String to include more infoANALYTICS_CLICKS| ANALYTICS_TOP_STRINGS | FULL
cb
Function with following signaturefunction (err, expanedLink)
shortLink
getAnalyticsURL
Returns the url for the google analytics page for the given shortened url.
Example
getAnalyticsURL('https://goo.gl/un5E')
=> https://goo.gl/#analytics/goo.gl/un5E/all_time
Parameters
url
String shortened URL, i.e. obtained via shortenURL
Returns String link to the Google Analytics page.
Resources
Getting Started with the Google Shortener API
API documented here
https://developers.google.com/url-shortener/v1/url
Get API key
https://developers.google.com/url-shortener/v1/getting_started
View Shortener Console
https://console.developers.google.com/apis/api/urlshortener.googleapis.com/overview?project=gapi-url-1513446857763&duration=PT1H
Testing with curl
curl https://www.googleapis.com/urlshortener/v1/url?key=AIzaSyA2LZbzpowavq0euPXmNhrSW6Q-R4-HnZA \
-H 'Content-Type: application/json' \
-d '{"longUrl": "http://www.google.com/" }'
Kudos
Thanks to @anvaka for his initial shortener implementation.
License
MIT