Google Shopping Merchant Accounts V1beta Client - Class ShippingSettings (0.3.2)

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

The merchant account's shipping setting.

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

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Identifier. The resource name of the shipping setting. Format: accounts/{account}/shippingSetting
↳ services array<Service>

Optional. The target account's list of services.
↳ warehouses array<Warehouse>

Optional. A list of warehouses which can be referred to in services.
↳ etag string

Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps： 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.

getName

Identifier. The resource name of the shipping setting.

Format: accounts/{account}/shippingSetting

Returns
Type Description
string

setName

Identifier. The resource name of the shipping setting.

Format: accounts/{account}/shippingSetting

Parameter
Name Description
var string
Returns
Type Description
$this

getServices

Optional. The target account's list of services.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setServices

Optional. The target account's list of services.

Parameter
Name Description
var array<Service>
Returns
Type Description
$this

getWarehouses

Optional. A list of warehouses which can be referred to in services.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setWarehouses

Optional. A list of warehouses which can be referred to in services.

Parameter
Name Description
var array<Warehouse>
Returns
Type Description
$this

getEtag

Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps：

  1. Set etag field as empty string for initial shipping setting creation.

  2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert.

  3. Modify to wanted shipping setting information.
  4. Call insert method with the wanted shipping setting information with the etag obtained from step 2.
  5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.
Returns
Type Description
string

setEtag

Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps：

  1. Set etag field as empty string for initial shipping setting creation.

  2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert.

  3. Modify to wanted shipping setting information.
  4. Call insert method with the wanted shipping setting information with the etag obtained from step 2.
  5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.
Parameter
Name Description
var string
Returns
Type Description
$this