class Google::Apis::UrlshortenerV1::UrlshortenerService
URL Shortener API
Lets you create, inspect, and manage goo.gl short URLs
@example
require 'google/apis/urlshortener_v1' Urlshortener = Google::Apis::UrlshortenerV1 # Alias the module service = Urlshortener::UrlshortenerService.new
Attributes
@return [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.
@return [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.
@return [String]
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Public Class Methods
# File generated/google/apis/urlshortener_v1/service.rb, line 51 def initialize super('https://www.googleapis.com/', 'urlshortener/v1/') end
Public Instance Methods
Expands a short URL or gets creation time and analytics. @param [String] short_url
The short URL, including the protocol.
@param [String] projection
Additional information to return.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
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.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::UrlshortenerV1::Url] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::UrlshortenerV1::Url]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# 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
Creates a new short URL. @param [Google::Apis::UrlshortenerV1::Url] url_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
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.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::UrlshortenerV1::Url] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::UrlshortenerV1::Url]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# 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
Retrieves a list of URLs shortened by a user. @param [String] projection
Additional information to return.
@param [String] start_token
Token for requesting successive pages of results.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
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.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::UrlshortenerV1::UrlHistory] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::UrlshortenerV1::UrlHistory]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# 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
Protected Instance Methods
# File generated/google/apis/urlshortener_v1/service.rb, line 168 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? end