Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class Region.
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.
Generated from protobuf message google.shopping.merchant.accounts.v1beta.Region
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The resource name of the region. Format: accounts/{account}/regions/{region}
↳ display_name
string
Optional. The display name of the region.
↳ postal_code_area
↳ geotarget_area
↳ regional_inventory_eligible
Google\Protobuf\BoolValue
Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
↳ shipping_eligible
Google\Protobuf\BoolValue
Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
getName
Identifier. The resource name of the region.
Format: accounts/{account}/regions/{region}
string
setName
Identifier. The resource name of the region.
Format: accounts/{account}/regions/{region}
var
string
$this
getDisplayName
Optional. The display name of the region.
string
hasDisplayName
clearDisplayName
setDisplayName
Optional. The display name of the region.
var
string
$this
getPostalCodeArea
Optional. A list of postal codes that defines the region area.
hasPostalCodeArea
clearPostalCodeArea
setPostalCodeArea
Optional. A list of postal codes that defines the region area.
$this
getGeotargetArea
Optional. A list of geotargets that defines the region area.
hasGeotargetArea
clearGeotargetArea
setGeotargetArea
Optional. A list of geotargets that defines the region area.
$this
getRegionalInventoryEligible
Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
hasRegionalInventoryEligible
clearRegionalInventoryEligible
getRegionalInventoryEligibleUnwrapped
Returns the unboxed value from getRegionalInventoryEligible()
Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
bool|null
setRegionalInventoryEligible
Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
$this
setRegionalInventoryEligibleUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
var
bool|null
$this
getShippingEligible
Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
hasShippingEligible
clearShippingEligible
getShippingEligibleUnwrapped
Returns the unboxed value from getShippingEligible()
Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
bool|null
setShippingEligible
Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
$this
setShippingEligibleUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
var
bool|null
$this
