Class: Google::Apis::MerchantapiAccountsV1beta::Region

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/merchantapi_accounts_v1beta/classes.rb,
lib/google/apis/merchantapi_accounts_v1beta/representations.rb,
lib/google/apis/merchantapi_accounts_v1beta/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. For more information, see Set up regions for more information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Region

Returns a new instance of Region.



2144
2145
2146
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2144

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

Instance Attribute Details

#display_name ⇒ String

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

Returns:

  • (String) 


2110
2111
2112
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2110

def display_name
  @display_name
end

#geotarget_area ⇒ Google::Apis::MerchantapiAccountsV1beta::GeoTargetArea

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

Returns:



2115
2116
2117
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2115

def geotarget_area
  @geotarget_area
end

#name ⇒ String

Identifier. The resource name of the region. Format: accounts/account/ regions/region` Corresponds to the JSON propertyname`

Returns:

  • (String) 


2121
2122
2123
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2121

def name
  @name
end

#postal_code_area ⇒ Google::Apis::MerchantapiAccountsV1beta::PostalCodeArea

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

Returns:



2128
2129
2130
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2128

def postal_code_area
  @postal_code_area
end

#regional_inventory_eligible ⇒ Boolean Also known as: regional_inventory_eligible?

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

Returns:

  • (Boolean) 


2134
2135
2136
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2134

def regional_inventory_eligible
  @regional_inventory_eligible
end

#shipping_eligible ⇒ Boolean Also known as: shipping_eligible?

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

Returns:

  • (Boolean) 


2141
2142
2143
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2141

def shipping_eligible
  @shipping_eligible
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2149
2150
2151
2152
2153
2154
2155
2156
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2149

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