Class: Google::Shopping::Merchant::Accounts::V1beta::Region

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/accounts/v1beta/regions.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.

Defined Under Namespace

Classes: GeoTargetArea, PostalCodeArea

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String

Returns Optional. The display name of the region.

Returns:

  • (::String) —

    Optional. The display name of the region.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/regions.rb', line 139

class Region
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. [CLDR territory
  #     code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)
  #     or the country the postal code group applies to.
  # @!attribute [rw] postal_codes
  #   @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Region::PostalCodeArea::PostalCodeRange>]
  #     Required. A range of postal codes.
  class PostalCodeArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A range of postal codes that defines the region area.
    # @!attribute [rw] begin
    #   @return [::String]
    #     Required. A postal code or a pattern of the form prefix* denoting the
    #     inclusive lower bound of the range defining the area. Examples values:
    #     `94108`, `9410*`, `9*`.
    # @!attribute [rw] end
    #   @return [::String]
    #     Optional. A postal code or a pattern of the form `prefix*` denoting the
    #     inclusive upper bound of the range defining the area. It must have the
    #     same length as postalCodeRangeBegin: if postalCodeRangeBegin is a
    #     postal code then postalCodeRangeEnd must be a postal code too; if
    #     postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a
    #     pattern with the same prefix length. Optional: if not set, then the
    #     area is defined as being all the postal codes matching
    #     postalCodeRangeBegin.
    class PostalCodeRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A list of geotargets that defines the region area.
  # @!attribute [rw] geotarget_criteria_ids
  #   @return [::Array<::Integer>]
  #     Required. A non-empty list of [location
  #     IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
  #     They must all be of the same location type (for example, state).
  class GeoTargetArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#geotarget_area ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region::GeoTargetArea

Returns Optional. A list of geotargets that defines the region area.

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/regions.rb', line 139

class Region
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. [CLDR territory
  #     code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)
  #     or the country the postal code group applies to.
  # @!attribute [rw] postal_codes
  #   @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Region::PostalCodeArea::PostalCodeRange>]
  #     Required. A range of postal codes.
  class PostalCodeArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A range of postal codes that defines the region area.
    # @!attribute [rw] begin
    #   @return [::String]
    #     Required. A postal code or a pattern of the form prefix* denoting the
    #     inclusive lower bound of the range defining the area. Examples values:
    #     `94108`, `9410*`, `9*`.
    # @!attribute [rw] end
    #   @return [::String]
    #     Optional. A postal code or a pattern of the form `prefix*` denoting the
    #     inclusive upper bound of the range defining the area. It must have the
    #     same length as postalCodeRangeBegin: if postalCodeRangeBegin is a
    #     postal code then postalCodeRangeEnd must be a postal code too; if
    #     postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a
    #     pattern with the same prefix length. Optional: if not set, then the
    #     area is defined as being all the postal codes matching
    #     postalCodeRangeBegin.
    class PostalCodeRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A list of geotargets that defines the region area.
  # @!attribute [rw] geotarget_criteria_ids
  #   @return [::Array<::Integer>]
  #     Required. A non-empty list of [location
  #     IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
  #     They must all be of the same location type (for example, state).
  class GeoTargetArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Identifier. The resource name of the region. Format: accounts/{account}/regions/{region}.

Returns:

  • (::String) —

    Identifier. The resource name of the region. Format: accounts/{account}/regions/{region}



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/regions.rb', line 139

class Region
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. [CLDR territory
  #     code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)
  #     or the country the postal code group applies to.
  # @!attribute [rw] postal_codes
  #   @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Region::PostalCodeArea::PostalCodeRange>]
  #     Required. A range of postal codes.
  class PostalCodeArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A range of postal codes that defines the region area.
    # @!attribute [rw] begin
    #   @return [::String]
    #     Required. A postal code or a pattern of the form prefix* denoting the
    #     inclusive lower bound of the range defining the area. Examples values:
    #     `94108`, `9410*`, `9*`.
    # @!attribute [rw] end
    #   @return [::String]
    #     Optional. A postal code or a pattern of the form `prefix*` denoting the
    #     inclusive upper bound of the range defining the area. It must have the
    #     same length as postalCodeRangeBegin: if postalCodeRangeBegin is a
    #     postal code then postalCodeRangeEnd must be a postal code too; if
    #     postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a
    #     pattern with the same prefix length. Optional: if not set, then the
    #     area is defined as being all the postal codes matching
    #     postalCodeRangeBegin.
    class PostalCodeRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A list of geotargets that defines the region area.
  # @!attribute [rw] geotarget_criteria_ids
  #   @return [::Array<::Integer>]
  #     Required. A non-empty list of [location
  #     IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
  #     They must all be of the same location type (for example, state).
  class GeoTargetArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#postal_code_area ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Region::PostalCodeArea

Returns Optional. A list of postal codes that defines the region area.

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/regions.rb', line 139

class Region
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. [CLDR territory
  #     code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)
  #     or the country the postal code group applies to.
  # @!attribute [rw] postal_codes
  #   @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Region::PostalCodeArea::PostalCodeRange>]
  #     Required. A range of postal codes.
  class PostalCodeArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A range of postal codes that defines the region area.
    # @!attribute [rw] begin
    #   @return [::String]
    #     Required. A postal code or a pattern of the form prefix* denoting the
    #     inclusive lower bound of the range defining the area. Examples values:
    #     `94108`, `9410*`, `9*`.
    # @!attribute [rw] end
    #   @return [::String]
    #     Optional. A postal code or a pattern of the form `prefix*` denoting the
    #     inclusive upper bound of the range defining the area. It must have the
    #     same length as postalCodeRangeBegin: if postalCodeRangeBegin is a
    #     postal code then postalCodeRangeEnd must be a postal code too; if
    #     postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a
    #     pattern with the same prefix length. Optional: if not set, then the
    #     area is defined as being all the postal codes matching
    #     postalCodeRangeBegin.
    class PostalCodeRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A list of geotargets that defines the region area.
  # @!attribute [rw] geotarget_criteria_ids
  #   @return [::Array<::Integer>]
  #     Required. A non-empty list of [location
  #     IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
  #     They must all be of the same location type (for example, state).
  class GeoTargetArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#regional_inventory_eligible ⇒ ::Google::Protobuf::BoolValue (readonly)

Returns Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/regions.rb', line 139

class Region
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. [CLDR territory
  #     code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)
  #     or the country the postal code group applies to.
  # @!attribute [rw] postal_codes
  #   @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Region::PostalCodeArea::PostalCodeRange>]
  #     Required. A range of postal codes.
  class PostalCodeArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A range of postal codes that defines the region area.
    # @!attribute [rw] begin
    #   @return [::String]
    #     Required. A postal code or a pattern of the form prefix* denoting the
    #     inclusive lower bound of the range defining the area. Examples values:
    #     `94108`, `9410*`, `9*`.
    # @!attribute [rw] end
    #   @return [::String]
    #     Optional. A postal code or a pattern of the form `prefix*` denoting the
    #     inclusive upper bound of the range defining the area. It must have the
    #     same length as postalCodeRangeBegin: if postalCodeRangeBegin is a
    #     postal code then postalCodeRangeEnd must be a postal code too; if
    #     postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a
    #     pattern with the same prefix length. Optional: if not set, then the
    #     area is defined as being all the postal codes matching
    #     postalCodeRangeBegin.
    class PostalCodeRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A list of geotargets that defines the region area.
  # @!attribute [rw] geotarget_criteria_ids
  #   @return [::Array<::Integer>]
  #     Required. A non-empty list of [location
  #     IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
  #     They must all be of the same location type (for example, state).
  class GeoTargetArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#shipping_eligible ⇒ ::Google::Protobuf::BoolValue (readonly)

Returns Output only. Indicates if the region is eligible for use in the Shipping Services configuration.

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/regions.rb', line 139

class Region
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  # @!attribute [rw] region_code
  #   @return [::String]
  #     Required. [CLDR territory
  #     code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)
  #     or the country the postal code group applies to.
  # @!attribute [rw] postal_codes
  #   @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Region::PostalCodeArea::PostalCodeRange>]
  #     Required. A range of postal codes.
  class PostalCodeArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A range of postal codes that defines the region area.
    # @!attribute [rw] begin
    #   @return [::String]
    #     Required. A postal code or a pattern of the form prefix* denoting the
    #     inclusive lower bound of the range defining the area. Examples values:
    #     `94108`, `9410*`, `9*`.
    # @!attribute [rw] end
    #   @return [::String]
    #     Optional. A postal code or a pattern of the form `prefix*` denoting the
    #     inclusive upper bound of the range defining the area. It must have the
    #     same length as postalCodeRangeBegin: if postalCodeRangeBegin is a
    #     postal code then postalCodeRangeEnd must be a postal code too; if
    #     postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a
    #     pattern with the same prefix length. Optional: if not set, then the
    #     area is defined as being all the postal codes matching
    #     postalCodeRangeBegin.
    class PostalCodeRange
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A list of geotargets that defines the region area.
  # @!attribute [rw] geotarget_criteria_ids
  #   @return [::Array<::Integer>]
  #     Required. A non-empty list of [location
  #     IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
  #     They must all be of the same location type (for example, state).
  class GeoTargetArea
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end