Class InventoryLoyaltyProgram.Builder (1.19.0)

public static final class InventoryLoyaltyProgram.Builder extends GeneratedMessage.Builder<InventoryLoyaltyProgram.Builder> implements InventoryLoyaltyProgramOrBuilder

A message that represents loyalty program.

Protobuf type google.shopping.merchant.inventories.v1.InventoryLoyaltyProgram

Static Methods

getDescriptor()

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

Methods

build()

public InventoryLoyaltyProgram build()
Returns
Type Description
InventoryLoyaltyProgram

buildPartial()

public InventoryLoyaltyProgram buildPartial()
Returns
Type Description
InventoryLoyaltyProgram

clear()

public InventoryLoyaltyProgram.Builder clear()
Returns
Type Description
InventoryLoyaltyProgram.Builder
Overrides

clearCashbackForFutureUse()

public InventoryLoyaltyProgram.Builder clearCashbackForFutureUse()

The cashback that can be used for future purchases.

optional .google.shopping.type.Price cashback_for_future_use = 4;

Returns
Type Description
InventoryLoyaltyProgram.Builder

clearLoyaltyPoints()

public InventoryLoyaltyProgram.Builder clearLoyaltyPoints()

The amount of loyalty points earned on a purchase.

optional int64 loyalty_points = 5;

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

clearMemberPriceEffectiveInterval()

public InventoryLoyaltyProgram.Builder clearMemberPriceEffectiveInterval()

A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.

optional .google.type.Interval member_price_effective_interval = 6;

Returns
Type Description
InventoryLoyaltyProgram.Builder

clearPrice()

public InventoryLoyaltyProgram.Builder clearPrice()

The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.

optional .google.shopping.type.Price price = 3;

Returns
Type Description
InventoryLoyaltyProgram.Builder

clearProgramLabel()

public InventoryLoyaltyProgram.Builder clearProgramLabel()

The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account.

optional string program_label = 1;

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

clearShippingLabel()

public InventoryLoyaltyProgram.Builder clearShippingLabel()

The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.

optional string shipping_label = 7;

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

clearTierLabel()

public InventoryLoyaltyProgram.Builder clearTierLabel()

The label of the tier within the loyalty program. Must match one of the labels within the program.

optional string tier_label = 2;

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

getCashbackForFutureUse()

public Price getCashbackForFutureUse()

The cashback that can be used for future purchases.

optional .google.shopping.type.Price cashback_for_future_use = 4;

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

The cashbackForFutureUse.

getCashbackForFutureUseBuilder()

public Price.Builder getCashbackForFutureUseBuilder()

The cashback that can be used for future purchases.

optional .google.shopping.type.Price cashback_for_future_use = 4;

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

getCashbackForFutureUseOrBuilder()

public PriceOrBuilder getCashbackForFutureUseOrBuilder()

The cashback that can be used for future purchases.

optional .google.shopping.type.Price cashback_for_future_use = 4;

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

getDefaultInstanceForType()

public InventoryLoyaltyProgram getDefaultInstanceForType()
Returns
Type Description
InventoryLoyaltyProgram

getDescriptorForType()

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

getLoyaltyPoints()

public long getLoyaltyPoints()

The amount of loyalty points earned on a purchase.

optional int64 loyalty_points = 5;

Returns
Type Description
long

The loyaltyPoints.

getMemberPriceEffectiveInterval()

public Interval getMemberPriceEffectiveInterval()

A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.

optional .google.type.Interval member_price_effective_interval = 6;

Returns
Type Description
com.google.type.Interval

The memberPriceEffectiveInterval.

getMemberPriceEffectiveIntervalBuilder()

public Interval.Builder getMemberPriceEffectiveIntervalBuilder()

A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.

optional .google.type.Interval member_price_effective_interval = 6;

Returns
Type Description
com.google.type.Interval.Builder

getMemberPriceEffectiveIntervalOrBuilder()

public IntervalOrBuilder getMemberPriceEffectiveIntervalOrBuilder()

A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.

optional .google.type.Interval member_price_effective_interval = 6;

Returns
Type Description
com.google.type.IntervalOrBuilder

getPrice()

public Price getPrice()

The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.

optional .google.shopping.type.Price price = 3;

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

The price.

getPriceBuilder()

public Price.Builder getPriceBuilder()

The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.

optional .google.shopping.type.Price price = 3;

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

getPriceOrBuilder()

public PriceOrBuilder getPriceOrBuilder()

The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.

optional .google.shopping.type.Price price = 3;

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

getProgramLabel()

public String getProgramLabel()

The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account.

optional string program_label = 1;

Returns
Type Description
String

The programLabel.

getProgramLabelBytes()

public ByteString getProgramLabelBytes()

The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account.

optional string program_label = 1;

Returns
Type Description
ByteString

The bytes for programLabel.

getShippingLabel()

public String getShippingLabel()

The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.

optional string shipping_label = 7;

Returns
Type Description
String

The shippingLabel.

getShippingLabelBytes()

public ByteString getShippingLabelBytes()

The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.

optional string shipping_label = 7;

Returns
Type Description
ByteString

The bytes for shippingLabel.

getTierLabel()

public String getTierLabel()

The label of the tier within the loyalty program. Must match one of the labels within the program.

optional string tier_label = 2;

Returns
Type Description
String

The tierLabel.

getTierLabelBytes()

public ByteString getTierLabelBytes()

The label of the tier within the loyalty program. Must match one of the labels within the program.

optional string tier_label = 2;

Returns
Type Description
ByteString

The bytes for tierLabel.

hasCashbackForFutureUse()

public boolean hasCashbackForFutureUse()

The cashback that can be used for future purchases.

optional .google.shopping.type.Price cashback_for_future_use = 4;

Returns
Type Description
boolean

Whether the cashbackForFutureUse field is set.

hasLoyaltyPoints()

public boolean hasLoyaltyPoints()

The amount of loyalty points earned on a purchase.

optional int64 loyalty_points = 5;

Returns
Type Description
boolean

Whether the loyaltyPoints field is set.

hasMemberPriceEffectiveInterval()

public boolean hasMemberPriceEffectiveInterval()

A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.

optional .google.type.Interval member_price_effective_interval = 6;

Returns
Type Description
boolean

Whether the memberPriceEffectiveInterval field is set.

hasPrice()

public boolean hasPrice()

The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.

optional .google.shopping.type.Price price = 3;

Returns
Type Description
boolean

Whether the price field is set.

hasProgramLabel()

public boolean hasProgramLabel()

The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account.

optional string program_label = 1;

Returns
Type Description
boolean

Whether the programLabel field is set.

hasShippingLabel()

public boolean hasShippingLabel()

The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.

optional string shipping_label = 7;

Returns
Type Description
boolean

Whether the shippingLabel field is set.

hasTierLabel()

public boolean hasTierLabel()

The label of the tier within the loyalty program. Must match one of the labels within the program.

optional string tier_label = 2;

Returns
Type Description
boolean

Whether the tierLabel field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCashbackForFutureUse(Price value)

public InventoryLoyaltyProgram.Builder mergeCashbackForFutureUse(Price value)

The cashback that can be used for future purchases.

optional .google.shopping.type.Price cashback_for_future_use = 4;

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(InventoryLoyaltyProgram other)

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

mergeMemberPriceEffectiveInterval(Interval value)

public InventoryLoyaltyProgram.Builder mergeMemberPriceEffectiveInterval(Interval value)

A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.

optional .google.type.Interval member_price_effective_interval = 6;

Parameter
Name Description
value com.google.type.Interval
Returns
Type Description
InventoryLoyaltyProgram.Builder

mergePrice(Price value)

public InventoryLoyaltyProgram.Builder mergePrice(Price value)

The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.

optional .google.shopping.type.Price price = 3;

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

setCashbackForFutureUse(Price value)

public InventoryLoyaltyProgram.Builder setCashbackForFutureUse(Price value)

The cashback that can be used for future purchases.

optional .google.shopping.type.Price cashback_for_future_use = 4;

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

setCashbackForFutureUse(Price.Builder builderForValue)

public InventoryLoyaltyProgram.Builder setCashbackForFutureUse(Price.Builder builderForValue)

The cashback that can be used for future purchases.

optional .google.shopping.type.Price cashback_for_future_use = 4;

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

setLoyaltyPoints(long value)

public InventoryLoyaltyProgram.Builder setLoyaltyPoints(long value)

The amount of loyalty points earned on a purchase.

optional int64 loyalty_points = 5;

Parameter
Name Description
value long

The loyaltyPoints to set.

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

setMemberPriceEffectiveInterval(Interval value)

public InventoryLoyaltyProgram.Builder setMemberPriceEffectiveInterval(Interval value)

A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.

optional .google.type.Interval member_price_effective_interval = 6;

Parameter
Name Description
value com.google.type.Interval
Returns
Type Description
InventoryLoyaltyProgram.Builder

setMemberPriceEffectiveInterval(Interval.Builder builderForValue)

public InventoryLoyaltyProgram.Builder setMemberPriceEffectiveInterval(Interval.Builder builderForValue)

A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.

optional .google.type.Interval member_price_effective_interval = 6;

Parameter
Name Description
builderForValue com.google.type.Interval.Builder
Returns
Type Description
InventoryLoyaltyProgram.Builder

setPrice(Price value)

public InventoryLoyaltyProgram.Builder setPrice(Price value)

The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.

optional .google.shopping.type.Price price = 3;

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

setPrice(Price.Builder builderForValue)

public InventoryLoyaltyProgram.Builder setPrice(Price.Builder builderForValue)

The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.

optional .google.shopping.type.Price price = 3;

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

setProgramLabel(String value)

public InventoryLoyaltyProgram.Builder setProgramLabel(String value)

The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account.

optional string program_label = 1;

Parameter
Name Description
value String

The programLabel to set.

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

setProgramLabelBytes(ByteString value)

public InventoryLoyaltyProgram.Builder setProgramLabelBytes(ByteString value)

The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account.

optional string program_label = 1;

Parameter
Name Description
value ByteString

The bytes for programLabel to set.

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

setShippingLabel(String value)

public InventoryLoyaltyProgram.Builder setShippingLabel(String value)

The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.

optional string shipping_label = 7;

Parameter
Name Description
value String

The shippingLabel to set.

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

setShippingLabelBytes(ByteString value)

public InventoryLoyaltyProgram.Builder setShippingLabelBytes(ByteString value)

The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.

optional string shipping_label = 7;

Parameter
Name Description
value ByteString

The bytes for shippingLabel to set.

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

setTierLabel(String value)

public InventoryLoyaltyProgram.Builder setTierLabel(String value)

The label of the tier within the loyalty program. Must match one of the labels within the program.

optional string tier_label = 2;

Parameter
Name Description
value String

The tierLabel to set.

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.

setTierLabelBytes(ByteString value)

public InventoryLoyaltyProgram.Builder setTierLabelBytes(ByteString value)

The label of the tier within the loyalty program. Must match one of the labels within the program.

optional string tier_label = 2;

Parameter
Name Description
value ByteString

The bytes for tierLabel to set.

Returns
Type Description
InventoryLoyaltyProgram.Builder

This builder for chaining.