Class: Google::Apis::MybusinesslodgingV1::MyBusinessLodgingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/mybusinesslodging_v1/service.rb

Overview

My Business Lodging API

The My Business Lodging API enables managing lodging business information on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.

Examples:

require 'google/apis/mybusinesslodging_v1'

Mybusinesslodging = Google::Apis::MybusinesslodgingV1 # Alias the module
service = Mybusinesslodging::MyBusinessLodgingService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://mybusinesslodging.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MyBusinessLodgingService

Returns a new instance of MyBusinessLodgingService.



49
50
51
52
53
54
 
# File 'lib/google/apis/mybusinesslodging_v1/service.rb', line 49

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-mybusinesslodging_v1',
        client_version: Google::Apis::MybusinesslodgingV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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.



42
43
44
 
# File 'lib/google/apis/mybusinesslodging_v1/service.rb', line 42

def key
  @key
end

#quota_user ⇒ String

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.

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.



47
48
49
 
# File 'lib/google/apis/mybusinesslodging_v1/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#get_location_lodging(name, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MybusinesslodgingV1::Lodging

Returns the Lodging of a specific location.

Parameters:

  • name (String) —

    Required. Google identifier for this location in the form: locations/ location_id/lodging

  • read_mask (String) (defaults to: nil) —

    Required. The specific fields to return. Use "*" to include all fields. Repeated field items cannot be individually specified.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/mybusinesslodging_v1/service.rb', line 80

def get_location_lodging(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::MybusinesslodgingV1::Lodging::Representation
  command.response_class = Google::Apis::MybusinesslodgingV1::Lodging
  command.params['name'] = name unless name.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_location_lodging_google_updated(name, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MybusinesslodgingV1::GetGoogleUpdatedLodgingResponse

Returns the Google updated Lodging of a specific location.

Parameters:

  • name (String) —

    Required. Google identifier for this location in the form: locations/ location_id/lodging

  • read_mask (String) (defaults to: nil) —

    Required. The specific fields to return. Use "*" to include all fields. Repeated field items cannot be individually specified.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_location_lodging_google_updated(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:getGoogleUpdated', options)
  command.response_representation = Google::Apis::MybusinesslodgingV1::GetGoogleUpdatedLodgingResponse::Representation
  command.response_class = Google::Apis::MybusinesslodgingV1::GetGoogleUpdatedLodgingResponse
  command.params['name'] = name unless name.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_location_lodging(name, lodging_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::MybusinesslodgingV1::Lodging

Updates the Lodging of a specific location.

Parameters:

  • name (String) —

    Required. Google identifier for this location in the form: locations/ location_id/lodging

  • lodging_object (Google::Apis::MybusinesslodgingV1::Lodging) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The specific fields to update. Use "*" to update all fields, which may include unsetting empty fields in the request. Repeated field items cannot be individually updated.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/google/apis/mybusinesslodging_v1/service.rb', line 117

def update_location_lodging(name, lodging_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::MybusinesslodgingV1::Lodging::Representation
  command.request_object = lodging_object
  command.response_representation = Google::Apis::MybusinesslodgingV1::Lodging::Representation
  command.response_class = Google::Apis::MybusinesslodgingV1::Lodging
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end