Package com.google.cloud.recommendationengine.v1beta1

Interface CatalogItemOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CatalogItem, CatalogItem.Builder
    public interface CatalogItemOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getId

        String getId()
         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.
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         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.
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for id.

      • getCategoryHierarchiesList

        List<CatalogItem.CategoryHierarchy> getCategoryHierarchiesList()
         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"] }
      ]
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];

      • getCategoryHierarchies

        CatalogItem.CategoryHierarchy getCategoryHierarchies​(int index)
         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"] }
      ]
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];

      • getCategoryHierarchiesCount

        int getCategoryHierarchiesCount()
         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"] }
      ]
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];

      • getCategoryHierarchiesOrBuilderList

        List<? extends CatalogItem.CategoryHierarchyOrBuilder> getCategoryHierarchiesOrBuilderList()
         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"] }
      ]
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];

      • getCategoryHierarchiesOrBuilder

        CatalogItem.CategoryHierarchyOrBuilder getCategoryHierarchiesOrBuilder​(int index)
         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"] }
      ]
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];

      • getTitle

        String getTitle()
         Required. Catalog item title. UTF-8 encoded string with a length limit of 1
 KiB.
        string title = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The title.

      • getTitleBytes

        com.google.protobuf.ByteString getTitleBytes()
         Required. Catalog item title. UTF-8 encoded string with a length limit of 1
 KiB.
        string title = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for title.

      • getDescription

        String getDescription()
         Optional. Catalog item description. UTF-8 encoded string with a length
 limit of 5 KiB.
        string description = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Optional. Catalog item description. UTF-8 encoded string with a length
 limit of 5 KiB.
        string description = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for description.

      • hasItemAttributes

        boolean hasItemAttributes()
         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.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the itemAttributes field is set.

      • getItemAttributes

        FeatureMap getItemAttributes()
         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.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The itemAttributes.

      • getItemAttributesOrBuilder

        FeatureMapOrBuilder getItemAttributesOrBuilder()
         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.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getLanguageCode

        String getLanguageCode()
         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.
        string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        com.google.protobuf.ByteString getLanguageCodeBytes()
         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.
        string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for languageCode.

      • getTagsList

        List<String> getTagsList()
         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.
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the tags.

      • getTagsCount

        int getTagsCount()
         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.
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of tags.

      • getTags

        String getTags​(int index)
         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.
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The tags at the given index.

      • getTagsBytes

        com.google.protobuf.ByteString getTagsBytes​(int index)
         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.
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the tags at the given index.

      • getItemGroupId

        String getItemGroupId()
         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](/recommendations-ai/docs/catalog#item-group-id).
        string item_group_id = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The itemGroupId.

      • getItemGroupIdBytes

        com.google.protobuf.ByteString getItemGroupIdBytes()
         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](/recommendations-ai/docs/catalog#item-group-id).
        string item_group_id = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for itemGroupId.

      • hasProductMetadata

        boolean hasProductMetadata()
         Optional. Metadata specific to retail products.
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the productMetadata field is set.

      • getProductMetadata

        ProductCatalogItem getProductMetadata()
         Optional. Metadata specific to retail products.
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The productMetadata.

      • getProductMetadataOrBuilder

        ProductCatalogItemOrBuilder getProductMetadataOrBuilder()
         Optional. Metadata specific to retail products.
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];