All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.content.model.Promotion.html Maven / Gradle / Ivy

There is a newer version: v2.1-rev20240825-2.0.0
Show newest version






Promotion (Content API for Shopping v2.1-rev20240609-2.0.0)












com.google.api.services.content.model

Class Promotion

  • All Implemented Interfaces:
    Cloneable, Map<String,Object>


    public final class Promotion
    extends com.google.api.client.json.GenericJson
    Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)

    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.
    • Constructor Detail

      • Promotion

        public Promotion()
    • Method Detail

      • getBrand

        public List<String> getBrand()
        Product filter by brand for the promotion.
        Returns:
        value or null for none
      • setBrand

        public Promotion setBrand(List<String> brand)
        Product filter by brand for the promotion.
        Parameters:
        brand - brand or null for none
      • getBrandExclusion

        public List<String> getBrandExclusion()
        Product filter by brand exclusion for the promotion.
        Returns:
        value or null for none
      • setBrandExclusion

        public Promotion setBrandExclusion(List<String> brandExclusion)
        Product filter by brand exclusion for the promotion.
        Parameters:
        brandExclusion - brandExclusion or null for none
      • getContentLanguage

        public String getContentLanguage()
        Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
        Returns:
        value or null for none
      • setContentLanguage

        public Promotion setContentLanguage(String contentLanguage)
        Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
        Parameters:
        contentLanguage - contentLanguage or null for none
      • getCouponValueType

        public String getCouponValueType()
        Required. Coupon value type for the promotion.
        Returns:
        value or null for none
      • setCouponValueType

        public Promotion setCouponValueType(String couponValueType)
        Required. Coupon value type for the promotion.
        Parameters:
        couponValueType - couponValueType or null for none
      • getFreeGiftDescription

        public String getFreeGiftDescription()
        Free gift description for the promotion.
        Returns:
        value or null for none
      • setFreeGiftDescription

        public Promotion setFreeGiftDescription(String freeGiftDescription)
        Free gift description for the promotion.
        Parameters:
        freeGiftDescription - freeGiftDescription or null for none
      • getFreeGiftItemId

        public String getFreeGiftItemId()
        Free gift item ID for the promotion.
        Returns:
        value or null for none
      • setFreeGiftItemId

        public Promotion setFreeGiftItemId(String freeGiftItemId)
        Free gift item ID for the promotion.
        Parameters:
        freeGiftItemId - freeGiftItemId or null for none
      • getFreeGiftValue

        public PriceAmount getFreeGiftValue()
        Free gift value for the promotion.
        Returns:
        value or null for none
      • setFreeGiftValue

        public Promotion setFreeGiftValue(PriceAmount freeGiftValue)
        Free gift value for the promotion.
        Parameters:
        freeGiftValue - freeGiftValue or null for none
      • getGenericRedemptionCode

        public String getGenericRedemptionCode()
        Generic redemption code for the promotion. To be used with the `offerType` field.
        Returns:
        value or null for none
      • setGenericRedemptionCode

        public Promotion setGenericRedemptionCode(String genericRedemptionCode)
        Generic redemption code for the promotion. To be used with the `offerType` field.
        Parameters:
        genericRedemptionCode - genericRedemptionCode or null for none
      • getGetThisQuantityDiscounted

        public Integer getGetThisQuantityDiscounted()
        The number of items discounted in the promotion.
        Returns:
        value or null for none
      • setGetThisQuantityDiscounted

        public Promotion setGetThisQuantityDiscounted(Integer getThisQuantityDiscounted)
        The number of items discounted in the promotion.
        Parameters:
        getThisQuantityDiscounted - getThisQuantityDiscounted or null for none
      • getId

        public String getId()
        Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `"online"`, `"in_store"`, or `"online_in_store"`.
        Returns:
        value or null for none
      • setId

        public Promotion setId(String id)
        Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `"online"`, `"in_store"`, or `"online_in_store"`.
        Parameters:
        id - id or null for none
      • getItemGroupId

        public List<String> getItemGroupId()
        Product filter by item group ID for the promotion.
        Returns:
        value or null for none
      • setItemGroupId

        public Promotion setItemGroupId(List<String> itemGroupId)
        Product filter by item group ID for the promotion.
        Parameters:
        itemGroupId - itemGroupId or null for none
      • getItemGroupIdExclusion

        public List<String> getItemGroupIdExclusion()
        Product filter by item group ID exclusion for the promotion.
        Returns:
        value or null for none
      • setItemGroupIdExclusion

        public Promotion setItemGroupIdExclusion(List<String> itemGroupIdExclusion)
        Product filter by item group ID exclusion for the promotion.
        Parameters:
        itemGroupIdExclusion - itemGroupIdExclusion or null for none
      • getItemId

        public List<String> getItemId()
        Product filter by item ID for the promotion.
        Returns:
        value or null for none
      • setItemId

        public Promotion setItemId(List<String> itemId)
        Product filter by item ID for the promotion.
        Parameters:
        itemId - itemId or null for none
      • getItemIdExclusion

        public List<String> getItemIdExclusion()
        Product filter by item ID exclusion for the promotion.
        Returns:
        value or null for none
      • setItemIdExclusion

        public Promotion setItemIdExclusion(List<String> itemIdExclusion)
        Product filter by item ID exclusion for the promotion.
        Parameters:
        itemIdExclusion - itemIdExclusion or null for none
      • getLimitQuantity

        public Integer getLimitQuantity()
        Maximum purchase quantity for the promotion.
        Returns:
        value or null for none
      • setLimitQuantity

        public Promotion setLimitQuantity(Integer limitQuantity)
        Maximum purchase quantity for the promotion.
        Parameters:
        limitQuantity - limitQuantity or null for none
      • getLimitValue

        public PriceAmount getLimitValue()
        Maximum purchase value for the promotion.
        Returns:
        value or null for none
      • setLimitValue

        public Promotion setLimitValue(PriceAmount limitValue)
        Maximum purchase value for the promotion.
        Parameters:
        limitValue - limitValue or null for none
      • getLongTitle

        public String getLongTitle()
        Required. Long title for the promotion.
        Returns:
        value or null for none
      • setLongTitle

        public Promotion setLongTitle(String longTitle)
        Required. Long title for the promotion.
        Parameters:
        longTitle - longTitle or null for none
      • getMinimumPurchaseAmount

        public PriceAmount getMinimumPurchaseAmount()
        Minimum purchase amount for the promotion.
        Returns:
        value or null for none
      • setMinimumPurchaseAmount

        public Promotion setMinimumPurchaseAmount(PriceAmount minimumPurchaseAmount)
        Minimum purchase amount for the promotion.
        Parameters:
        minimumPurchaseAmount - minimumPurchaseAmount or null for none
      • getMinimumPurchaseQuantity

        public Integer getMinimumPurchaseQuantity()
        Minimum purchase quantity for the promotion.
        Returns:
        value or null for none
      • setMinimumPurchaseQuantity

        public Promotion setMinimumPurchaseQuantity(Integer minimumPurchaseQuantity)
        Minimum purchase quantity for the promotion.
        Parameters:
        minimumPurchaseQuantity - minimumPurchaseQuantity or null for none
      • getMoneyBudget

        public PriceAmount getMoneyBudget()
        Cost cap for the promotion.
        Returns:
        value or null for none
      • setMoneyBudget

        public Promotion setMoneyBudget(PriceAmount moneyBudget)
        Cost cap for the promotion.
        Parameters:
        moneyBudget - moneyBudget or null for none
      • getMoneyOffAmount

        public PriceAmount getMoneyOffAmount()
        The money off amount offered in the promotion.
        Returns:
        value or null for none
      • setMoneyOffAmount

        public Promotion setMoneyOffAmount(PriceAmount moneyOffAmount)
        The money off amount offered in the promotion.
        Parameters:
        moneyOffAmount - moneyOffAmount or null for none
      • getOfferType

        public String getOfferType()
        Required. Type of the promotion.
        Returns:
        value or null for none
      • setOfferType

        public Promotion setOfferType(String offerType)
        Required. Type of the promotion.
        Parameters:
        offerType - offerType or null for none
      • getOrderLimit

        public Integer getOrderLimit()
        Order limit for the promotion.
        Returns:
        value or null for none
      • setOrderLimit

        public Promotion setOrderLimit(Integer orderLimit)
        Order limit for the promotion.
        Parameters:
        orderLimit - orderLimit or null for none
      • getPercentOff

        public Integer getPercentOff()
        The percentage discount offered in the promotion.
        Returns:
        value or null for none
      • setPercentOff

        public Promotion setPercentOff(Integer percentOff)
        The percentage discount offered in the promotion.
        Parameters:
        percentOff - percentOff or null for none
      • getProductApplicability

        public String getProductApplicability()
        Required. Applicability of the promotion to either all products or only specific products.
        Returns:
        value or null for none
      • setProductApplicability

        public Promotion setProductApplicability(String productApplicability)
        Required. Applicability of the promotion to either all products or only specific products.
        Parameters:
        productApplicability - productApplicability or null for none
      • getProductType

        public List<String> getProductType()
        Product filter by product type for the promotion.
        Returns:
        value or null for none
      • setProductType

        public Promotion setProductType(List<String> productType)
        Product filter by product type for the promotion.
        Parameters:
        productType - productType or null for none
      • getProductTypeExclusion

        public List<String> getProductTypeExclusion()
        Product filter by product type exclusion for the promotion.
        Returns:
        value or null for none
      • setProductTypeExclusion

        public Promotion setProductTypeExclusion(List<String> productTypeExclusion)
        Product filter by product type exclusion for the promotion.
        Parameters:
        productTypeExclusion - productTypeExclusion or null for none
      • getPromotionDestinationIds

        public List<String> getPromotionDestinationIds()
        Destination ID for the promotion.
        Returns:
        value or null for none
      • setPromotionDestinationIds

        public Promotion setPromotionDestinationIds(List<String> promotionDestinationIds)
        Destination ID for the promotion.
        Parameters:
        promotionDestinationIds - promotionDestinationIds or null for none
      • getPromotionDisplayDates

        public String getPromotionDisplayDates()
        String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
        Returns:
        value or null for none
      • setPromotionDisplayDates

        public Promotion setPromotionDisplayDates(String promotionDisplayDates)
        String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
        Parameters:
        promotionDisplayDates - promotionDisplayDates or null for none
      • getPromotionDisplayTimePeriod

        public TimePeriod getPromotionDisplayTimePeriod()
        `TimePeriod` representation of the promotion's display dates.
        Returns:
        value or null for none
      • setPromotionDisplayTimePeriod

        public Promotion setPromotionDisplayTimePeriod(TimePeriod promotionDisplayTimePeriod)
        `TimePeriod` representation of the promotion's display dates.
        Parameters:
        promotionDisplayTimePeriod - promotionDisplayTimePeriod or null for none
      • getPromotionEffectiveDates

        public String getPromotionEffectiveDates()
        String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
        Returns:
        value or null for none
      • setPromotionEffectiveDates

        public Promotion setPromotionEffectiveDates(String promotionEffectiveDates)
        String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
        Parameters:
        promotionEffectiveDates - promotionEffectiveDates or null for none
      • getPromotionEffectiveTimePeriod

        public TimePeriod getPromotionEffectiveTimePeriod()
        Required. `TimePeriod` representation of the promotion's effective dates.
        Returns:
        value or null for none
      • setPromotionEffectiveTimePeriod

        public Promotion setPromotionEffectiveTimePeriod(TimePeriod promotionEffectiveTimePeriod)
        Required. `TimePeriod` representation of the promotion's effective dates.
        Parameters:
        promotionEffectiveTimePeriod - promotionEffectiveTimePeriod or null for none
      • getPromotionId

        public String getPromotionId()
        Required. The user provided promotion ID to uniquely identify the promotion.
        Returns:
        value or null for none
      • setPromotionId

        public Promotion setPromotionId(String promotionId)
        Required. The user provided promotion ID to uniquely identify the promotion.
        Parameters:
        promotionId - promotionId or null for none
      • getPromotionStatus

        public PromotionPromotionStatus getPromotionStatus()
        Output only. The current status of the promotion.
        Returns:
        value or null for none
      • setPromotionStatus

        public Promotion setPromotionStatus(PromotionPromotionStatus promotionStatus)
        Output only. The current status of the promotion.
        Parameters:
        promotionStatus - promotionStatus or null for none
      • getPromotionUrl

        public String getPromotionUrl()
        URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
        Returns:
        value or null for none
      • setPromotionUrl

        public Promotion setPromotionUrl(String promotionUrl)
        URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
        Parameters:
        promotionUrl - promotionUrl or null for none
      • getRedemptionChannel

        public List<String> getRedemptionChannel()
        Required. Redemption channel for the promotion. At least one channel is required.
        Returns:
        value or null for none
      • setRedemptionChannel

        public Promotion setRedemptionChannel(List<String> redemptionChannel)
        Required. Redemption channel for the promotion. At least one channel is required.
        Parameters:
        redemptionChannel - redemptionChannel or null for none
      • getShippingServiceNames

        public List<String> getShippingServiceNames()
        Shipping service names for the promotion.
        Returns:
        value or null for none
      • setShippingServiceNames

        public Promotion setShippingServiceNames(List<String> shippingServiceNames)
        Shipping service names for the promotion.
        Parameters:
        shippingServiceNames - shippingServiceNames or null for none
      • getStoreApplicability

        public String getStoreApplicability()
        Whether the promotion applies to all stores, or only specified stores. Local Inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value.
        Returns:
        value or null for none
      • setStoreApplicability

        public Promotion setStoreApplicability(String storeApplicability)
        Whether the promotion applies to all stores, or only specified stores. Local Inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value.
        Parameters:
        storeApplicability - storeApplicability or null for none
      • getStoreCode

        public List<String> getStoreCode()
        Store codes to include for the promotion.
        Returns:
        value or null for none
      • setStoreCode

        public Promotion setStoreCode(List<String> storeCode)
        Store codes to include for the promotion.
        Parameters:
        storeCode - storeCode or null for none
      • getStoreCodeExclusion

        public List<String> getStoreCodeExclusion()
        Store codes to exclude for the promotion.
        Returns:
        value or null for none
      • setStoreCodeExclusion

        public Promotion setStoreCodeExclusion(List<String> storeCodeExclusion)
        Store codes to exclude for the promotion.
        Parameters:
        storeCodeExclusion - storeCodeExclusion or null for none
      • getTargetCountry

        public String getTargetCountry()
        Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
        Returns:
        value or null for none
      • setTargetCountry

        public Promotion setTargetCountry(String targetCountry)
        Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
        Parameters:
        targetCountry - targetCountry or null for none
      • set

        public Promotion set(String fieldName,
                             Object value)
        Overrides:
        set in class com.google.api.client.json.GenericJson
      • clone

        public Promotion clone()
        Overrides:
        clone in class com.google.api.client.json.GenericJson

Copyright © 2011–2024 Google. All rights reserved.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy