Class Attributes (0.1.0)

public final class Attributes extends GeneratedMessageV3 implements AttributesOrBuilder

Attributes.

Protobuf type google.shopping.merchant.promotions.v1beta.Attributes

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Attributes

Implements

AttributesOrBuilder

Static Fields

BRAND_EXCLUSION_FIELD_NUMBER

public static final int BRAND_EXCLUSION_FIELD_NUMBER
Field Value
Type Description
int

BRAND_INCLUSION_FIELD_NUMBER

public static final int BRAND_INCLUSION_FIELD_NUMBER
Field Value
Type Description
int

COUPON_VALUE_TYPE_FIELD_NUMBER

public static final int COUPON_VALUE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

FREE_GIFT_DESCRIPTION_FIELD_NUMBER

public static final int FREE_GIFT_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

FREE_GIFT_ITEM_ID_FIELD_NUMBER

public static final int FREE_GIFT_ITEM_ID_FIELD_NUMBER
Field Value
Type Description
int

FREE_GIFT_VALUE_FIELD_NUMBER

public static final int FREE_GIFT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

GENERIC_REDEMPTION_CODE_FIELD_NUMBER

public static final int GENERIC_REDEMPTION_CODE_FIELD_NUMBER
Field Value
Type Description
int

GET_THIS_QUANTITY_DISCOUNTED_FIELD_NUMBER

public static final int GET_THIS_QUANTITY_DISCOUNTED_FIELD_NUMBER
Field Value
Type Description
int

ITEM_GROUP_ID_EXCLUSION_FIELD_NUMBER

public static final int ITEM_GROUP_ID_EXCLUSION_FIELD_NUMBER
Field Value
Type Description
int

ITEM_GROUP_ID_INCLUSION_FIELD_NUMBER

public static final int ITEM_GROUP_ID_INCLUSION_FIELD_NUMBER
Field Value
Type Description
int

ITEM_ID_EXCLUSION_FIELD_NUMBER

public static final int ITEM_ID_EXCLUSION_FIELD_NUMBER
Field Value
Type Description
int

ITEM_ID_INCLUSION_FIELD_NUMBER

public static final int ITEM_ID_INCLUSION_FIELD_NUMBER
Field Value
Type Description
int

LIMIT_QUANTITY_FIELD_NUMBER

public static final int LIMIT_QUANTITY_FIELD_NUMBER
Field Value
Type Description
int

LIMIT_VALUE_FIELD_NUMBER

public static final int LIMIT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

LONG_TITLE_FIELD_NUMBER

public static final int LONG_TITLE_FIELD_NUMBER
Field Value
Type Description
int

MINIMUM_PURCHASE_AMOUNT_FIELD_NUMBER

public static final int MINIMUM_PURCHASE_AMOUNT_FIELD_NUMBER
Field Value
Type Description
int

MINIMUM_PURCHASE_QUANTITY_FIELD_NUMBER

public static final int MINIMUM_PURCHASE_QUANTITY_FIELD_NUMBER
Field Value
Type Description
int

MONEY_OFF_AMOUNT_FIELD_NUMBER

public static final int MONEY_OFF_AMOUNT_FIELD_NUMBER
Field Value
Type Description
int

OFFER_TYPE_FIELD_NUMBER

public static final int OFFER_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PERCENT_OFF_FIELD_NUMBER

public static final int PERCENT_OFF_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_APPLICABILITY_FIELD_NUMBER

public static final int PRODUCT_APPLICABILITY_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_TYPE_EXCLUSION_FIELD_NUMBER

public static final int PRODUCT_TYPE_EXCLUSION_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_TYPE_INCLUSION_FIELD_NUMBER

public static final int PRODUCT_TYPE_INCLUSION_FIELD_NUMBER
Field Value
Type Description
int

PROMOTION_DESTINATIONS_FIELD_NUMBER

public static final int PROMOTION_DESTINATIONS_FIELD_NUMBER
Field Value
Type Description
int

PROMOTION_DISPLAY_TIME_PERIOD_FIELD_NUMBER

public static final int PROMOTION_DISPLAY_TIME_PERIOD_FIELD_NUMBER
Field Value
Type Description
int

PROMOTION_EFFECTIVE_TIME_PERIOD_FIELD_NUMBER

public static final int PROMOTION_EFFECTIVE_TIME_PERIOD_FIELD_NUMBER
Field Value
Type Description
int

PROMOTION_URL_FIELD_NUMBER

public static final int PROMOTION_URL_FIELD_NUMBER
Field Value
Type Description
int

STORE_APPLICABILITY_FIELD_NUMBER

public static final int STORE_APPLICABILITY_FIELD_NUMBER
Field Value
Type Description
int

STORE_CODES_EXCLUSION_FIELD_NUMBER

public static final int STORE_CODES_EXCLUSION_FIELD_NUMBER
Field Value
Type Description
int

STORE_CODES_INCLUSION_FIELD_NUMBER

public static final int STORE_CODES_INCLUSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Attributes getDefaultInstance()
Returns
Type Description
Attributes

getDescriptor()

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

newBuilder()

public static Attributes.Builder newBuilder()
Returns
Type Description
Attributes.Builder

newBuilder(Attributes prototype)

public static Attributes.Builder newBuilder(Attributes prototype)
Parameter
Name Description
prototype Attributes
Returns
Type Description
Attributes.Builder

parseDelimitedFrom(InputStream input)

public static Attributes parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Attributes
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Attributes parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attributes
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Attributes parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Attributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Attributes parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Attributes parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Attributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Attributes parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Attributes parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Attributes
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Attributes parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attributes
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Attributes parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Attributes
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Attributes parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attributes
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Attributes parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Attributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Attributes parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attributes
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Attributes> parser()
Returns
Type Description
Parser<Attributes>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBrandExclusion(int index)

public String getBrandExclusion(int index)

Optional. Product filter by brand exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string brand_exclusion = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The brandExclusion at the given index.

getBrandExclusionBytes(int index)

public ByteString getBrandExclusionBytes(int index)

Optional. Product filter by brand exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string brand_exclusion = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the brandExclusion at the given index.

getBrandExclusionCount()

public int getBrandExclusionCount()

Optional. Product filter by brand exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string brand_exclusion = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of brandExclusion.

getBrandExclusionList()

public ProtocolStringList getBrandExclusionList()

Optional. Product filter by brand exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string brand_exclusion = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the brandExclusion.

getBrandInclusion(int index)

public String getBrandInclusion(int index)

Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string brand_inclusion = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The brandInclusion at the given index.

getBrandInclusionBytes(int index)

public ByteString getBrandInclusionBytes(int index)

Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string brand_inclusion = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the brandInclusion at the given index.

getBrandInclusionCount()

public int getBrandInclusionCount()

Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string brand_inclusion = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of brandInclusion.

getBrandInclusionList()

public ProtocolStringList getBrandInclusionList()

Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string brand_inclusion = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the brandInclusion.

getCouponValueType()

public CouponValueType getCouponValueType()

Required. The coupon value type attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value some attributes are required.

.google.shopping.merchant.promotions.v1beta.CouponValueType coupon_value_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CouponValueType

The couponValueType.

getCouponValueTypeValue()

public int getCouponValueTypeValue()

Required. The coupon value type attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value some attributes are required.

.google.shopping.merchant.promotions.v1beta.CouponValueType coupon_value_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for couponValueType.

getDefaultInstanceForType()

public Attributes getDefaultInstanceForType()
Returns
Type Description
Attributes

getFreeGiftDescription()

public String getFreeGiftDescription()

Optional. Free gift description for the promotion.

string free_gift_description = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The freeGiftDescription.

getFreeGiftDescriptionBytes()

public ByteString getFreeGiftDescriptionBytes()

Optional. Free gift description for the promotion.

string free_gift_description = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for freeGiftDescription.

getFreeGiftItemId()

public String getFreeGiftItemId()

Optional. Free gift item ID for the promotion.

string free_gift_item_id = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The freeGiftItemId.

getFreeGiftItemIdBytes()

public ByteString getFreeGiftItemIdBytes()

Optional. Free gift item ID for the promotion.

string free_gift_item_id = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for freeGiftItemId.

getFreeGiftValue()

public Price getFreeGiftValue()

Optional. Free gift value for the promotion.

.google.shopping.type.Price free_gift_value = 22 [(.google.api.field_behavior) = OPTIONAL];

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

The freeGiftValue.

getFreeGiftValueOrBuilder()

public PriceOrBuilder getFreeGiftValueOrBuilder()

Optional. Free gift value for the promotion.

.google.shopping.type.Price free_gift_value = 22 [(.google.api.field_behavior) = OPTIONAL];

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

getGenericRedemptionCode()

public String getGenericRedemptionCode()

Optional. Generic redemption code for the promotion. To be used with the offerType field and must meet the minimum requirements.

string generic_redemption_code = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The genericRedemptionCode.

getGenericRedemptionCodeBytes()

public ByteString getGenericRedemptionCodeBytes()

Optional. Generic redemption code for the promotion. To be used with the offerType field and must meet the minimum requirements.

string generic_redemption_code = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for genericRedemptionCode.

getGetThisQuantityDiscounted()

public long getGetThisQuantityDiscounted()

Optional. The number of items discounted in the promotion. The attribute is set when couponValueType is equal to buy_m_get_n_money_off or buy_m_get_n_percent_off.

int64 get_this_quantity_discounted = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The getThisQuantityDiscounted.

getItemGroupIdExclusion(int index)

public String getItemGroupIdExclusion(int index)

Optional. Product filter by item group ID. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products. exclusion for the promotion.

repeated string item_group_id_exclusion = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The itemGroupIdExclusion at the given index.

getItemGroupIdExclusionBytes(int index)

public ByteString getItemGroupIdExclusionBytes(int index)

Optional. Product filter by item group ID. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products. exclusion for the promotion.

repeated string item_group_id_exclusion = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the itemGroupIdExclusion at the given index.

getItemGroupIdExclusionCount()

public int getItemGroupIdExclusionCount()

Optional. Product filter by item group ID. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products. exclusion for the promotion.

repeated string item_group_id_exclusion = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of itemGroupIdExclusion.

getItemGroupIdExclusionList()

public ProtocolStringList getItemGroupIdExclusionList()

Optional. Product filter by item group ID. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products. exclusion for the promotion.

repeated string item_group_id_exclusion = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the itemGroupIdExclusion.

getItemGroupIdInclusion(int index)

public String getItemGroupIdInclusion(int index)

Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to specific_products.

repeated string item_group_id_inclusion = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The itemGroupIdInclusion at the given index.

getItemGroupIdInclusionBytes(int index)

public ByteString getItemGroupIdInclusionBytes(int index)

Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to specific_products.

repeated string item_group_id_inclusion = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the itemGroupIdInclusion at the given index.

getItemGroupIdInclusionCount()

public int getItemGroupIdInclusionCount()

Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to specific_products.

repeated string item_group_id_inclusion = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of itemGroupIdInclusion.

getItemGroupIdInclusionList()

public ProtocolStringList getItemGroupIdInclusionList()

Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to specific_products.

repeated string item_group_id_inclusion = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the itemGroupIdInclusion.

getItemIdExclusion(int index)

public String getItemIdExclusion(int index)

Optional. Product filter by item ID exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string item_id_exclusion = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The itemIdExclusion at the given index.

getItemIdExclusionBytes(int index)

public ByteString getItemIdExclusionBytes(int index)

Optional. Product filter by item ID exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string item_id_exclusion = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the itemIdExclusion at the given index.

getItemIdExclusionCount()

public int getItemIdExclusionCount()

Optional. Product filter by item ID exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string item_id_exclusion = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of itemIdExclusion.

getItemIdExclusionList()

public ProtocolStringList getItemIdExclusionList()

Optional. Product filter by item ID exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string item_id_exclusion = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the itemIdExclusion.

getItemIdInclusion(int index)

public String getItemIdInclusion(int index)

Optional. Product filter by item ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string item_id_inclusion = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The itemIdInclusion at the given index.

getItemIdInclusionBytes(int index)

public ByteString getItemIdInclusionBytes(int index)

Optional. Product filter by item ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string item_id_inclusion = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the itemIdInclusion at the given index.

getItemIdInclusionCount()

public int getItemIdInclusionCount()

Optional. Product filter by item ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string item_id_inclusion = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of itemIdInclusion.

getItemIdInclusionList()

public ProtocolStringList getItemIdInclusionList()

Optional. Product filter by item ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string item_id_inclusion = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the itemIdInclusion.

getLimitQuantity()

public long getLimitQuantity()

Optional. Maximum purchase quantity for the promotion.

int64 limit_quantity = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The limitQuantity.

getLimitValue()

public Price getLimitValue()

Optional. Maximum product price for promotion.

.google.shopping.type.Price limit_value = 18 [(.google.api.field_behavior) = OPTIONAL];

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

The limitValue.

getLimitValueOrBuilder()

public PriceOrBuilder getLimitValueOrBuilder()

Optional. Maximum product price for promotion.

.google.shopping.type.Price limit_value = 18 [(.google.api.field_behavior) = OPTIONAL];

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

getLongTitle()

public String getLongTitle()

Required. Long title for the promotion.

string long_title = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The longTitle.

getLongTitleBytes()

public ByteString getLongTitleBytes()

Required. Long title for the promotion.

string long_title = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for longTitle.

getMinimumPurchaseAmount()

public Price getMinimumPurchaseAmount()

Optional. Minimum purchase amount for the promotion.

.google.shopping.type.Price minimum_purchase_amount = 15 [(.google.api.field_behavior) = OPTIONAL];

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

The minimumPurchaseAmount.

getMinimumPurchaseAmountOrBuilder()

public PriceOrBuilder getMinimumPurchaseAmountOrBuilder()

Optional. Minimum purchase amount for the promotion.

.google.shopping.type.Price minimum_purchase_amount = 15 [(.google.api.field_behavior) = OPTIONAL];

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

getMinimumPurchaseQuantity()

public long getMinimumPurchaseQuantity()

Optional. Minimum purchase quantity for the promotion.

int64 minimum_purchase_quantity = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The minimumPurchaseQuantity.

getMoneyOffAmount()

public Price getMoneyOffAmount()

Optional. The money off amount offered in the promotion.

.google.shopping.type.Price money_off_amount = 20 [(.google.api.field_behavior) = OPTIONAL];

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

The moneyOffAmount.

getMoneyOffAmountOrBuilder()

public PriceOrBuilder getMoneyOffAmountOrBuilder()

Optional. The money off amount offered in the promotion.

.google.shopping.type.Price money_off_amount = 20 [(.google.api.field_behavior) = OPTIONAL];

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

getOfferType()

public OfferType getOfferType()

Required. Type of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.

.google.shopping.merchant.promotions.v1beta.OfferType offer_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OfferType

The offerType.

getOfferTypeValue()

public int getOfferTypeValue()

Required. Type of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.

.google.shopping.merchant.promotions.v1beta.OfferType offer_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for offerType.

getParserForType()

public Parser<Attributes> getParserForType()
Returns
Type Description
Parser<Attributes>
Overrides

getPercentOff()

public long getPercentOff()

Optional. The percentage discount offered in the promotion.

int64 percent_off = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The percentOff.

getProductApplicability()

public ProductApplicability getProductApplicability()

Required. Applicability of the promotion to either all products or only specific products.

.google.shopping.merchant.promotions.v1beta.ProductApplicability product_applicability = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductApplicability

The productApplicability.

getProductApplicabilityValue()

public int getProductApplicabilityValue()

Required. Applicability of the promotion to either all products or only specific products.

.google.shopping.merchant.promotions.v1beta.ProductApplicability product_applicability = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for productApplicability.

getProductTypeExclusion(int index)

public String getProductTypeExclusion(int index)

Optional. Product filter by product type exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string product_type_exclusion = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The productTypeExclusion at the given index.

getProductTypeExclusionBytes(int index)

public ByteString getProductTypeExclusionBytes(int index)

Optional. Product filter by product type exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string product_type_exclusion = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the productTypeExclusion at the given index.

getProductTypeExclusionCount()

public int getProductTypeExclusionCount()

Optional. Product filter by product type exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string product_type_exclusion = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of productTypeExclusion.

getProductTypeExclusionList()

public ProtocolStringList getProductTypeExclusionList()

Optional. Product filter by product type exclusion for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string product_type_exclusion = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the productTypeExclusion.

getProductTypeInclusion(int index)

public String getProductTypeInclusion(int index)

Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string product_type_inclusion = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The productTypeInclusion at the given index.

getProductTypeInclusionBytes(int index)

public ByteString getProductTypeInclusionBytes(int index)

Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string product_type_inclusion = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the productTypeInclusion at the given index.

getProductTypeInclusionCount()

public int getProductTypeInclusionCount()

Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string product_type_inclusion = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of productTypeInclusion.

getProductTypeInclusionList()

public ProtocolStringList getProductTypeInclusionList()

Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products.

repeated string product_type_inclusion = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the productTypeInclusion.

getPromotionDestinations(int index)

public Destination.DestinationEnum getPromotionDestinations(int index)

Required. The list of destinations where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default.

You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. For more details see Promotion destination

repeated .google.shopping.type.Destination.DestinationEnum promotion_destinations = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
com.google.shopping.type.Destination.DestinationEnum

The promotionDestinations at the given index.

getPromotionDestinationsCount()

public int getPromotionDestinationsCount()

Required. The list of destinations where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default.

You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. For more details see Promotion destination

repeated .google.shopping.type.Destination.DestinationEnum promotion_destinations = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of promotionDestinations.

getPromotionDestinationsList()

public List<Destination.DestinationEnum> getPromotionDestinationsList()

Required. The list of destinations where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default.

You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. For more details see Promotion destination

repeated .google.shopping.type.Destination.DestinationEnum promotion_destinations = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<com.google.shopping.type.Destination.DestinationEnum>

A list containing the promotionDestinations.

getPromotionDestinationsValue(int index)

public int getPromotionDestinationsValue(int index)

Required. The list of destinations where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default.

You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. For more details see Promotion destination

repeated .google.shopping.type.Destination.DestinationEnum promotion_destinations = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of promotionDestinations at the given index.

getPromotionDestinationsValueList()

public List<Integer> getPromotionDestinationsValueList()

Required. The list of destinations where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default.

You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. For more details see Promotion destination

repeated .google.shopping.type.Destination.DestinationEnum promotion_destinations = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for promotionDestinations.

getPromotionDisplayTimePeriod()

public Interval getPromotionDisplayTimePeriod()

Optional. TimePeriod representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion promotion_display_time_period attribute is not specified, the promotion effective time period promotion_effective_time_period determines the date and time frame when the promotion will be live on Google.com and Shopping ads.

.google.type.Interval promotion_display_time_period = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Interval

The promotionDisplayTimePeriod.

getPromotionDisplayTimePeriodOrBuilder()

public IntervalOrBuilder getPromotionDisplayTimePeriodOrBuilder()

Optional. TimePeriod representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion promotion_display_time_period attribute is not specified, the promotion effective time period promotion_effective_time_period determines the date and time frame when the promotion will be live on Google.com and Shopping ads.

.google.type.Interval promotion_display_time_period = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.IntervalOrBuilder

getPromotionEffectiveTimePeriod()

public Interval getPromotionEffectiveTimePeriod()

Required. TimePeriod representation of the promotion's effective dates. This attribute specifies that the promotion can be tested on your online store during this time period.

.google.type.Interval promotion_effective_time_period = 25 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.Interval

The promotionEffectiveTimePeriod.

getPromotionEffectiveTimePeriodOrBuilder()

public IntervalOrBuilder getPromotionEffectiveTimePeriodOrBuilder()

Required. TimePeriod representation of the promotion's effective dates. This attribute specifies that the promotion can be tested on your online store during this time period.

.google.type.Interval promotion_effective_time_period = 25 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.IntervalOrBuilder

getPromotionUrl()

public String getPromotionUrl()

Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promotion_url is included. URL is used to confirm that the promotion is valid and can be redeemed.

string promotion_url = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The promotionUrl.

getPromotionUrlBytes()

public ByteString getPromotionUrlBytes()

Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promotion_url is included. URL is used to confirm that the promotion is valid and can be redeemed.

string promotion_url = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for promotionUrl.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStoreApplicability()

public StoreApplicability getStoreApplicability()

Optional. 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_codes_inclusion or score_code_exclusion is set to a value.

.google.shopping.merchant.promotions.v1beta.StoreApplicability store_applicability = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StoreApplicability

The storeApplicability.

getStoreApplicabilityValue()

public int getStoreApplicabilityValue()

Optional. 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_codes_inclusion or score_code_exclusion is set to a value.

.google.shopping.merchant.promotions.v1beta.StoreApplicability store_applicability = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for storeApplicability.

getStoreCodesExclusion(int index)

public String getStoreCodesExclusion(int index)

Optional. Store codes to exclude for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

repeated string store_codes_exclusion = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The storeCodesExclusion at the given index.

getStoreCodesExclusionBytes(int index)

public ByteString getStoreCodesExclusionBytes(int index)

Optional. Store codes to exclude for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

repeated string store_codes_exclusion = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the storeCodesExclusion at the given index.

getStoreCodesExclusionCount()

public int getStoreCodesExclusionCount()

Optional. Store codes to exclude for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

repeated string store_codes_exclusion = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of storeCodesExclusion.

getStoreCodesExclusionList()

public ProtocolStringList getStoreCodesExclusionList()

Optional. Store codes to exclude for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

repeated string store_codes_exclusion = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the storeCodesExclusion.

getStoreCodesInclusion(int index)

public String getStoreCodesInclusion(int index)

Optional. Store codes to include for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

repeated string store_codes_inclusion = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The storeCodesInclusion at the given index.

getStoreCodesInclusionBytes(int index)

public ByteString getStoreCodesInclusionBytes(int index)

Optional. Store codes to include for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

repeated string store_codes_inclusion = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the storeCodesInclusion at the given index.

getStoreCodesInclusionCount()

public int getStoreCodesInclusionCount()

Optional. Store codes to include for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

repeated string store_codes_inclusion = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of storeCodesInclusion.

getStoreCodesInclusionList()

public ProtocolStringList getStoreCodesInclusionList()

Optional. Store codes to include for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

repeated string store_codes_inclusion = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the storeCodesInclusion.

hasFreeGiftValue()

public boolean hasFreeGiftValue()

Optional. Free gift value for the promotion.

.google.shopping.type.Price free_gift_value = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the freeGiftValue field is set.

hasLimitValue()

public boolean hasLimitValue()

Optional. Maximum product price for promotion.

.google.shopping.type.Price limit_value = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the limitValue field is set.

hasMinimumPurchaseAmount()

public boolean hasMinimumPurchaseAmount()

Optional. Minimum purchase amount for the promotion.

.google.shopping.type.Price minimum_purchase_amount = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the minimumPurchaseAmount field is set.

hasMoneyOffAmount()

public boolean hasMoneyOffAmount()

Optional. The money off amount offered in the promotion.

.google.shopping.type.Price money_off_amount = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the moneyOffAmount field is set.

hasPromotionDisplayTimePeriod()

public boolean hasPromotionDisplayTimePeriod()

Optional. TimePeriod representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion promotion_display_time_period attribute is not specified, the promotion effective time period promotion_effective_time_period determines the date and time frame when the promotion will be live on Google.com and Shopping ads.

.google.type.Interval promotion_display_time_period = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the promotionDisplayTimePeriod field is set.

hasPromotionEffectiveTimePeriod()

public boolean hasPromotionEffectiveTimePeriod()

Required. TimePeriod representation of the promotion's effective dates. This attribute specifies that the promotion can be tested on your online store during this time period.

.google.type.Interval promotion_effective_time_period = 25 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the promotionEffectiveTimePeriod field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Attributes.Builder newBuilderForType()
Returns
Type Description
Attributes.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Attributes.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Attributes.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Attributes.Builder toBuilder()
Returns
Type Description
Attributes.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException