Class: Google::Cloud::Retail::V2::Product

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

Overview

Product captures all metadata information of items to be recommended or searched.

Defined Under Namespace

Modules: Availability, Type Classes: AttributesEntry

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}

Returns Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here.

Features that can take on one of a limited number of possible values. Two types of features can be set are:

Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer.

For example: { "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": \\{"numbers":[2.3, 15.4]}, "heights_cm": \\{"numbers":[8.1, 6.4]} }.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

  • Max entries count: 200.
  • The key must be a UTF-8 encoded string with a length limit of 128 characters.
  • For indexable attribute, the key must match the pattern: [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
  • For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters.
  • For number attributes, at most 400 values are allowed.

Returns:

  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}) —

    Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here.

    Features that can take on one of a limited number of possible values. Two types of features can be set are:

    Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer.

    For example: { "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": \\{"numbers":[2.3, 15.4]}, "heights_cm": \\{"numbers":[8.1, 6.4]} }.

    This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

    • Max entries count: 200.
    • The key must be a UTF-8 encoded string with a length limit of 128 characters.
    • For indexable attribute, the key must match the pattern: [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
    • For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters.
    • For number attributes, at most 400 values are allowed.


513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#audience ⇒ ::Google::Cloud::Retail::V2::Audience

Returns The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#availability ⇒ ::Google::Cloud::Retail::V2::Product::Availability

Returns The online availability of the Product. Default to Availability.IN_STOCK.

For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock.

For primary products with no variants set the true availability at the primary level.

Corresponding properties: Google Merchant Center property availability. Schema.org property Offer.availability.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#available_quantity ⇒ ::Google::Protobuf::Int32Value

Returns The available quantity of the item.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#available_time ⇒ ::Google::Protobuf::Timestamp

Returns The timestamp when this Product becomes available for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#brands ⇒ ::Array<::String>

Returns The brands of the product.

A maximum of 30 brands are allowed unless overridden through the Google Cloud console. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property brand. Schema.org property Product.brand.

Returns:

  • (::Array<::String>) —

    The brands of the product.

    A maximum of 30 brands are allowed unless overridden through the Google Cloud console. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property brand. Schema.org property Product.brand.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#categories ⇒ ::Array<::String>

Returns Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality.

To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as:

 "categories": [
   "Shoes & Accessories > Shoes",
   "Sports & Fitness > Athletic Clothing > Shoes"
 ]

Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned.

At most 250 values are allowed per Product unless overridden through the Google Cloud console. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property google_product_category. Schema.org property Product.category.

Returns:

  • (::Array<::String>) —

    Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality.

    To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

    For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as:

     "categories": [
   "Shoes & Accessories > Shoes",
   "Sports & Fitness > Athletic Clothing > Shoes"
 ]

    Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned.

    At most 250 values are allowed per Product unless overridden through the Google Cloud console. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property google_product_category. Schema.org property Product.category.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#collection_member_ids ⇒ ::Array<::String>

The id of the collection members when type is Type.COLLECTION.

Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.

Returns:

  • (::Array<::String>) —

    The id of the collection members when type is Type.COLLECTION.

    Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#color_info ⇒ ::Google::Cloud::Retail::V2::ColorInfo

Returns The color of the product.

Corresponding properties: Google Merchant Center property color. Schema.org property Product.color.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#conditions ⇒ ::Array<::String>

Returns The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used".

A maximum of 1 value is allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property condition. Schema.org property Offer.itemCondition.

Returns:

  • (::Array<::String>) —

    The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used".

    A maximum of 1 value is allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property condition. Schema.org property Offer.itemCondition.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#description ⇒ ::String

Returns Product description.

This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property description. Schema.org property Product.description.

Returns:

  • (::String) —

    Product description.

    This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property description. Schema.org property Product.description.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp

Returns Note that this field is applied in the following ways:

In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness.

expire_time must be later than available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.

Corresponding properties: Google Merchant Center property expiration_date.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#fulfillment_info ⇒ ::Array<::Google::Cloud::Retail::V2::FulfillmentInfo>

Returns Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.

All the elements must have distinct FulfillmentInfo.type. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#gtin ⇒ ::String

The Global Trade Item Number (GTIN) of the product.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property gtin. Schema.org property Product.isbn, Product.gtin8, Product.gtin12, Product.gtin13, or Product.gtin14.

If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.

Returns:

  • (::String) —

    The Global Trade Item Number (GTIN) of the product.

    This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property gtin. Schema.org property Product.isbn, Product.gtin8, Product.gtin12, Product.gtin13, or Product.gtin14.

    If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#id ⇒ ::String

Returns Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku.

Returns:

  • (::String) —

    Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1.

    This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#images ⇒ ::Array<::Google::Cloud::Retail::V2::Image>

Returns Product images for the product. We highly recommend putting the main image first.

A maximum of 300 images are allowed.

Corresponding properties: Google Merchant Center property image_link. Schema.org property Product.image.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#language_code ⇒ ::String

Returns Language of the title/description and other string attributes. Use language tags defined by BCP 47.

For product prediction, this field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Products to provide text in multiple languages can result in degraded model performance.

For product search this field is in use. It defaults to "en-US" if unset.

Returns:

  • (::String) —

    Language of the title/description and other string attributes. Use language tags defined by BCP 47.

    For product prediction, this field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Products to provide text in multiple languages can result in degraded model performance.

    For product search this field is in use. It defaults to "en-US" if unset.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#local_inventories ⇒ ::Array<::Google::Cloud::Retail::V2::LocalInventory> (readonly)

Returns Output only. A list of local inventories specific to different places.

This field can be managed by ProductService.AddLocalInventories and ProductService.RemoveLocalInventories APIs if fine-grained, high-volume updates are necessary.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#materials ⇒ ::Array<::String>

Returns The material of the product. For example, "leather", "wooden".

A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property material. Schema.org property Product.material.

Returns:

  • (::Array<::String>) —

    The material of the product. For example, "leather", "wooden".

    A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property material. Schema.org property Product.material.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#name ⇒ ::String

Returns Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id.

Returns:

  • (::String) —

    Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#patterns ⇒ ::Array<::String>

Returns The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley".

A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property pattern. Schema.org property Product.pattern.

Returns:

  • (::Array<::String>) —

    The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley".

    A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property pattern. Schema.org property Product.pattern.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#price_info ⇒ ::Google::Cloud::Retail::V2::PriceInfo

Returns Product price and cost information.

Corresponding properties: Google Merchant Center property price.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#primary_product_id ⇒ ::String

Returns Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown.

For Type.PRIMARY Products, this field can only be empty or set to the same value as id.

For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property item_group_id. Schema.org property Product.inProductGroupWithID.

Returns:

  • (::String) —

    Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown.

    For Type.PRIMARY Products, this field can only be empty or set to the same value as id.

    For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property item_group_id. Schema.org property Product.inProductGroupWithID.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#promotions ⇒ ::Array<::Google::Cloud::Retail::V2::Promotion>

Returns The promotions applied to the product. A maximum of 10 values are allowed per Product. Only Promotion.promotion_id will be used, other fields will be ignored if set.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#publish_time ⇒ ::Google::Protobuf::Timestamp

Returns The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from available_time, given it purely describes product freshness regardless of when it is available on search and recommendation.

Returns:

  • (::Google::Protobuf::Timestamp) —

    The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from available_time, given it purely describes product freshness regardless of when it is available on search and recommendation.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#rating ⇒ ::Google::Cloud::Retail::V2::Rating

Returns The rating of this product.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#retrievable_fields ⇒ ::Google::Protobuf::FieldMask

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Indicates which fields in the Products are returned in SearchResponse.

Supported fields for all types:

Supported fields only for Type.PRIMARY and Type.COLLECTION:

Supported fields only for Type.VARIANT:

  • Only the first image in images

To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes.

For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default:

For Type.VARIANT, the following fields are always returned in by default:

Note: Returning more fields in SearchResponse can increase response payload size and serving latency.

This field is deprecated. Use the retrievable site-wide control instead.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#sizes ⇒ ::Array<::String>

Returns The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value].

For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches".

A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property size, size_type, and size_system. Schema.org property Product.size.

Returns:

  • (::Array<::String>) —

    The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value].

    For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches".

    A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property size, size_type, and size_system. Schema.org property Product.size.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#tags ⇒ ::Array<::String>

Returns Custom tags associated with the product.

At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter.

Corresponding properties: Google Merchant Center property custom_label_0–4.

Returns:

  • (::Array<::String>) —

    Custom tags associated with the product.

    At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter.

    Corresponding properties: Google Merchant Center property custom_label_0–4.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#title ⇒ ::String

Returns Required. Product title.

This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property title. Schema.org property Product.name.

Returns:

  • (::String) —

    Required. Product title.

    This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property title. Schema.org property Product.name.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#ttl ⇒ ::Google::Protobuf::Duration

Input only. The TTL (time to live) of the product. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness.

If it is set, it must be a non-negative value, and expire_time is set as current timestamp plus ttl. The derived expire_time is returned in the output and ttl is left blank when retrieving the Product.

If it is set, the product is not available for SearchService.Search after current timestamp plus ttl. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#type ⇒ ::Google::Cloud::Retail::V2::Product::Type

Returns Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#uri ⇒ ::String

Returns Canonical URL directly linking to the product detail page.

It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded.

This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property link. Schema.org property Offer.url.

Returns:

  • (::String) —

    Canonical URL directly linking to the product detail page.

    It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded.

    This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    Corresponding properties: Google Merchant Center property link. Schema.org property Offer.url.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end

#variants ⇒ ::Array<::Google::Cloud::Retail::V2::Product> (readonly)

Returns Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by primary_product_id for all the product variants. Only populated for Type.PRIMARY Products.

Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/cloud/retail/v2/product.rb', line 513

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
  class AttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of this product.
  module Type
    # Default value. Default to
    # {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type Catalog.product_level_config.ingestion_product_type}
    # if unset.
    TYPE_UNSPECIFIED = 0

    # The primary type.
    #
    # As the primary unit for predicting, indexing and search serving, a
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product} is grouped with multiple
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s.
    PRIMARY = 1

    # The variant type.
    #
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s usually share some common
    # attributes on the same
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s, but they have variant
    # attributes like different colors, sizes and prices, etc.
    VARIANT = 2

    # The collection type. Collection products are bundled
    # {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
    # {::Google::Cloud::Retail::V2::Product Product}s or
    # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}
    # {::Google::Cloud::Retail::V2::Product Product}s that are sold together, such
    # as a jewelry set with necklaces, earrings and rings, etc.
    COLLECTION = 3
  end

  # Product availability. If this field is unspecified, the product is
  # assumed to be in stock.
  module Availability
    # Default product availability. Default to
    # {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}
    # if unset.
    AVAILABILITY_UNSPECIFIED = 0

    # Product in stock.
    IN_STOCK = 1

    # Product out of stock.
    OUT_OF_STOCK = 2

    # Product that is in pre-order state.
    PREORDER = 3

    # Product that is back-ordered (i.e. temporarily out of stock).
    BACKORDER = 4
  end
end