Interface LocalInventoryAttributesOrBuilder (1.23.0) 

public interface LocalInventoryAttributesOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAvailability()

public abstract LocalInventoryAttributes.Availability getAvailability()

Availability of the product at this store.

optional .google.shopping.merchant.inventories.v1.LocalInventoryAttributes.Availability availability = 4;

Returns
Type Description
LocalInventoryAttributes.Availability

The availability.

getAvailabilityValue()

public abstract int getAvailabilityValue()

Availability of the product at this store.

optional .google.shopping.merchant.inventories.v1.LocalInventoryAttributes.Availability availability = 4;

Returns
Type Description
int

The enum numeric value on the wire for availability.

getCustomAttributes(int index)

public abstract CustomAttribute getCustomAttributes(int index)

Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.

repeated .google.shopping.type.CustomAttribute custom_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
com.google.shopping.type.CustomAttribute

getCustomAttributesCount()

public abstract int getCustomAttributesCount()

Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.

repeated .google.shopping.type.CustomAttribute custom_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCustomAttributesList()

public abstract List<CustomAttribute> getCustomAttributesList()

Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.

repeated .google.shopping.type.CustomAttribute custom_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<com.google.shopping.type.CustomAttribute>

getCustomAttributesOrBuilder(int index)

public abstract CustomAttributeOrBuilder getCustomAttributesOrBuilder(int index)

Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.

repeated .google.shopping.type.CustomAttribute custom_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
com.google.shopping.type.CustomAttributeOrBuilder

getCustomAttributesOrBuilderList()

public abstract List<? extends CustomAttributeOrBuilder> getCustomAttributesOrBuilderList()

Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.

repeated .google.shopping.type.CustomAttribute custom_attributes = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.shopping.type.CustomAttributeOrBuilder>

getInstoreProductLocation()

public abstract String getInstoreProductLocation()

Optional. Location of the product inside the store. Maximum length is 20 bytes.

optional string instore_product_location = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The instoreProductLocation.

getInstoreProductLocationBytes()

public abstract ByteString getInstoreProductLocationBytes()

Optional. Location of the product inside the store. Maximum length is 20 bytes.

optional string instore_product_location = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for instoreProductLocation.

getLocalShippingLabel()

public abstract String getLocalShippingLabel()

Optional. Specifies a label associated with the shipping for the LocalInventory resource. Can be used to group local shipping services to this particular inventory item. For accepted field format, see the Local delivery

optional string local_shipping_label = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The localShippingLabel.

getLocalShippingLabelBytes()

public abstract ByteString getLocalShippingLabelBytes()

Optional. Specifies a label associated with the shipping for the LocalInventory resource. Can be used to group local shipping services to this particular inventory item. For accepted field format, see the Local delivery

optional string local_shipping_label = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for localShippingLabel.

getLoyaltyPrograms(int index)

public abstract InventoryLoyaltyProgram getLoyaltyPrograms(int index)

Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store.

This field is used to show store-specific member prices on Local Inventory Ads (LIA).

To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries.

See Loyalty program for details on supported countries and loyalty program configuration. For local inventory specific details, see the Local inventory data specification.

repeated .google.shopping.merchant.inventories.v1.InventoryLoyaltyProgram loyalty_programs = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
InventoryLoyaltyProgram

getLoyaltyProgramsCount()

public abstract int getLoyaltyProgramsCount()

Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store.

This field is used to show store-specific member prices on Local Inventory Ads (LIA).

To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries.

See Loyalty program for details on supported countries and loyalty program configuration. For local inventory specific details, see the Local inventory data specification.

repeated .google.shopping.merchant.inventories.v1.InventoryLoyaltyProgram loyalty_programs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLoyaltyProgramsList()

public abstract List<InventoryLoyaltyProgram> getLoyaltyProgramsList()

Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store.

This field is used to show store-specific member prices on Local Inventory Ads (LIA).

To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries.

See Loyalty program for details on supported countries and loyalty program configuration. For local inventory specific details, see the Local inventory data specification.

repeated .google.shopping.merchant.inventories.v1.InventoryLoyaltyProgram loyalty_programs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<InventoryLoyaltyProgram>

getLoyaltyProgramsOrBuilder(int index)

public abstract InventoryLoyaltyProgramOrBuilder getLoyaltyProgramsOrBuilder(int index)

Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store.

This field is used to show store-specific member prices on Local Inventory Ads (LIA).

To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries.

See Loyalty program for details on supported countries and loyalty program configuration. For local inventory specific details, see the Local inventory data specification.

repeated .google.shopping.merchant.inventories.v1.InventoryLoyaltyProgram loyalty_programs = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
InventoryLoyaltyProgramOrBuilder

getLoyaltyProgramsOrBuilderList()

public abstract List<? extends InventoryLoyaltyProgramOrBuilder> getLoyaltyProgramsOrBuilderList()

Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store.

This field is used to show store-specific member prices on Local Inventory Ads (LIA).

To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries.

See Loyalty program for details on supported countries and loyalty program configuration. For local inventory specific details, see the Local inventory data specification.

repeated .google.shopping.merchant.inventories.v1.InventoryLoyaltyProgram loyalty_programs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.shopping.merchant.inventories.v1.InventoryLoyaltyProgramOrBuilder>

getPickupMethod()

public abstract LocalInventoryAttributes.PickupMethod getPickupMethod()

Optional. Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla.

optional .google.shopping.merchant.inventories.v1.LocalInventoryAttributes.PickupMethod pickup_method = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LocalInventoryAttributes.PickupMethod

The pickupMethod.

getPickupMethodValue()

public abstract int getPickupMethodValue()

Optional. Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla.

optional .google.shopping.merchant.inventories.v1.LocalInventoryAttributes.PickupMethod pickup_method = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for pickupMethod.

getPickupSla()

public abstract LocalInventoryAttributes.PickupSla getPickupSla()

Optional. Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with pickupMethod. See more details here.

optional .google.shopping.merchant.inventories.v1.LocalInventoryAttributes.PickupSla pickup_sla = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LocalInventoryAttributes.PickupSla

The pickupSla.

getPickupSlaValue()

public abstract int getPickupSlaValue()

Optional. Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with pickupMethod. See more details here.

optional .google.shopping.merchant.inventories.v1.LocalInventoryAttributes.PickupSla pickup_sla = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for pickupSla.

getPrice()

public abstract Price getPrice()

Optional. Price of the product at this store.

.google.shopping.type.Price price = 1 [(.google.api.field_behavior) = OPTIONAL];

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

The price.

getPriceOrBuilder()

public abstract PriceOrBuilder getPriceOrBuilder()

Optional. Price of the product at this store.

.google.shopping.type.Price price = 1 [(.google.api.field_behavior) = OPTIONAL];

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

getQuantity()

public abstract long getQuantity()

Optional. Quantity of the product available at this store. Must be greater than or equal to zero.

optional int64 quantity = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The quantity.

getSalePrice()

public abstract Price getSalePrice()

Optional. Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.

.google.shopping.type.Price sale_price = 2 [(.google.api.field_behavior) = OPTIONAL];

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

The salePrice.

getSalePriceEffectiveDate()

public abstract Interval getSalePriceEffectiveDate()

Optional. The TimePeriod of the sale at this store.

.google.type.Interval sale_price_effective_date = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Interval

The salePriceEffectiveDate.

getSalePriceEffectiveDateOrBuilder()

public abstract IntervalOrBuilder getSalePriceEffectiveDateOrBuilder()

Optional. The TimePeriod of the sale at this store.

.google.type.Interval sale_price_effective_date = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.IntervalOrBuilder

getSalePriceOrBuilder()

public abstract PriceOrBuilder getSalePriceOrBuilder()

Optional. Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.

.google.shopping.type.Price sale_price = 2 [(.google.api.field_behavior) = OPTIONAL];

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

hasAvailability()

public abstract boolean hasAvailability()

Availability of the product at this store.

optional .google.shopping.merchant.inventories.v1.LocalInventoryAttributes.Availability availability = 4;

Returns
Type Description
boolean

Whether the availability field is set.

hasInstoreProductLocation()

public abstract boolean hasInstoreProductLocation()

Optional. Location of the product inside the store. Maximum length is 20 bytes.

optional string instore_product_location = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the instoreProductLocation field is set.

hasLocalShippingLabel()

public abstract boolean hasLocalShippingLabel()

Optional. Specifies a label associated with the shipping for the LocalInventory resource. Can be used to group local shipping services to this particular inventory item. For accepted field format, see the Local delivery

optional string local_shipping_label = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the localShippingLabel field is set.

hasPickupMethod()

public abstract boolean hasPickupMethod()

Optional. Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla.

optional .google.shopping.merchant.inventories.v1.LocalInventoryAttributes.PickupMethod pickup_method = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pickupMethod field is set.

hasPickupSla()

public abstract boolean hasPickupSla()

Optional. Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with pickupMethod. See more details here.

optional .google.shopping.merchant.inventories.v1.LocalInventoryAttributes.PickupSla pickup_sla = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pickupSla field is set.

hasPrice()

public abstract boolean hasPrice()

Optional. Price of the product at this store.

.google.shopping.type.Price price = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the price field is set.

hasQuantity()

public abstract boolean hasQuantity()

Optional. Quantity of the product available at this store. Must be greater than or equal to zero.

optional int64 quantity = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the quantity field is set.

hasSalePrice()

public abstract boolean hasSalePrice()

Optional. Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.

.google.shopping.type.Price sale_price = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the salePrice field is set.

hasSalePriceEffectiveDate()

public abstract boolean hasSalePriceEffectiveDate()

Optional. The TimePeriod of the sale at this store.

.google.type.Interval sale_price_effective_date = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the salePriceEffectiveDate field is set.