Google Shopping Merchant Accounts V1 Client - Class PostalCodeRange (1.2.1)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class PostalCodeRange.

A range of postal codes that defines the region area.

Generated from protobuf message google.shopping.merchant.accounts.v1.Region.PostalCodeArea.PostalCodeRange

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1 \ Region \ PostalCodeArea

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ begin string

Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: 94108, 9410*, 9*.
↳ end string

Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.

getBegin

Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: 94108, 9410*, 9*.

Returns
Type Description
string

setBegin

Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: 94108, 9410*, 9*.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnd

Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.

Returns
Type Description
string

setEnd

Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.

Parameter
Name Description
var string
Returns
Type Description
$this