URL Shortener API v1

Version: 5.3

URL Shortener API v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you create, inspect, and manage goo.gl short URLs Google documentation.

1 API Parameters

2 Resources

2.1 url

(require gapi/macro)

(require-gapi-doc urlshortener.v1.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 url

procedure
(urlshortener-url-list [ #:projection projection
#:start-token start-token
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  projection : string? = 'N/A
  start-token : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves a list of URLs shortened by a user.

projection: Additional information to return.

start-token: Token for requesting successive pages of results.

procedure
(urlshortener-url-get #:shortUrl shortUrl
[ #:projection projection
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  shortUrl : string?
  projection : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Expands a short URL or gets creation time and analytics.

shortUrl: The short URL, including the protocol.

projection: Additional information to return.

procedure
(urlshortener-url-insert [ #:id id
#:created created
#:kind kind
#:status status
#:analytics analytics
#:longUrl longUrl
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  id : string? = 'N/A
  created : string? = 'N/A
  kind : string? = 'N/A
  status : string? = 'N/A
  analytics : string? = 'N/A
  longUrl : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Creates a new short URL.

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

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

kind: The fixed string "urlshortener#url".

status: 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.

analytics: A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.

longUrl: Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".