Reference documentation and code samples for the Google Shopping Merchant Products V1beta Client class Shipping.
The Shipping of the product.
Generated from protobuf message google.shopping.merchant.products.v1beta.Shipping
Namespace
Google \ Shopping \ Merchant \ Products \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ price |
Google\Shopping\Type\Price
Fixed shipping price, represented as a number. |
↳ country |
string
The CLDR territory code of the country to which an item will ship. |
↳ region |
string
The geographic region to which a shipping rate applies. See region for more information. |
↳ service |
string
A free-form description of the service class or delivery speed. |
↳ location_id |
int|string
The numeric ID of a location that the shipping rate applies to as defined in the AdWords API. |
↳ location_group_name |
string
The location where the shipping is applicable, represented by a location group name. |
↳ postal_code |
string
The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length. |
↳ min_handling_time |
int|string
Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present. |
↳ max_handling_time |
int|string
Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present. |
↳ min_transit_time |
int|string
Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it is not required if maxTransitTime is present. |
↳ max_transit_time |
int|string
Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present. |
getPrice
Fixed shipping price, represented as a number.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasPrice
clearPrice
setPrice
Fixed shipping price, represented as a number.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCountry
The CLDR territory code of the country to which an item will ship.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCountry
The CLDR territory code of the country to which an item will ship.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegion
The geographic region to which a shipping rate applies.
See region for more information.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRegion
The geographic region to which a shipping rate applies.
See region for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getService
A free-form description of the service class or delivery speed.
| Returns | |
|---|---|
| Type | Description |
string |
|
setService
A free-form description of the service class or delivery speed.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocationId
The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setLocationId
The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocationGroupName
The location where the shipping is applicable, represented by a location group name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLocationGroupName
The location where the shipping is applicable, represented by a location group name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPostalCode
The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPostalCode
The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinHandlingTime
Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time.
minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMinHandlingTime
clearMinHandlingTime
setMinHandlingTime
Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time.
minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxHandlingTime
Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
minHandlingTime is optional if maxHandlingTime is present.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMaxHandlingTime
clearMaxHandlingTime
setMaxHandlingTime
Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
minHandlingTime is optional if maxHandlingTime is present.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinTransitTime
Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships.
minTransitTime can only be present together with maxTransitTime; but it is not required if maxTransitTime is present.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMinTransitTime
clearMinTransitTime
setMinTransitTime
Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships.
minTransitTime can only be present together with maxTransitTime; but it is not required if maxTransitTime is present.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxTransitTime
Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
minTransitTime is optional if maxTransitTime is present.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMaxTransitTime
clearMaxTransitTime
setMaxTransitTime
Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
minTransitTime is optional if maxTransitTime is present.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|