Reference documentation and code samples for the Google Cloud Retail V2 Client class PriceInfo.
The price information of a Product .
Generated from protobuf message google.cloud.retail.v2.PriceInfo
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ currency_code
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 Product s with the same Product.primary_product_id must share the same currency_code . Otherwise, a FAILED_PRECONDITION error is returned.
↳ price
float
Price of the product. Google Merchant Center property price . Schema.org property Offer.price .
↳ original_price
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.
↳ cost
float
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 .
↳ price_effective_time
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
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
Google\Cloud\Retail\V2\PriceInfo\PriceRange
Output only. The price range of all the child Product.Type.VARIANT Product s grouped together on the Product.Type.PRIMARY Product . Only populated for Product.Type.PRIMARY Product s. Note: This field is OUTPUT_ONLY for ProductService.GetProduct . Do not set this field in API requests.
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 Product s with the same Product.primary_product_id must share the same currency_code . Otherwise, a FAILED_PRECONDITION error is returned.
Generated from protobuf field string currency_code = 1;
string
setCurrencyCode
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 Product s with the same Product.primary_product_id must share the same currency_code . Otherwise, a FAILED_PRECONDITION error is returned.
Generated from protobuf field string currency_code = 1;
var
string
$this
getPrice
Price of the product.
Google Merchant Center property price . Schema.org property Offer.price .
Generated from protobuf field float price = 2;
float
setPrice
Price of the product.
Google Merchant Center property price . Schema.org property Offer.price .
Generated from protobuf field float price = 2;
var
float
$this
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.
Generated from protobuf field float original_price = 3;
float
setOriginalPrice
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.
Generated from protobuf field float original_price = 3;
var
float
$this
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 .
Generated from protobuf field float cost = 4;
float
setCost
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 .
Generated from protobuf field float cost = 4;
var
float
$this
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.
Generated from protobuf field .google.protobuf.Timestamp price_effective_time = 5;
Google\Protobuf\Timestamp|null
hasPriceEffectiveTime
clearPriceEffectiveTime
setPriceEffectiveTime
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.
Generated from protobuf field .google.protobuf.Timestamp price_effective_time = 5;
var
Google\Protobuf\Timestamp
$this
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.
Generated from protobuf field .google.protobuf.Timestamp price_expire_time = 6;
Google\Protobuf\Timestamp|null
hasPriceExpireTime
clearPriceExpireTime
setPriceExpireTime
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.
Generated from protobuf field .google.protobuf.Timestamp price_expire_time = 6;
var
Google\Protobuf\Timestamp
$this
getPriceRange
Output only. The price range of all the child Product.Type.VARIANT Product s grouped together on the Product.Type.PRIMARY Product . Only populated for Product.Type.PRIMARY Product s.
Note: This field is OUTPUT_ONLY for ProductService.GetProduct . Do not set this field in API requests.
Generated from protobuf field .google.cloud.retail.v2.PriceInfo.PriceRange price_range = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasPriceRange
clearPriceRange
setPriceRange
Output only. The price range of all the child Product.Type.VARIANT Product s grouped together on the Product.Type.PRIMARY Product . Only populated for Product.Type.PRIMARY Product s.
Note: This field is OUTPUT_ONLY for ProductService.GetProduct . Do not set this field in API requests.
Generated from protobuf field .google.cloud.retail.v2.PriceInfo.PriceRange price_range = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
