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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the region. Format: |
↳ display_name |
string
Optional. The display name of the region. |
↳ postal_code_area |
Region\PostalCodeArea
Optional. A list of postal codes that defines the region area. |
↳ geotarget_area |
Region\GeoTargetArea
Optional. A list of geotargets that defines the region 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}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the region.
Format: accounts/{account}/regions/{region}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. The display name of the region.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayName
clearDisplayName
setDisplayName
Optional. The display name of the region.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPostalCodeArea
Optional. A list of postal codes that defines the region area.
| Returns | |
|---|---|
| Type | Description |
Region\PostalCodeArea|null |
|
hasPostalCodeArea
clearPostalCodeArea
setPostalCodeArea
Optional. A list of postal codes that defines the region area.
| Parameter | |
|---|---|
| Name | Description |
var |
Region\PostalCodeArea
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGeotargetArea
Optional. A list of geotargets that defines the region area.
| Returns | |
|---|---|
| Type | Description |
Region\GeoTargetArea|null |
|
hasGeotargetArea
clearGeotargetArea
setGeotargetArea
Optional. A list of geotargets that defines the region area.
| Parameter | |
|---|---|
| Name | Description |
var |
Region\GeoTargetArea
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegionalInventoryEligible
Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null |
|
hasRegionalInventoryEligible
clearRegionalInventoryEligible
getRegionalInventoryEligibleUnwrapped
Returns the unboxed value from getRegionalInventoryEligible()
Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
| Returns | |
|---|---|
| Type | Description |
bool|null |
|
setRegionalInventoryEligible
Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShippingEligible
Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null |
|
hasShippingEligible
clearShippingEligible
getShippingEligibleUnwrapped
Returns the unboxed value from getShippingEligible()
Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
| Returns | |
|---|---|
| Type | Description |
bool|null |
|
setShippingEligible
Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|