Class: Google::Apis::ContentV2_1::Region

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

Overview

Represents a geographic region that you can use as a target with both the RegionalInventory and ShippingSettings services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Region

Returns a new instance of Region.



11827
11828
11829
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11827

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

Instance Attribute Details

#display_name ⇒ String

The display name of the region. Corresponds to the JSON property displayName

Returns:

  • (String) 


11789
11790
11791
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11789

def display_name
  @display_name
end

#geotarget_area ⇒ Google::Apis::ContentV2_1::RegionGeoTargetArea

A list of geotargets that defines the region area. Corresponds to the JSON property geotargetArea

Returns:



11794
11795
11796
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11794

def geotarget_area
  @geotarget_area
end

#merchant_id ⇒ Fixnum

Output only. Immutable. Merchant that owns the region. Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


11799
11800
11801
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11799

def merchant_id
  @merchant_id
end

#postal_code_area ⇒ Google::Apis::ContentV2_1::RegionPostalCodeArea

A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's ShippingSettings. postalCodeGroups resource. Corresponds to the JSON property postalCodeArea

Returns:



11806
11807
11808
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11806

def postal_code_area
  @postal_code_area
end

#region_id ⇒ String

Output only. Immutable. The ID uniquely identifying each region. Corresponds to the JSON property regionId

Returns:

  • (String) 


11811
11812
11813
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11811

def region_id
  @region_id
end

#regional_inventory_eligible ⇒ Boolean Also known as: regional_inventory_eligible?

Output only. Indicates if the region is eligible to use in the Regional Inventory configuration. Corresponds to the JSON property regionalInventoryEligible

Returns:

  • (Boolean) 


11817
11818
11819
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11817

def regional_inventory_eligible
  @regional_inventory_eligible
end

#shipping_eligible ⇒ Boolean Also known as: shipping_eligible?

Output only. Indicates if the region is eligible to use in the Shipping Services configuration. Corresponds to the JSON property shippingEligible

Returns:

  • (Boolean) 


11824
11825
11826
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11824

def shipping_eligible
  @shipping_eligible
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11832
11833
11834
11835
11836
11837
11838
11839
11840
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11832

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @geotarget_area = args[:geotarget_area] if args.key?(:geotarget_area)
  @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
  @postal_code_area = args[:postal_code_area] if args.key?(:postal_code_area)
  @region_id = args[:region_id] if args.key?(:region_id)
  @regional_inventory_eligible = args[:regional_inventory_eligible] if args.key?(:regional_inventory_eligible)
  @shipping_eligible = args[:shipping_eligible] if args.key?(:shipping_eligible)
end