node-google-url

A NodeJS module to interface with Google's URL shortening service.

About

This library implements a client to consume the API (most of it) documented at https://developers.google.com/url-shortener/v1/getting_started#shorten

It supports the following actions:

Shorten URL Expand Shortened URL Get Analytics for Shortened URL

Authentication

The three actions supported by this library do not require an API key, but Google recommends getting one here: https://code.google.com/apis/console

Usage

var GoogleUrl = require( 'google-url' );

googleUrl = new GoogleURL();

// OR

googleUrl = new GoogleURL( { key: 'Your Real Key Here' });

googleUrl.shorten( 'http://bluerival.com/', function( err, shortUrl ) {
  // shortUrl should be http://goo.gl/BzpZ54
} );

googleUrl.shorten( 'http://goo.gl/BzpZ54', function( err, longUrl ) {
  // longUrl should be http://bluerival.com/
} );

googleUrl.analytics( 'http:/goo.gl/BzpZ54', function( err, results ) {

  /* format of results will be:
  {
    created:   "An ISO Date",
    analytics: {
      allTime:  {
        shortUrlClicks: 2,
        longUrlClicks:  3,
        referrers:      [
          { count: 2, "id": "http://HildoerSystems.com/" } /* , ... */
        ],
        countries:      [
          { count: 10, "id": "US" } /* , ... */
        ],
        browsers:       [
          { count: 3, "id": "Firefox" } /* , ... */
        ],
        platforms:      [
          { count: 6, "id": "Mac" } /* , ... */
        ]
      },
      month:    { /* same schema as allTime */ },
      week:     { /* same schema as allTime */ },
      day:      { /* same schema as allTime */ },
      twoHours: { /* same schema as allTime */ }
    } */

  }

} );

Bugs

Please report bugs to https://github.com/BlueRival/node-google-url/issues

License

(The MIT License)

Copyright (c) 2012 BlueRival Software [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.