Google Shopping Merchant Accounts V1beta Client - Class RateGroup (0.3.1)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class RateGroup.

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.

Generated from protobuf message google.shopping.merchant.accounts.v1beta.RateGroup

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ applicable_shipping_labels`	`array` Required. A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service.
`↳ single_value`	`Value` The value of the rate group (For example flat rate $10). Can only be set if `main_table` and `subtables` are not set.
`↳ main_table`	`Table` A table defining the rate group, when `single_value` is not expressive enough. Can only be set if `single_value` is not set.
`↳ subtables`	`array<Table>` Optional. A list of subtables referred to by `main_table`. Can only be set if `main_table` is set.
`↳ carrier_rates`	`array<CarrierRate>` Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
`↳ name`	`string` Optional. Name of the rate group. If set has to be unique within shipping service.

getApplicableShippingLabels

Required. A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setApplicableShippingLabels

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getSingleValue

The value of the rate group (For example flat rate $10). Can only be set if main_table and subtables are not set.

Returns
Type	Description
`Value\|null`

hasSingleValue

clearSingleValue

setSingleValue

The value of the rate group (For example flat rate $10). Can only be set if main_table and subtables are not set.

Parameter
Name	Description
`var`	`Value`

Returns
Type	Description
`$this`

getMainTable

A table defining the rate group, when single_value is not expressive enough. Can only be set if single_value is not set.

Returns
Type	Description
`Table\|null`

hasMainTable

clearMainTable

setMainTable

A table defining the rate group, when single_value is not expressive enough. Can only be set if single_value is not set.

Parameter
Name	Description
`var`	`Table`

Returns
Type	Description
`$this`

getSubtables

Optional. A list of subtables referred to by main_table. Can only be set if main_table is set.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSubtables

Optional. A list of subtables referred to by main_table. Can only be set if main_table is set.

Parameter
Name	Description
`var`	`array<Table>`

Returns
Type	Description
`$this`

getCarrierRates

Optional. A list of carrier rates that can be referred to by main_table or single_value.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCarrierRates

Optional. A list of carrier rates that can be referred to by main_table or single_value.

Parameter
Name	Description
`var`	`array<CarrierRate>`

Returns
Type	Description
`$this`

getName

Optional. Name of the rate group.

If set has to be unique within shipping service.

Returns
Type	Description
`string`

hasName

clearName

setName

Optional. Name of the rate group.

If set has to be unique within shipping service.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`