com.google.api.services.content.model

Class LoyaltyProgram

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.content.model.LoyaltyProgram

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class LoyaltyProgram
extends com.google.api.client.json.GenericJson

Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
LoyaltyProgram()

Method Summary

Modifier and Type	Method and Description
LoyaltyProgram	clone()
Price	getCashbackForFutureUse() Optional.
Long	getLoyaltyPoints() Optional.
String	getMemberPriceEffectiveDate() Optional.
Price	getPrice() Optional.
String	getProgramLabel() Required.
String	getShippingLabel() Optional.
String	getTierLabel() Required.
LoyaltyProgram	set(String fieldName, Object value)
LoyaltyProgram	setCashbackForFutureUse(Price cashbackForFutureUse) Optional.
LoyaltyProgram	setLoyaltyPoints(Long loyaltyPoints) Optional.
LoyaltyProgram	setMemberPriceEffectiveDate(String memberPriceEffectiveDate) Optional.
LoyaltyProgram	setPrice(Price price) Optional.
LoyaltyProgram	setProgramLabel(String programLabel) Required.
LoyaltyProgram	setShippingLabel(String shippingLabel) Optional.
LoyaltyProgram	setTierLabel(String tierLabel) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

LoyaltyProgram

public LoyaltyProgram()

Method Detail

getCashbackForFutureUse

public Price getCashbackForFutureUse()

Optional. The cashback that can be used for future purchases.

Returns:

value or null for none

setCashbackForFutureUse

public LoyaltyProgram setCashbackForFutureUse(Price cashbackForFutureUse)

Optional. The cashback that can be used for future purchases.

Parameters:

cashbackForFutureUse - cashbackForFutureUse or null for none

getLoyaltyPoints

public Long getLoyaltyPoints()

Optional. The amount of loyalty points earned on a purchase.

Returns:

value or null for none

setLoyaltyPoints

public LoyaltyProgram setLoyaltyPoints(Long loyaltyPoints)

Optional. The amount of loyalty points earned on a purchase.

Parameters:

loyaltyPoints - loyaltyPoints or null for none

getMemberPriceEffectiveDate

public String getMemberPriceEffectiveDate()

Optional. 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.

Returns:

value or null for none

setMemberPriceEffectiveDate

public LoyaltyProgram setMemberPriceEffectiveDate(String memberPriceEffectiveDate)

Optional. 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.

Parameters:

memberPriceEffectiveDate - memberPriceEffectiveDate or null for none

getPrice

public Price getPrice()

Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.

Returns:

value or null for none

setPrice

public LoyaltyProgram setPrice(Price price)

Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.

Parameters:

price - price or null for none

getProgramLabel

public String getProgramLabel()

Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.

Returns:

value or null for none

setProgramLabel

public LoyaltyProgram setProgramLabel(String programLabel)

Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.

Parameters:

programLabel - programLabel or null for none

getShippingLabel

public String getShippingLabel()

Optional. The shipping label for the loyalty program. You can use this label to indicate whether this offer has the loyalty shipping benefit. If not specified, the item is not eligible for loyalty shipping for the given loyalty tier.

Returns:

value or null for none

setShippingLabel

public LoyaltyProgram setShippingLabel(String shippingLabel)

Optional. The shipping label for the loyalty program. You can use this label to indicate whether this offer has the loyalty shipping benefit. If not specified, the item is not eligible for loyalty shipping for the given loyalty tier.

Parameters:

shippingLabel - shippingLabel or null for none

getTierLabel

public String getTierLabel()

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

Returns:

value or null for none

setTierLabel

public LoyaltyProgram setTierLabel(String tierLabel)

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

Parameters:

tierLabel - tierLabel or null for none

set

public LoyaltyProgram set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public LoyaltyProgram clone()

Overrides:

clone in class com.google.api.client.json.GenericJson