Class: Google::Shopping::Merchant::Accounts::V1::ShippingSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/accounts/v1/shippingsettings.rb

Overview

The Merchant Center account's shipping settings. The ShippingSettings resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts.

Instance Attribute Summary collapse

Instance Attribute Details

#etag ⇒ ::String

Returns Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the get call and the insert call. The user should follow these steps:

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

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

  3. Modify the shipping setting information.

  4. Call the insert method with the shipping setting information and the etag obtained in step 2.

  5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag.

Returns:

  • (::String) —

    Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the get call and the insert call. The user should follow these steps:

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

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

    3. Modify the shipping setting information.

    4. Call the insert method with the shipping setting information and the etag obtained in step 2.

    5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag.



62
63
64
65
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/shippingsettings.rb', line 62

class ShippingSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Identifier. The resource name of the shipping settings. Format: accounts/{account}/shippingSettings. For example, accounts/123456/shippingSettings.

Returns:

  • (::String) —

    Identifier. The resource name of the shipping settings. Format: accounts/{account}/shippingSettings. For example, accounts/123456/shippingSettings.



62
63
64
65
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/shippingsettings.rb', line 62

class ShippingSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#services ⇒ ::Array<::Google::Shopping::Merchant::Accounts::V1::Service>

Returns Optional. The target account's list of services.

Returns:



62
63
64
65
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/shippingsettings.rb', line 62

class ShippingSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#warehouses ⇒ ::Array<::Google::Shopping::Merchant::Accounts::V1::Warehouse>

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

Returns:



62
63
64
65
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/shippingsettings.rb', line 62

class ShippingSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end