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.
| Parameters | |
|---|---|
| Name | Description |
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 Products 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 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. |
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.
| Returns | |
|---|---|
| Type | Description |
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 Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrice
Price of the product.
Google Merchant Center property price. Schema.org property Offer.price.
| Returns | |
|---|---|
| Type | Description |
float | |
setPrice
Price of the product.
Google Merchant Center property price. Schema.org property Offer.price.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\PriceInfo\PriceRange|null | |
hasPriceRange
clearPriceRange
setPriceRange
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Retail\V2\PriceInfo\PriceRange
|
| Returns | |
|---|---|
| Type | Description |
$this | |