Interface LocalInventoryOrBuilder (0.28.0)

public interface LocalInventoryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccount()

public abstract long getAccount()

Output only. The account that owns the product. This field will be ignored if set by the client.

int64 account = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The account.

getAvailability()

public abstract String getAvailability()

Availability of the product at this store. For accepted attribute values, see the local product inventory data specification

optional string availability = 7;

Returns
Type Description
String

The availability.

getAvailabilityBytes()

public abstract ByteString getAvailabilityBytes()

Availability of the product at this store. For accepted attribute values, see the local product inventory data specification

optional string availability = 7;

Returns
Type Description
ByteString

The bytes for availability.

getCustomAttributes(int index)

public abstract CustomAttribute getCustomAttributes(int index)

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

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

getCustomAttributesCount()

public abstract int getCustomAttributesCount()

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

Returns
Type Description
int

getCustomAttributesList()

public abstract List<CustomAttribute> getCustomAttributesList()

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

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

getCustomAttributesOrBuilder(int index)

public abstract CustomAttributeOrBuilder getCustomAttributesOrBuilder(int index)

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

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

getCustomAttributesOrBuilderList()

public abstract List<? extends CustomAttributeOrBuilder> getCustomAttributesOrBuilderList()

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

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

getInstoreProductLocation()

public abstract String getInstoreProductLocation()

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

optional string instore_product_location = 11;

Returns
Type Description
String

The instoreProductLocation.

getInstoreProductLocationBytes()

public abstract ByteString getInstoreProductLocationBytes()

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

optional string instore_product_location = 11;

Returns
Type Description
ByteString

The bytes for instoreProductLocation.

getName()

public abstract String getName()

Output only. The name of the LocalInventory resource. Format: accounts/{account}/products/{product}/localInventories/{store_code}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The name of the LocalInventory resource. Format: accounts/{account}/products/{product}/localInventories/{store_code}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getPickupMethod()

public abstract String getPickupMethod()

Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification

optional string pickup_method = 9;

Returns
Type Description
String

The pickupMethod.

getPickupMethodBytes()

public abstract ByteString getPickupMethodBytes()

Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification

optional string pickup_method = 9;

Returns
Type Description
ByteString

The bytes for pickupMethod.

getPickupSla()

public abstract String getPickupSla()

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. For accepted attribute values, see the local product inventory data specification

optional string pickup_sla = 10;

Returns
Type Description
String

The pickupSla.

getPickupSlaBytes()

public abstract ByteString getPickupSlaBytes()

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. For accepted attribute values, see the local product inventory data specification

optional string pickup_sla = 10;

Returns
Type Description
ByteString

The bytes for pickupSla.

getPrice()

public abstract Price getPrice()

Price of the product at this store.

.google.shopping.type.Price price = 4;

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

The price.

getPriceOrBuilder()

public abstract PriceOrBuilder getPriceOrBuilder()

Price of the product at this store.

.google.shopping.type.Price price = 4;

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

getQuantity()

public abstract long getQuantity()

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

optional int64 quantity = 8;

Returns
Type Description
long

The quantity.

getSalePrice()

public abstract Price getSalePrice()

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

.google.shopping.type.Price sale_price = 5;

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

The salePrice.

getSalePriceEffectiveDate()

public abstract Interval getSalePriceEffectiveDate()

The TimePeriod of the sale at this store.

.google.type.Interval sale_price_effective_date = 6;

Returns
Type Description
com.google.type.Interval

The salePriceEffectiveDate.

getSalePriceEffectiveDateOrBuilder()

public abstract IntervalOrBuilder getSalePriceEffectiveDateOrBuilder()

The TimePeriod of the sale at this store.

.google.type.Interval sale_price_effective_date = 6;

Returns
Type Description
com.google.type.IntervalOrBuilder

getSalePriceOrBuilder()

public abstract PriceOrBuilder getSalePriceOrBuilder()

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

.google.shopping.type.Price sale_price = 5;

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

getStoreCode()

public abstract String getStoreCode()

Required. Immutable. 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.

string store_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The storeCode.

getStoreCodeBytes()

public abstract ByteString getStoreCodeBytes()

Required. Immutable. 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.

string store_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for storeCode.

hasAvailability()

public abstract boolean hasAvailability()

Availability of the product at this store. For accepted attribute values, see the local product inventory data specification

optional string availability = 7;

Returns
Type Description
boolean

Whether the availability field is set.

hasInstoreProductLocation()

public abstract boolean hasInstoreProductLocation()

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

optional string instore_product_location = 11;

Returns
Type Description
boolean

Whether the instoreProductLocation field is set.

hasPickupMethod()

public abstract boolean hasPickupMethod()

Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification

optional string pickup_method = 9;

Returns
Type Description
boolean

Whether the pickupMethod field is set.

hasPickupSla()

public abstract boolean hasPickupSla()

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. For accepted attribute values, see the local product inventory data specification

optional string pickup_sla = 10;

Returns
Type Description
boolean

Whether the pickupSla field is set.

hasPrice()

public abstract boolean hasPrice()

Price of the product at this store.

.google.shopping.type.Price price = 4;

Returns
Type Description
boolean

Whether the price field is set.

hasQuantity()

public abstract boolean hasQuantity()

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

optional int64 quantity = 8;

Returns
Type Description
boolean

Whether the quantity field is set.

hasSalePrice()

public abstract boolean hasSalePrice()

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

.google.shopping.type.Price sale_price = 5;

Returns
Type Description
boolean

Whether the salePrice field is set.

hasSalePriceEffectiveDate()

public abstract boolean hasSalePriceEffectiveDate()

The TimePeriod of the sale at this store.

.google.type.Interval sale_price_effective_date = 6;

Returns
Type Description
boolean

Whether the salePriceEffectiveDate field is set.