Class ProductAttributes.CarrierShipping.Builder (1.4.0)

public static final class ProductAttributes.CarrierShipping.Builder extends GeneratedMessageV3.Builder<ProductAttributes.CarrierShipping.Builder> implements ProductAttributes.CarrierShippingOrBuilder

Carrier-based shipping configuration. Allows for setting shipping speed or shipping cost based on a carrier's provided info.

Protobuf type google.shopping.merchant.products.v1.ProductAttributes.CarrierShipping

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProductAttributes.CarrierShipping.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides

build()

public ProductAttributes.CarrierShipping build()
Returns
Type Description
ProductAttributes.CarrierShipping

buildPartial()

public ProductAttributes.CarrierShipping buildPartial()
Returns
Type Description
ProductAttributes.CarrierShipping

clear()

public ProductAttributes.CarrierShipping.Builder clear()
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides

clearCarrierPrice()

public ProductAttributes.CarrierShipping.Builder clearCarrierPrice()

Selected carrier to calculate the shipping price from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Price will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate shipping price. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with flatPrice.

optional .google.shopping.merchant.products.v1.ProductAttributes.CarrierPriceOption carrier_price = 6;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearCarrierPriceFlatAdjustment()

public ProductAttributes.CarrierShipping.Builder clearCarrierPriceFlatAdjustment()

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

optional .google.shopping.type.Price carrier_price_flat_adjustment = 7;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

clearCarrierPricePercentageAdjustment()

public ProductAttributes.CarrierShipping.Builder clearCarrierPricePercentageAdjustment()

A percentual adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPriceFlatAdjustment.

optional double carrier_price_percentage_adjustment = 8;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearCarrierTransitTime()

public ProductAttributes.CarrierShipping.Builder clearCarrierTransitTime()

Selected carrier to calculate the shipping speed from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Speed will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate delivery speed. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with fixedMaxTransitTime or fixedMinTransitTime.

optional .google.shopping.merchant.products.v1.CarrierTransitTimeOption carrier_transit_time = 13;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearCountry()

public ProductAttributes.CarrierShipping.Builder clearCountry()

The CLDR territory code of the country to which an item will ship.

optional string country = 1;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ProductAttributes.CarrierShipping.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides

clearFixedMaxTransitTime()

public ProductAttributes.CarrierShipping.Builder clearFixedMaxTransitTime()

Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Needs to be provided together with maxHandlingTime. Cannot be set if carrierTransitTime is present.

optional int64 fixed_max_transit_time = 12;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearFixedMinTransitTime()

public ProductAttributes.CarrierShipping.Builder clearFixedMinTransitTime()

Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. fixedMinTransitTime can only be set if fixedMaxTransitTime is set. Cannot be set if carrierTransitTime is present.

optional int64 fixed_min_transit_time = 11;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearFlatPrice()

public ProductAttributes.CarrierShipping.Builder clearFlatPrice()

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

optional .google.shopping.type.Price flat_price = 5;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

clearMaxHandlingTime()

public ProductAttributes.CarrierShipping.Builder clearMaxHandlingTime()

Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and fixedMaxTransitTime or carrierTransitTime are required if providing shipping speeds.

optional int64 max_handling_time = 10;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearMinHandlingTime()

public ProductAttributes.CarrierShipping.Builder clearMinHandlingTime()

Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be set if maxHandlingTime is also set.

optional int64 min_handling_time = 9;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ProductAttributes.CarrierShipping.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides

clearOriginPostalCode()

public ProductAttributes.CarrierShipping.Builder clearOriginPostalCode()

The source location postal code from which this offer ships. Represented only by a full-length postal code.

optional string origin_postal_code = 4;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearPostalCode()

public ProductAttributes.CarrierShipping.Builder clearPostalCode()

The postal code range that the shipping rate applies to, represented by a postal code (eg. 94043), a postal code prefix followed by a * wildcard (eg. 94), a range between two postal codes (eg. 94043-98033) or two postal code prefixes of equal length (eg. 94-98*).

optional string postal_code = 3;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clearRegion()

public ProductAttributes.CarrierShipping.Builder clearRegion()

The geographic region to which a shipping rate applies. See region for more information.

optional string region = 2;

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

clone()

public ProductAttributes.CarrierShipping.Builder clone()
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides

getCarrierPrice()

public ProductAttributes.CarrierPriceOption getCarrierPrice()

Selected carrier to calculate the shipping price from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Price will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate shipping price. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with flatPrice.

optional .google.shopping.merchant.products.v1.ProductAttributes.CarrierPriceOption carrier_price = 6;

Returns
Type Description
ProductAttributes.CarrierPriceOption

The carrierPrice.

getCarrierPriceFlatAdjustment()

public Price getCarrierPriceFlatAdjustment()

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

optional .google.shopping.type.Price carrier_price_flat_adjustment = 7;

Returns
Type Description
com.google.shopping.type.Price

The carrierPriceFlatAdjustment.

getCarrierPriceFlatAdjustmentBuilder()

public Price.Builder getCarrierPriceFlatAdjustmentBuilder()

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

optional .google.shopping.type.Price carrier_price_flat_adjustment = 7;

Returns
Type Description
com.google.shopping.type.Price.Builder

getCarrierPriceFlatAdjustmentOrBuilder()

public PriceOrBuilder getCarrierPriceFlatAdjustmentOrBuilder()

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

optional .google.shopping.type.Price carrier_price_flat_adjustment = 7;

Returns
Type Description
com.google.shopping.type.PriceOrBuilder

getCarrierPricePercentageAdjustment()

public double getCarrierPricePercentageAdjustment()

A percentual adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPriceFlatAdjustment.

optional double carrier_price_percentage_adjustment = 8;

Returns
Type Description
double

The carrierPricePercentageAdjustment.

getCarrierPriceValue()

public int getCarrierPriceValue()

Selected carrier to calculate the shipping price from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Price will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate shipping price. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with flatPrice.

optional .google.shopping.merchant.products.v1.ProductAttributes.CarrierPriceOption carrier_price = 6;

Returns
Type Description
int

The enum numeric value on the wire for carrierPrice.

getCarrierTransitTime()

public CarrierTransitTimeOption getCarrierTransitTime()

Selected carrier to calculate the shipping speed from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Speed will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate delivery speed. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with fixedMaxTransitTime or fixedMinTransitTime.

optional .google.shopping.merchant.products.v1.CarrierTransitTimeOption carrier_transit_time = 13;

Returns
Type Description
CarrierTransitTimeOption

The carrierTransitTime.

getCarrierTransitTimeValue()

public int getCarrierTransitTimeValue()

Selected carrier to calculate the shipping speed from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Speed will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate delivery speed. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with fixedMaxTransitTime or fixedMinTransitTime.

optional .google.shopping.merchant.products.v1.CarrierTransitTimeOption carrier_transit_time = 13;

Returns
Type Description
int

The enum numeric value on the wire for carrierTransitTime.

getCountry()

public String getCountry()

The CLDR territory code of the country to which an item will ship.

optional string country = 1;

Returns
Type Description
String

The country.

getCountryBytes()

public ByteString getCountryBytes()

The CLDR territory code of the country to which an item will ship.

optional string country = 1;

Returns
Type Description
ByteString

The bytes for country.

getDefaultInstanceForType()

public ProductAttributes.CarrierShipping getDefaultInstanceForType()
Returns
Type Description
ProductAttributes.CarrierShipping

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFixedMaxTransitTime()

public long getFixedMaxTransitTime()

Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Needs to be provided together with maxHandlingTime. Cannot be set if carrierTransitTime is present.

optional int64 fixed_max_transit_time = 12;

Returns
Type Description
long

The fixedMaxTransitTime.

getFixedMinTransitTime()

public long getFixedMinTransitTime()

Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. fixedMinTransitTime can only be set if fixedMaxTransitTime is set. Cannot be set if carrierTransitTime is present.

optional int64 fixed_min_transit_time = 11;

Returns
Type Description
long

The fixedMinTransitTime.

getFlatPrice()

public Price getFlatPrice()

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

optional .google.shopping.type.Price flat_price = 5;

Returns
Type Description
com.google.shopping.type.Price

The flatPrice.

getFlatPriceBuilder()

public Price.Builder getFlatPriceBuilder()

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

optional .google.shopping.type.Price flat_price = 5;

Returns
Type Description
com.google.shopping.type.Price.Builder

getFlatPriceOrBuilder()

public PriceOrBuilder getFlatPriceOrBuilder()

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

optional .google.shopping.type.Price flat_price = 5;

Returns
Type Description
com.google.shopping.type.PriceOrBuilder

getMaxHandlingTime()

public long getMaxHandlingTime()

Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and fixedMaxTransitTime or carrierTransitTime are required if providing shipping speeds.

optional int64 max_handling_time = 10;

Returns
Type Description
long

The maxHandlingTime.

getMinHandlingTime()

public long getMinHandlingTime()

Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be set if maxHandlingTime is also set.

optional int64 min_handling_time = 9;

Returns
Type Description
long

The minHandlingTime.

getOriginPostalCode()

public String getOriginPostalCode()

The source location postal code from which this offer ships. Represented only by a full-length postal code.

optional string origin_postal_code = 4;

Returns
Type Description
String

The originPostalCode.

getOriginPostalCodeBytes()

public ByteString getOriginPostalCodeBytes()

The source location postal code from which this offer ships. Represented only by a full-length postal code.

optional string origin_postal_code = 4;

Returns
Type Description
ByteString

The bytes for originPostalCode.

getPostalCode()

public String getPostalCode()

The postal code range that the shipping rate applies to, represented by a postal code (eg. 94043), a postal code prefix followed by a * wildcard (eg. 94), a range between two postal codes (eg. 94043-98033) or two postal code prefixes of equal length (eg. 94-98*).

optional string postal_code = 3;

Returns
Type Description
String

The postalCode.

getPostalCodeBytes()

public ByteString getPostalCodeBytes()

The postal code range that the shipping rate applies to, represented by a postal code (eg. 94043), a postal code prefix followed by a * wildcard (eg. 94), a range between two postal codes (eg. 94043-98033) or two postal code prefixes of equal length (eg. 94-98*).

optional string postal_code = 3;

Returns
Type Description
ByteString

The bytes for postalCode.

getRegion()

public String getRegion()

The geographic region to which a shipping rate applies. See region for more information.

optional string region = 2;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

The geographic region to which a shipping rate applies. See region for more information.

optional string region = 2;

Returns
Type Description
ByteString

The bytes for region.

hasCarrierPrice()

public boolean hasCarrierPrice()

Selected carrier to calculate the shipping price from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Price will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate shipping price. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with flatPrice.

optional .google.shopping.merchant.products.v1.ProductAttributes.CarrierPriceOption carrier_price = 6;

Returns
Type Description
boolean

Whether the carrierPrice field is set.

hasCarrierPriceFlatAdjustment()

public boolean hasCarrierPriceFlatAdjustment()

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

optional .google.shopping.type.Price carrier_price_flat_adjustment = 7;

Returns
Type Description
boolean

Whether the carrierPriceFlatAdjustment field is set.

hasCarrierPricePercentageAdjustment()

public boolean hasCarrierPricePercentageAdjustment()

A percentual adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPriceFlatAdjustment.

optional double carrier_price_percentage_adjustment = 8;

Returns
Type Description
boolean

Whether the carrierPricePercentageAdjustment field is set.

hasCarrierTransitTime()

public boolean hasCarrierTransitTime()

Selected carrier to calculate the shipping speed from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Speed will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate delivery speed. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with fixedMaxTransitTime or fixedMinTransitTime.

optional .google.shopping.merchant.products.v1.CarrierTransitTimeOption carrier_transit_time = 13;

Returns
Type Description
boolean

Whether the carrierTransitTime field is set.

hasCountry()

public boolean hasCountry()

The CLDR territory code of the country to which an item will ship.

optional string country = 1;

Returns
Type Description
boolean

Whether the country field is set.

hasFixedMaxTransitTime()

public boolean hasFixedMaxTransitTime()

Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Needs to be provided together with maxHandlingTime. Cannot be set if carrierTransitTime is present.

optional int64 fixed_max_transit_time = 12;

Returns
Type Description
boolean

Whether the fixedMaxTransitTime field is set.

hasFixedMinTransitTime()

public boolean hasFixedMinTransitTime()

Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. fixedMinTransitTime can only be set if fixedMaxTransitTime is set. Cannot be set if carrierTransitTime is present.

optional int64 fixed_min_transit_time = 11;

Returns
Type Description
boolean

Whether the fixedMinTransitTime field is set.

hasFlatPrice()

public boolean hasFlatPrice()

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

optional .google.shopping.type.Price flat_price = 5;

Returns
Type Description
boolean

Whether the flatPrice field is set.

hasMaxHandlingTime()

public boolean hasMaxHandlingTime()

Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and fixedMaxTransitTime or carrierTransitTime are required if providing shipping speeds.

optional int64 max_handling_time = 10;

Returns
Type Description
boolean

Whether the maxHandlingTime field is set.

hasMinHandlingTime()

public boolean hasMinHandlingTime()

Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be set if maxHandlingTime is also set.

optional int64 min_handling_time = 9;

Returns
Type Description
boolean

Whether the minHandlingTime field is set.

hasOriginPostalCode()

public boolean hasOriginPostalCode()

The source location postal code from which this offer ships. Represented only by a full-length postal code.

optional string origin_postal_code = 4;

Returns
Type Description
boolean

Whether the originPostalCode field is set.

hasPostalCode()

public boolean hasPostalCode()

The postal code range that the shipping rate applies to, represented by a postal code (eg. 94043), a postal code prefix followed by a * wildcard (eg. 94), a range between two postal codes (eg. 94043-98033) or two postal code prefixes of equal length (eg. 94-98*).

optional string postal_code = 3;

Returns
Type Description
boolean

Whether the postalCode field is set.

hasRegion()

public boolean hasRegion()

The geographic region to which a shipping rate applies. See region for more information.

optional string region = 2;

Returns
Type Description
boolean

Whether the region field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCarrierPriceFlatAdjustment(Price value)

public ProductAttributes.CarrierShipping.Builder mergeCarrierPriceFlatAdjustment(Price value)

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

optional .google.shopping.type.Price carrier_price_flat_adjustment = 7;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
ProductAttributes.CarrierShipping.Builder

mergeFlatPrice(Price value)

public ProductAttributes.CarrierShipping.Builder mergeFlatPrice(Price value)

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

optional .google.shopping.type.Price flat_price = 5;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
ProductAttributes.CarrierShipping.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProductAttributes.CarrierShipping.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ProductAttributes.CarrierShipping.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides

mergeFrom(ProductAttributes.CarrierShipping other)

public ProductAttributes.CarrierShipping.Builder mergeFrom(ProductAttributes.CarrierShipping other)
Parameter
Name Description
other ProductAttributes.CarrierShipping
Returns
Type Description
ProductAttributes.CarrierShipping.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProductAttributes.CarrierShipping.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides

setCarrierPrice(ProductAttributes.CarrierPriceOption value)

public ProductAttributes.CarrierShipping.Builder setCarrierPrice(ProductAttributes.CarrierPriceOption value)

Selected carrier to calculate the shipping price from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Price will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate shipping price. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with flatPrice.

optional .google.shopping.merchant.products.v1.ProductAttributes.CarrierPriceOption carrier_price = 6;

Parameter
Name Description
value ProductAttributes.CarrierPriceOption

The carrierPrice to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setCarrierPriceFlatAdjustment(Price value)

public ProductAttributes.CarrierShipping.Builder setCarrierPriceFlatAdjustment(Price value)

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

optional .google.shopping.type.Price carrier_price_flat_adjustment = 7;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
ProductAttributes.CarrierShipping.Builder

setCarrierPriceFlatAdjustment(Price.Builder builderForValue)

public ProductAttributes.CarrierShipping.Builder setCarrierPriceFlatAdjustment(Price.Builder builderForValue)

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

optional .google.shopping.type.Price carrier_price_flat_adjustment = 7;

Parameter
Name Description
builderForValue com.google.shopping.type.Price.Builder
Returns
Type Description
ProductAttributes.CarrierShipping.Builder

setCarrierPricePercentageAdjustment(double value)

public ProductAttributes.CarrierShipping.Builder setCarrierPricePercentageAdjustment(double value)

A percentual adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPriceFlatAdjustment.

optional double carrier_price_percentage_adjustment = 8;

Parameter
Name Description
value double

The carrierPricePercentageAdjustment to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setCarrierPriceValue(int value)

public ProductAttributes.CarrierShipping.Builder setCarrierPriceValue(int value)

Selected carrier to calculate the shipping price from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Price will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate shipping price. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with flatPrice.

optional .google.shopping.merchant.products.v1.ProductAttributes.CarrierPriceOption carrier_price = 6;

Parameter
Name Description
value int

The enum numeric value on the wire for carrierPrice to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setCarrierTransitTime(CarrierTransitTimeOption value)

public ProductAttributes.CarrierShipping.Builder setCarrierTransitTime(CarrierTransitTimeOption value)

Selected carrier to calculate the shipping speed from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Speed will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate delivery speed. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with fixedMaxTransitTime or fixedMinTransitTime.

optional .google.shopping.merchant.products.v1.CarrierTransitTimeOption carrier_transit_time = 13;

Parameter
Name Description
value CarrierTransitTimeOption

The carrierTransitTime to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setCarrierTransitTimeValue(int value)

public ProductAttributes.CarrierShipping.Builder setCarrierTransitTimeValue(int value)

Selected carrier to calculate the shipping speed from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Speed will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate delivery speed. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with fixedMaxTransitTime or fixedMinTransitTime.

optional .google.shopping.merchant.products.v1.CarrierTransitTimeOption carrier_transit_time = 13;

Parameter
Name Description
value int

The enum numeric value on the wire for carrierTransitTime to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setCountry(String value)

public ProductAttributes.CarrierShipping.Builder setCountry(String value)

The CLDR territory code of the country to which an item will ship.

optional string country = 1;

Parameter
Name Description
value String

The country to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setCountryBytes(ByteString value)

public ProductAttributes.CarrierShipping.Builder setCountryBytes(ByteString value)

The CLDR territory code of the country to which an item will ship.

optional string country = 1;

Parameter
Name Description
value ByteString

The bytes for country to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ProductAttributes.CarrierShipping.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides

setFixedMaxTransitTime(long value)

public ProductAttributes.CarrierShipping.Builder setFixedMaxTransitTime(long value)

Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Needs to be provided together with maxHandlingTime. Cannot be set if carrierTransitTime is present.

optional int64 fixed_max_transit_time = 12;

Parameter
Name Description
value long

The fixedMaxTransitTime to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setFixedMinTransitTime(long value)

public ProductAttributes.CarrierShipping.Builder setFixedMinTransitTime(long value)

Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. fixedMinTransitTime can only be set if fixedMaxTransitTime is set. Cannot be set if carrierTransitTime is present.

optional int64 fixed_min_transit_time = 11;

Parameter
Name Description
value long

The fixedMinTransitTime to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setFlatPrice(Price value)

public ProductAttributes.CarrierShipping.Builder setFlatPrice(Price value)

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

optional .google.shopping.type.Price flat_price = 5;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
ProductAttributes.CarrierShipping.Builder

setFlatPrice(Price.Builder builderForValue)

public ProductAttributes.CarrierShipping.Builder setFlatPrice(Price.Builder builderForValue)

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

optional .google.shopping.type.Price flat_price = 5;

Parameter
Name Description
builderForValue com.google.shopping.type.Price.Builder
Returns
Type Description
ProductAttributes.CarrierShipping.Builder

setMaxHandlingTime(long value)

public ProductAttributes.CarrierShipping.Builder setMaxHandlingTime(long value)

Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and fixedMaxTransitTime or carrierTransitTime are required if providing shipping speeds.

optional int64 max_handling_time = 10;

Parameter
Name Description
value long

The maxHandlingTime to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setMinHandlingTime(long value)

public ProductAttributes.CarrierShipping.Builder setMinHandlingTime(long value)

Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be set if maxHandlingTime is also set.

optional int64 min_handling_time = 9;

Parameter
Name Description
value long

The minHandlingTime to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setOriginPostalCode(String value)

public ProductAttributes.CarrierShipping.Builder setOriginPostalCode(String value)

The source location postal code from which this offer ships. Represented only by a full-length postal code.

optional string origin_postal_code = 4;

Parameter
Name Description
value String

The originPostalCode to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setOriginPostalCodeBytes(ByteString value)

public ProductAttributes.CarrierShipping.Builder setOriginPostalCodeBytes(ByteString value)

The source location postal code from which this offer ships. Represented only by a full-length postal code.

optional string origin_postal_code = 4;

Parameter
Name Description
value ByteString

The bytes for originPostalCode to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setPostalCode(String value)

public ProductAttributes.CarrierShipping.Builder setPostalCode(String value)

The postal code range that the shipping rate applies to, represented by a postal code (eg. 94043), a postal code prefix followed by a * wildcard (eg. 94), a range between two postal codes (eg. 94043-98033) or two postal code prefixes of equal length (eg. 94-98*).

optional string postal_code = 3;

Parameter
Name Description
value String

The postalCode to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setPostalCodeBytes(ByteString value)

public ProductAttributes.CarrierShipping.Builder setPostalCodeBytes(ByteString value)

The postal code range that the shipping rate applies to, represented by a postal code (eg. 94043), a postal code prefix followed by a * wildcard (eg. 94), a range between two postal codes (eg. 94043-98033) or two postal code prefixes of equal length (eg. 94-98*).

optional string postal_code = 3;

Parameter
Name Description
value ByteString

The bytes for postalCode to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setRegion(String value)

public ProductAttributes.CarrierShipping.Builder setRegion(String value)

The geographic region to which a shipping rate applies. See region for more information.

optional string region = 2;

Parameter
Name Description
value String

The region to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public ProductAttributes.CarrierShipping.Builder setRegionBytes(ByteString value)

The geographic region to which a shipping rate applies. See region for more information.

optional string region = 2;

Parameter
Name Description
value ByteString

The bytes for region to set.

Returns
Type Description
ProductAttributes.CarrierShipping.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ProductAttributes.CarrierShipping.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ProductAttributes.CarrierShipping.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ProductAttributes.CarrierShipping.Builder
Overrides