Interface ProductAttributes.CarrierShippingOrBuilder (1.4.0)

public static interface ProductAttributes.CarrierShippingOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCarrierPrice()

public abstract 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 abstract 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.

getCarrierPriceFlatAdjustmentOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getFixedMaxTransitTime()

public abstract 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 abstract 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 abstract 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.

getFlatPriceOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.