Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::PriceInfo.
The price information of a Product.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#cost
def cost() -> ::Float-
(::Float) — The costs associated with the sale of a particular product. Used for gross
profit reporting.
Google Merchant Center property cost_of_goods_sold.
#cost=
def cost=(value) -> ::Float-
value (::Float) — The costs associated with the sale of a particular product. Used for gross
profit reporting.
Google Merchant Center property cost_of_goods_sold.
-
(::Float) — The costs associated with the sale of a particular product. Used for gross
profit reporting.
Google Merchant Center property cost_of_goods_sold.
#currency_code
def currency_code() -> ::String-
(::String) — 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 {::Google::Cloud::Retail::V2::Product Product}s with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned.
#currency_code=
def currency_code=(value) -> ::String-
value (::String) — 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 {::Google::Cloud::Retail::V2::Product Product}s with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned.
-
(::String) — 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 {::Google::Cloud::Retail::V2::Product Product}s with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned.
#original_price
def original_price() -> ::Float- (::Float) — 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.
#original_price=
def original_price=(value) -> ::Float- value (::Float) — 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) — 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.
#price
def price() -> ::Float-
(::Float) — Price of the product.
Google Merchant Center property price. Schema.org property Offer.price.
#price=
def price=(value) -> ::Float-
value (::Float) — Price of the product.
Google Merchant Center property price. Schema.org property Offer.price.
-
(::Float) — Price of the product.
Google Merchant Center property price. Schema.org property Offer.price.
#price_effective_time
def price_effective_time() -> ::Google::Protobuf::Timestamp-
(::Google::Protobuf::Timestamp) — 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.
#price_effective_time=
def price_effective_time=(value) -> ::Google::Protobuf::Timestamp-
value (::Google::Protobuf::Timestamp) — 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) — 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.
#price_expire_time
def price_expire_time() -> ::Google::Protobuf::Timestamp-
(::Google::Protobuf::Timestamp) — 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.
#price_expire_time=
def price_expire_time=(value) -> ::Google::Protobuf::Timestamp-
value (::Google::Protobuf::Timestamp) — 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) — 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.
#price_range
def price_range() -> ::Google::Cloud::Retail::V2::PriceInfo::PriceRange-
(::Google::Cloud::Retail::V2::PriceInfo::PriceRange) — 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.