Class: Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb

Overview

CatalogItem captures all metadata information of items to be recommended.

Defined Under Namespace

Classes: CategoryHierarchy

Instance Attribute Summary collapse

Instance Attribute Details

#category_hierarchies ⇒ ::Array<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem::CategoryHierarchy>

Returns Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies.

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

 "categoryHierarchies": [
   { "categories": ["Shoes & Accessories", "Shoes"]},
   { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
 ].

Returns:

  • (::Array<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem::CategoryHierarchy>) —

    Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies.

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

     "categoryHierarchies": [
   { "categories": ["Shoes & Accessories", "Shoes"]},
   { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
 ]



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb', line 86

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

  # Category represents catalog item category hierarchy.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     Required. Catalog item categories. Each category should be a UTF-8
  #     encoded string with a length limit of 2 KiB.
  #
  #     Note that the order in the list denotes the specificity (from least to
  #     most specific).
  class CategoryHierarchy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.

Returns:

  • (::String) —

    Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb', line 86

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

  # Category represents catalog item category hierarchy.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     Required. Catalog item categories. Each category should be a UTF-8
  #     encoded string with a length limit of 2 KiB.
  #
  #     Note that the order in the list denotes the specificity (from least to
  #     most specific).
  class CategoryHierarchy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#id ⇒ ::String

Returns Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes.

This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.

Returns:

  • (::String) —

    Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes.

    This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb', line 86

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

  # Category represents catalog item category hierarchy.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     Required. Catalog item categories. Each category should be a UTF-8
  #     encoded string with a length limit of 2 KiB.
  #
  #     Note that the order in the list denotes the specificity (from least to
  #     most specific).
  class CategoryHierarchy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#item_attributes ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap

Returns Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail 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 item attributes here.

Returns:

  • (::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap) —

    Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail 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 item attributes here.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb', line 86

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

  # Category represents catalog item category hierarchy.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     Required. Catalog item categories. Each category should be a UTF-8
  #     encoded string with a length limit of 2 KiB.
  #
  #     Note that the order in the list denotes the specificity (from least to
  #     most specific).
  class CategoryHierarchy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#item_group_id ⇒ ::String

Returns Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes.

This field must be enabled before it can be used. Learn more.

Returns:

  • (::String) —

    Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes.

    This field must be enabled before it can be used. Learn more.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb', line 86

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

  # Category represents catalog item category hierarchy.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     Required. Catalog item categories. Each category should be a UTF-8
  #     encoded string with a length limit of 2 KiB.
  #
  #     Note that the order in the list denotes the specificity (from least to
  #     most specific).
  class CategoryHierarchy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#language_code ⇒ ::String

Returns Optional. Language of the title/description/item_attributes. Use language tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh', 'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact your Google account manager.

Returns:

  • (::String) —

    Optional. Language of the title/description/item_attributes. Use language tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh', 'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact your Google account manager.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb', line 86

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

  # Category represents catalog item category hierarchy.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     Required. Catalog item categories. Each category should be a UTF-8
  #     encoded string with a length limit of 2 KiB.
  #
  #     Note that the order in the list denotes the specificity (from least to
  #     most specific).
  class CategoryHierarchy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#product_metadata ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::ProductCatalogItem

Returns Optional. Metadata specific to retail products.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb', line 86

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

  # Category represents catalog item category hierarchy.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     Required. Catalog item categories. Each category should be a UTF-8
  #     encoded string with a length limit of 2 KiB.
  #
  #     Note that the order in the list denotes the specificity (from least to
  #     most specific).
  class CategoryHierarchy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tags ⇒ ::Array<::String>

Returns Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB.

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

Returns:

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

    Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB.

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb', line 86

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

  # Category represents catalog item category hierarchy.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     Required. Catalog item categories. Each category should be a UTF-8
  #     encoded string with a length limit of 2 KiB.
  #
  #     Note that the order in the list denotes the specificity (from least to
  #     most specific).
  class CategoryHierarchy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#title ⇒ ::String

Returns Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

Returns:

  • (::String) —

    Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb', line 86

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

  # Category represents catalog item category hierarchy.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     Required. Catalog item categories. Each category should be a UTF-8
  #     encoded string with a length limit of 2 KiB.
  #
  #     Note that the order in the list denotes the specificity (from least to
  #     most specific).
  class CategoryHierarchy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end