Class: Google::Cloud::Retail::V2::PriceInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/common.rb

Overview

The price information of a Product.

Defined Under Namespace

Classes: PriceRange

Instance Attribute Summary collapse

Instance Attribute Details

#cost ⇒ ::Float

Returns The costs associated with the sale of a particular product. Used for gross profit reporting.

Google Merchant Center property cost_of_goods_sold.

Returns:

  • (::Float) —

    The costs associated with the sale of a particular product. Used for gross profit reporting.

    Google Merchant Center property cost_of_goods_sold.



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 690

class PriceInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The price range of all
  # {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  # {::Google::Cloud::Retail::V2::Product Product} having the same
  # {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#price Product.pricing_info.price}
  #     interval of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] original_price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#original_price Product.pricing_info.original_price}
  #     internal of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  class PriceRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#currency_code ⇒ ::String

Returns 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:



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 690

class PriceInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The price range of all
  # {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  # {::Google::Cloud::Retail::V2::Product Product} having the same
  # {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#price Product.pricing_info.price}
  #     interval of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] original_price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#original_price Product.pricing_info.original_price}
  #     internal of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  class PriceRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#original_price ⇒ ::Float

Returns 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:

  • (::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.



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 690

class PriceInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The price range of all
  # {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  # {::Google::Cloud::Retail::V2::Product Product} having the same
  # {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#price Product.pricing_info.price}
  #     interval of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] original_price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#original_price Product.pricing_info.original_price}
  #     internal of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  class PriceRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#price ⇒ ::Float

Returns Price of the product.

Google Merchant Center property price. Schema.org property Offer.price.

Returns:

  • (::Float) —

    Price of the product.

    Google Merchant Center property price. Schema.org property Offer.price.



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 690

class PriceInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The price range of all
  # {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  # {::Google::Cloud::Retail::V2::Product Product} having the same
  # {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#price Product.pricing_info.price}
  #     interval of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] original_price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#original_price Product.pricing_info.original_price}
  #     internal of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  class PriceRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#price_effective_time ⇒ ::Google::Protobuf::Timestamp

Returns 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:



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 690

class PriceInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The price range of all
  # {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  # {::Google::Cloud::Retail::V2::Product Product} having the same
  # {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#price Product.pricing_info.price}
  #     interval of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] original_price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#original_price Product.pricing_info.original_price}
  #     internal of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  class PriceRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#price_expire_time ⇒ ::Google::Protobuf::Timestamp

Returns 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:



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 690

class PriceInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The price range of all
  # {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  # {::Google::Cloud::Retail::V2::Product Product} having the same
  # {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#price Product.pricing_info.price}
  #     interval of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] original_price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#original_price Product.pricing_info.original_price}
  #     internal of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  class PriceRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#price_range ⇒ ::Google::Cloud::Retail::V2::PriceInfo::PriceRange (readonly)

Returns 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:



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 690

class PriceInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The price range of all
  # {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  # {::Google::Cloud::Retail::V2::Product Product} having the same
  # {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#price Product.pricing_info.price}
  #     interval of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  # @!attribute [rw] original_price
  #   @return [::Google::Cloud::Retail::V2::Interval]
  #     The inclusive
  #     {::Google::Cloud::Retail::V2::PriceInfo#original_price Product.pricing_info.original_price}
  #     internal of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
  #     {::Google::Cloud::Retail::V2::Product Product} having the same
  #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
  class PriceRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end