Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class Service.
Shipping service.
Generated from protobuf message google.shopping.merchant.accounts.v1beta.Service
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ service_name |
string
Required. Free-form name of the service. Must be unique within target account. |
↳ active |
bool
Required. A boolean exposing the active status of the shipping service. |
↳ delivery_countries |
array
Required. The CLDR territory code of the countries to which the service applies. |
↳ currency_code |
string
The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. |
↳ delivery_time |
Google\Shopping\Merchant\Accounts\V1beta\DeliveryTime
Required. Time spent in various aspects from order to the delivery of the product. |
↳ rate_groups |
array<Google\Shopping\Merchant\Accounts\V1beta\RateGroup>
Optional. Shipping rate group definitions. Only the last one is allowed to have an empty |
↳ shipment_type |
int
Type of locations this service ships orders to. |
↳ minimum_order_value |
Google\Shopping\Type\Price
Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. |
↳ minimum_order_value_table |
Google\Shopping\Merchant\Accounts\V1beta\MinimumOrderValueTable
Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value. |
↳ store_config |
Google\Shopping\Merchant\Accounts\V1beta\Service\StoreConfig
A list of stores your products are delivered from. This is only valid for the local delivery shipment type. |
↳ loyalty_programs |
array<Google\Shopping\Merchant\Accounts\V1beta\Service\LoyaltyProgram>
Optional. Loyalty programs that this shipping service is limited to. |
getServiceName
Required. Free-form name of the service. Must be unique within target account.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasServiceName
clearServiceName
setServiceName
Required. Free-form name of the service. Must be unique within target account.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getActive
Required. A boolean exposing the active status of the shipping service.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasActive
clearActive
setActive
Required. A boolean exposing the active status of the shipping service.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeliveryCountries
Required. The CLDR territory code of the countries to which the service applies.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDeliveryCountries
Required. The CLDR territory code of the countries to which the service applies.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCurrencyCode
The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCurrencyCode
clearCurrencyCode
setCurrencyCode
The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeliveryTime
Required. Time spent in various aspects from order to the delivery of the product.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Accounts\V1beta\DeliveryTime|null |
|
hasDeliveryTime
clearDeliveryTime
setDeliveryTime
Required. Time spent in various aspects from order to the delivery of the product.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Merchant\Accounts\V1beta\DeliveryTime
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRateGroups
Optional. Shipping rate group definitions. Only the last one is allowed to
have an empty applicable_shipping_labels, which means "everything else".
The other applicable_shipping_labels must not overlap.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setRateGroups
Optional. Shipping rate group definitions. Only the last one is allowed to
have an empty applicable_shipping_labels, which means "everything else".
The other applicable_shipping_labels must not overlap.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Shopping\Merchant\Accounts\V1beta\RateGroup>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShipmentType
Type of locations this service ships orders to.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasShipmentType
clearShipmentType
setShipmentType
Type of locations this service ships orders to.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinimumOrderValue
Minimum order value for this service. If set, indicates that customers will have to spend at least this amount.
All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasMinimumOrderValue
clearMinimumOrderValue
setMinimumOrderValue
Minimum order value for this service. If set, indicates that customers will have to spend at least this amount.
All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinimumOrderValueTable
Table of per store minimum order values for the pickup fulfillment type.
Cannot be set together with minimum_order_value.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Accounts\V1beta\MinimumOrderValueTable|null |
|
hasMinimumOrderValueTable
clearMinimumOrderValueTable
setMinimumOrderValueTable
Table of per store minimum order values for the pickup fulfillment type.
Cannot be set together with minimum_order_value.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Merchant\Accounts\V1beta\MinimumOrderValueTable
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStoreConfig
A list of stores your products are delivered from.
This is only valid for the local delivery shipment type.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Accounts\V1beta\Service\StoreConfig|null |
|
hasStoreConfig
clearStoreConfig
setStoreConfig
A list of stores your products are delivered from.
This is only valid for the local delivery shipment type.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Merchant\Accounts\V1beta\Service\StoreConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoyaltyPrograms
Optional. Loyalty programs that this shipping service is limited to.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setLoyaltyPrograms
Optional. Loyalty programs that this shipping service is limited to.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Shopping\Merchant\Accounts\V1beta\Service\LoyaltyProgram>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|