Class: Google::Apis::ContentV2_1::CarrierRate

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2_1/classes.rb,
generated/google/apis/content_v2_1/representations.rb,
generated/google/apis/content_v2_1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CarrierRate

Returns a new instance of CarrierRate



1387
1388
1389
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1387

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#carrier_name ⇒ String

Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. Corresponds to the JSON property carrierName

Returns:

  • (String) 


1355
1356
1357
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1355

def carrier_name
  @carrier_name
end

#carrier_service ⇒ String

Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required. Corresponds to the JSON property carrierService

Returns:

  • (String) 


1361
1362
1363
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1361

def carrier_service
  @carrier_service
end

#flat_adjustment ⇒ Google::Apis::ContentV2_1::Price

Additive shipping rate modifier. Can be negative. For example "value": "1", " currency" : "USD" adds $1 to the rate, "value": "-3", "currency" : "USD" removes $3 from the rate. Optional. Corresponds to the JSON property flatAdjustment

Returns:



1368
1369
1370
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1368

def flat_adjustment
  @flat_adjustment
end

#name ⇒ String

Name of the carrier rate. Must be unique per rate group. Required. Corresponds to the JSON property name

Returns:

  • (String) 


1373
1374
1375
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1373

def name
  @name
end

#origin_postal_code ⇒ String

Shipping origin for this carrier rate. Required. Corresponds to the JSON property originPostalCode

Returns:

  • (String) 


1378
1379
1380
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1378

def origin_postal_code
  @origin_postal_code
end

#percentage_adjustment ⇒ String

Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional. Corresponds to the JSON property percentageAdjustment

Returns:

  • (String) 


1385
1386
1387
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1385

def percentage_adjustment
  @percentage_adjustment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 1392

def update!(**args)
  @carrier_name = args[:carrier_name] if args.key?(:carrier_name)
  @carrier_service = args[:carrier_service] if args.key?(:carrier_service)
  @flat_adjustment = args[:flat_adjustment] if args.key?(:flat_adjustment)
  @name = args[:name] if args.key?(:name)
  @origin_postal_code = args[:origin_postal_code] if args.key?(:origin_postal_code)
  @percentage_adjustment = args[:percentage_adjustment] if args.key?(:percentage_adjustment)
end