Class: Google::Apis::UrlshortenerV1::UrlshortenerService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/urlshortener_v1/service.rb

Overview

URL Shortener API

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

Examples:

require 'google/apis/urlshortener_v1'

Urlshortener = Google::Apis::UrlshortenerV1 # Alias the module
service = Urlshortener::UrlshortenerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeUrlshortenerService

Returns a new instance of UrlshortenerService.


51
52
53
# File 'generated/google/apis/urlshortener_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'urlshortener/v1/')
end

Instance Attribute Details

#keyString

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

Returns:

  • (String)

    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.


38
39
40
# File 'generated/google/apis/urlshortener_v1/service.rb', line 38

def key
  @key
end

#quota_userString

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

Returns:

  • (String)

    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.


44
45
46
# File 'generated/google/apis/urlshortener_v1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ipString

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

Returns:

  • (String)

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


49
50
51
# File 'generated/google/apis/urlshortener_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#get_url(short_url, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::UrlshortenerV1::Url

Expands a short URL or gets creation time and analytics.

Parameters:

  • short_url (String)

    The short URL, including the protocol.

  • projection (String) (defaults to: nil)

    Additional information to return.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • user_ip (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


81
82
83
84
85
86
87
88
89
90
91
# File 'generated/google/apis/urlshortener_v1/service.rb', line 81

def get_url(short_url, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'url', options)
  command.response_representation = Google::Apis::UrlshortenerV1::Url::Representation
  command.response_class = Google::Apis::UrlshortenerV1::Url
  command.query['projection'] = projection unless projection.nil?
  command.query['shortUrl'] = short_url unless short_url.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_url(url_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::UrlshortenerV1::Url

Creates a new short URL.

Parameters:

  • url_object (Google::Apis::UrlshortenerV1::Url) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • user_ip (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


116
117
118
119
120
121
122
123
124
125
126
# File 'generated/google/apis/urlshortener_v1/service.rb', line 116

def insert_url(url_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'url', options)
  command.request_representation = Google::Apis::UrlshortenerV1::Url::Representation
  command.request_object = url_object
  command.response_representation = Google::Apis::UrlshortenerV1::Url::Representation
  command.response_class = Google::Apis::UrlshortenerV1::Url
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_urls(projection: nil, start_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::UrlshortenerV1::UrlHistory

Retrieves a list of URLs shortened by a user.

Parameters:

  • projection (String) (defaults to: nil)

    Additional information to return.

  • start_token (String) (defaults to: nil)

    Token for requesting successive pages of results.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • user_ip (String) (defaults to: nil)

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

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


154
155
156
157
158
159
160
161
162
163
164
# File 'generated/google/apis/urlshortener_v1/service.rb', line 154

def list_urls(projection: nil, start_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'url/history', options)
  command.response_representation = Google::Apis::UrlshortenerV1::UrlHistory::Representation
  command.response_class = Google::Apis::UrlshortenerV1::UrlHistory
  command.query['projection'] = projection unless projection.nil?
  command.query['start-token'] = start_token unless start_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end