RepricingRule (Content API for Shopping v2.1-rev20231105-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class RepricingRule
extends com.google.api.client.json.GenericJson
```
*Deprecated*: New merchants can't start using this resource. Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met.
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

RepricingRule()

Constructors
Constructor and Description
`RepricingRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RepricingRule`	`clone()`
`RepricingRuleCostOfGoodsSaleRule`	`getCogsBasedRule()` The rule definition for TYPE_COGS_BASED.
`String`	`getCountryCode()` Required.
`RepricingRuleEffectiveTime`	`getEffectiveTimePeriod()` Required.
`RepricingRuleEligibleOfferMatcher`	`getEligibleOfferMatcher()` Required.
`String`	`getLanguageCode()` Required.
`Long`	`getMerchantId()` Output only.
`Boolean`	`getPaused()` Represents whether a rule is paused.
`RepricingRuleRestriction`	`getRestriction()` Required.
`String`	`getRuleId()` Output only.
`RepricingRuleStatsBasedRule`	`getStatsBasedRule()` The rule definition for TYPE_STATS_BASED.
`String`	`getTitle()` The title for the rule.
`String`	`getType()` Required.
`RepricingRule`	`set(String fieldName, Object value)`
`RepricingRule`	`setCogsBasedRule(RepricingRuleCostOfGoodsSaleRule cogsBasedRule)` The rule definition for TYPE_COGS_BASED.
`RepricingRule`	`setCountryCode(String countryCode)` Required.
`RepricingRule`	`setEffectiveTimePeriod(RepricingRuleEffectiveTime effectiveTimePeriod)` Required.
`RepricingRule`	`setEligibleOfferMatcher(RepricingRuleEligibleOfferMatcher eligibleOfferMatcher)` Required.
`RepricingRule`	`setLanguageCode(String languageCode)` Required.
`RepricingRule`	`setMerchantId(Long merchantId)` Output only.
`RepricingRule`	`setPaused(Boolean paused)` Represents whether a rule is paused.
`RepricingRule`	`setRestriction(RepricingRuleRestriction restriction)` Required.
`RepricingRule`	`setRuleId(String ruleId)` Output only.
`RepricingRule`	`setStatsBasedRule(RepricingRuleStatsBasedRule statsBasedRule)` The rule definition for TYPE_STATS_BASED.
`RepricingRule`	`setTitle(String title)` The title for the rule.
`RepricingRule`	`setType(String type)` 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
  - RepricingRule
```
public RepricingRule()
```
- Method Detail
  - getCogsBasedRule
```
public RepricingRuleCostOfGoodsSaleRule getCogsBasedRule()
```
    The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED.
    
    Returns:
    
    value or null for none
  - setCogsBasedRule
```
public RepricingRule setCogsBasedRule(RepricingRuleCostOfGoodsSaleRule cogsBasedRule)
```
    The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED.
    
    Parameters:
    
    cogsBasedRule - cogsBasedRule or null for none
  - getCountryCode
```
public String getCountryCode()
```
    Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US").
    
    Returns:
    
    value or null for none
  - setCountryCode
```
public RepricingRule setCountryCode(String countryCode)
```
    Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US").
    
    Parameters:
    
    countryCode - countryCode or null for none
  - getEffectiveTimePeriod
```
public RepricingRuleEffectiveTime getEffectiveTimePeriod()
```
    Required. Time period when the rule should take effect.
    
    Returns:
    
    value or null for none
  - setEffectiveTimePeriod
```
public RepricingRule setEffectiveTimePeriod(RepricingRuleEffectiveTime effectiveTimePeriod)
```
    Required. Time period when the rule should take effect.
    
    Parameters:
    
    effectiveTimePeriod - effectiveTimePeriod or null for none
  - getEligibleOfferMatcher
```
public RepricingRuleEligibleOfferMatcher getEligibleOfferMatcher()
```
    Required. Match criteria for the eligible offers.
    
    Returns:
    
    value or null for none
  - setEligibleOfferMatcher
```
public RepricingRule setEligibleOfferMatcher(RepricingRuleEligibleOfferMatcher eligibleOfferMatcher)
```
    Required. Match criteria for the eligible offers.
    
    Parameters:
    
    eligibleOfferMatcher - eligibleOfferMatcher or null for none
  - getLanguageCode
```
public String getLanguageCode()
```
    Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.
    
    Returns:
    
    value or null for none
  - setLanguageCode
```
public RepricingRule setLanguageCode(String languageCode)
```
    Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.
    
    Parameters:
    
    languageCode - languageCode or null for none
  - getMerchantId
```
public Long getMerchantId()
```
    Output only. Immutable. Merchant that owns the repricing rule.
    
    Returns:
    
    value or null for none
  - setMerchantId
```
public RepricingRule setMerchantId(Long merchantId)
```
    Output only. Immutable. Merchant that owns the repricing rule.
    
    Parameters:
    
    merchantId - merchantId or null for none
  - getPaused
```
public Boolean getPaused()
```
    Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.
    
    Returns:
    
    value or null for none
  - setPaused
```
public RepricingRule setPaused(Boolean paused)
```
    Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.
    
    Parameters:
    
    paused - paused or null for none
  - getRestriction
```
public RepricingRuleRestriction getRestriction()
```
    Required. Restriction of the rule appliance.
    
    Returns:
    
    value or null for none
  - setRestriction
```
public RepricingRule setRestriction(RepricingRuleRestriction restriction)
```
    Required. Restriction of the rule appliance.
    
    Parameters:
    
    restriction - restriction or null for none
  - getRuleId
```
public String getRuleId()
```
    Output only. Immutable. The ID to uniquely identify each repricing rule.
    
    Returns:
    
    value or null for none
  - setRuleId
```
public RepricingRule setRuleId(String ruleId)
```
    Output only. Immutable. The ID to uniquely identify each repricing rule.
    
    Parameters:
    
    ruleId - ruleId or null for none
  - getStatsBasedRule
```
public RepricingRuleStatsBasedRule getStatsBasedRule()
```
    The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED.
    
    Returns:
    
    value or null for none
  - setStatsBasedRule
```
public RepricingRule setStatsBasedRule(RepricingRuleStatsBasedRule statsBasedRule)
```
    The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED.
    
    Parameters:
    
    statsBasedRule - statsBasedRule or null for none
  - getTitle
```
public String getTitle()
```
    The title for the rule.
    
    Returns:
    
    value or null for none
  - setTitle
```
public RepricingRule setTitle(String title)
```
    The title for the rule.
    
    Parameters:
    
    title - title or null for none
  - getType
```
public String getType()
```
    Required. Immutable. The type of the rule.
    
    Returns:
    
    value or null for none
  - setType
```
public RepricingRule setType(String type)
```
    Required. Immutable. The type of the rule.
    
    Parameters:
    
    type - type or null for none
  - set
```
public RepricingRule set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public RepricingRule clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class RepricingRule

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

RepricingRule

Method Detail

getCogsBasedRule

setCogsBasedRule

getCountryCode

setCountryCode

getEffectiveTimePeriod

setEffectiveTimePeriod

getEligibleOfferMatcher

setEligibleOfferMatcher

getLanguageCode

setLanguageCode

getMerchantId

setMerchantId

getPaused

setPaused

getRestriction

setRestriction

getRuleId

setRuleId

getStatsBasedRule

setStatsBasedRule

getTitle

setTitle

getType

setType

set

clone