- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public interface PriceInfoOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCost()
public abstract float getCost()The costs associated with the sale of a particular product. Used for gross profit reporting.
Profit = price - cost
Google Merchant Center property cost_of_goods_sold.
float cost = 4;
| Returns | |
|---|---|
| Type | Description |
float |
The cost. |
getCurrencyCode()
public abstract String getCurrencyCode()The 3-letter currency code defined in ISO 4217.
If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned.
The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned.
string currency_code = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The currencyCode. |
getCurrencyCodeBytes()
public abstract ByteString getCurrencyCodeBytes()The 3-letter currency code defined in ISO 4217.
If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned.
The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned.
string currency_code = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for currencyCode. |
getOriginalPrice()
public abstract float getOriginalPrice()Price of the product without any discount. If zero, by default set to be the price. If set, original_price should be greater than or equal to price, otherwise an INVALID_ARGUMENT error is thrown.
float original_price = 3;
| Returns | |
|---|---|
| Type | Description |
float |
The originalPrice. |
getPrice()
public abstract float getPrice()Price of the product.
Google Merchant Center property price. Schema.org property Offer.price.
float price = 2;
| Returns | |
|---|---|
| Type | Description |
float |
The price. |
getPriceEffectiveTime()
public abstract Timestamp getPriceEffectiveTime()The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time.
Do not set if price is always effective because it will cause additional latency during search.
.google.protobuf.Timestamp price_effective_time = 5;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The priceEffectiveTime. |
getPriceEffectiveTimeOrBuilder()
public abstract TimestampOrBuilder getPriceEffectiveTimeOrBuilder()The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time.
Do not set if price is always effective because it will cause additional latency during search.
.google.protobuf.Timestamp price_effective_time = 5;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getPriceExpireTime()
public abstract Timestamp getPriceExpireTime()The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time.
Do not set if price is always effective because it will cause additional latency during search.
.google.protobuf.Timestamp price_expire_time = 6;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The priceExpireTime. |
getPriceExpireTimeOrBuilder()
public abstract TimestampOrBuilder getPriceExpireTimeOrBuilder()The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time.
Do not set if price is always effective because it will cause additional latency during search.
.google.protobuf.Timestamp price_expire_time = 6;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getPriceRange()
public abstract PriceInfo.PriceRange getPriceRange()Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products.
Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.
.google.cloud.retail.v2.PriceInfo.PriceRange price_range = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
PriceInfo.PriceRange |
The priceRange. |
getPriceRangeOrBuilder()
public abstract PriceInfo.PriceRangeOrBuilder getPriceRangeOrBuilder()Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products.
Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.
.google.cloud.retail.v2.PriceInfo.PriceRange price_range = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
PriceInfo.PriceRangeOrBuilder |
|
hasPriceEffectiveTime()
public abstract boolean hasPriceEffectiveTime()The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time.
Do not set if price is always effective because it will cause additional latency during search.
.google.protobuf.Timestamp price_effective_time = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the priceEffectiveTime field is set. |
hasPriceExpireTime()
public abstract boolean hasPriceExpireTime()The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time.
Do not set if price is always effective because it will cause additional latency during search.
.google.protobuf.Timestamp price_expire_time = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the priceExpireTime field is set. |
hasPriceRange()
public abstract boolean hasPriceRange()Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products.
Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.
.google.cloud.retail.v2.PriceInfo.PriceRange price_range = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the priceRange field is set. |