com.byteplus.rec.sdk.retail.protocol

接口 ByteplusSaasRetail.ProductOrBuilder

所有超级接口:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

所有已知实现类:

ByteplusSaasRetail.Product, ByteplusSaasRetail.Product.Builder

封闭类:

ByteplusSaasRetail

public static interface ByteplusSaasRetail.ProductOrBuilder
extends com.google.protobuf.MessageOrBuilder

方法概要

限定符和类型	方法和说明
boolean	containsExtra(String key) Optional.
ByteplusSaasRetail.Product.Brand	getBrands(int index) Required.
int	getBrandsCount() Required.
List<ByteplusSaasRetail.Product.Brand>	getBrandsList() Required.
ByteplusSaasRetail.Product.BrandOrBuilder	getBrandsOrBuilder(int index) Required.
List<? extends ByteplusSaasRetail.Product.BrandOrBuilder>	getBrandsOrBuilderList() Required.
ByteplusSaasRetail.Product.Category	getCategories(int index) Required.
int	getCategoriesCount() Required.
List<ByteplusSaasRetail.Product.Category>	getCategoriesList() Required.
ByteplusSaasRetail.Product.CategoryOrBuilder	getCategoriesOrBuilder(int index) Required.
List<? extends ByteplusSaasRetail.Product.CategoryOrBuilder>	getCategoriesOrBuilderList() Required.
ByteplusSaasRetail.Product.Display	getDisplay() Optional.
ByteplusSaasRetail.Product.DisplayOrBuilder	getDisplayOrBuilder() Optional.
Map<String,String>	getExtra() 已过时。
int	getExtraCount() Optional.
Map<String,String>	getExtraMap() Optional.
String	getExtraOrDefault(String key, String defaultValue) Optional.
String	getExtraOrThrow(String key) Optional.
int	getIsRecommendable() Required. 1 if the product is recommendable (result in `Predict` call). 0 if the product isn't recommendable.
ByteplusSaasRetail.Product.Price	getPrice() Required.
ByteplusSaasRetail.Product.PriceOrBuilder	getPriceOrBuilder() Required.
String	getProductId() Required.
com.google.protobuf.ByteString	getProductIdBytes() Required.
ByteplusSaasRetail.Product.ProductSpec	getProductSpec() Optional.
ByteplusSaasRetail.Product.ProductSpecOrBuilder	getProductSpecOrBuilder() Optional.
double	getQualityScore() Optional.
ByteplusSaasRetail.Product.Seller	getSeller() Optional.
ByteplusSaasRetail.Product.SellerOrBuilder	getSellerOrBuilder() Optional.
String	getTags(int index) Optional.
com.google.protobuf.ByteString	getTagsBytes(int index) Optional.
int	getTagsCount() Optional.
List<String>	getTagsList() Optional.
String	getTitle() Required.
com.google.protobuf.ByteString	getTitleBytes() Required.
boolean	hasDisplay() Optional.
boolean	hasPrice() Required.
boolean	hasProductSpec() Optional.
boolean	hasSeller() Optional.

从接口继承的方法 com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

从接口继承的方法 com.google.protobuf.MessageLiteOrBuilder

isInitialized

方法详细资料

getProductId

String getProductId()

 Required.
 The unique identifier for the product.
 [link to best practices on deciding product ids](./ways-to-improve-recommendation-performance)
 

string product_id = 1;

返回:

The productId.

getProductIdBytes

com.google.protobuf.ByteString getProductIdBytes()

 Required.
 The unique identifier for the product.
 [link to best practices on deciding product ids](./ways-to-improve-recommendation-performance)
 

string product_id = 1;

返回:

The bytes for productId.

getCategoriesList

List<ByteplusSaasRetail.Product.Category> getCategoriesList()

 Required.
 The categorical information of the product.
 Missing this will significantly hurt the performance.
 For example, if a product has "Shoes -> Men's Shoes -> Basketball Shoes"
 This should be:
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's Shoes"}] },
   {"category_depth":3,
    "category_nodes": [{"id_or_name":"Basketball Shoes"}] },
 ]
 If a product belongs to 2 different categories,
 "Shoes -> Men's shoes" and "Sports -> Basketball"
 then
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"},
                       {"id_or_name":"Sports"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's shoes"},
                       {"id_or_name":"Basketball"}] },
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Category categories = 2;

getCategories

ByteplusSaasRetail.Product.Category getCategories(int index)

 Required.
 The categorical information of the product.
 Missing this will significantly hurt the performance.
 For example, if a product has "Shoes -> Men's Shoes -> Basketball Shoes"
 This should be:
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's Shoes"}] },
   {"category_depth":3,
    "category_nodes": [{"id_or_name":"Basketball Shoes"}] },
 ]
 If a product belongs to 2 different categories,
 "Shoes -> Men's shoes" and "Sports -> Basketball"
 then
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"},
                       {"id_or_name":"Sports"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's shoes"},
                       {"id_or_name":"Basketball"}] },
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Category categories = 2;

getCategoriesCount

int getCategoriesCount()

 Required.
 The categorical information of the product.
 Missing this will significantly hurt the performance.
 For example, if a product has "Shoes -> Men's Shoes -> Basketball Shoes"
 This should be:
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's Shoes"}] },
   {"category_depth":3,
    "category_nodes": [{"id_or_name":"Basketball Shoes"}] },
 ]
 If a product belongs to 2 different categories,
 "Shoes -> Men's shoes" and "Sports -> Basketball"
 then
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"},
                       {"id_or_name":"Sports"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's shoes"},
                       {"id_or_name":"Basketball"}] },
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Category categories = 2;

getCategoriesOrBuilderList

List<? extends ByteplusSaasRetail.Product.CategoryOrBuilder> getCategoriesOrBuilderList()

 Required.
 The categorical information of the product.
 Missing this will significantly hurt the performance.
 For example, if a product has "Shoes -> Men's Shoes -> Basketball Shoes"
 This should be:
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's Shoes"}] },
   {"category_depth":3,
    "category_nodes": [{"id_or_name":"Basketball Shoes"}] },
 ]
 If a product belongs to 2 different categories,
 "Shoes -> Men's shoes" and "Sports -> Basketball"
 then
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"},
                       {"id_or_name":"Sports"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's shoes"},
                       {"id_or_name":"Basketball"}] },
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Category categories = 2;

getCategoriesOrBuilder

ByteplusSaasRetail.Product.CategoryOrBuilder getCategoriesOrBuilder(int index)

 Required.
 The categorical information of the product.
 Missing this will significantly hurt the performance.
 For example, if a product has "Shoes -> Men's Shoes -> Basketball Shoes"
 This should be:
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's Shoes"}] },
   {"category_depth":3,
    "category_nodes": [{"id_or_name":"Basketball Shoes"}] },
 ]
 If a product belongs to 2 different categories,
 "Shoes -> Men's shoes" and "Sports -> Basketball"
 then
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Shoes"},
                       {"id_or_name":"Sports"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Men's shoes"},
                       {"id_or_name":"Basketball"}] },
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Category categories = 2;

getBrandsList

List<ByteplusSaasRetail.Product.Brand> getBrandsList()

 Required.
 Missing this will significantly hurt the performance.
 The order should be asending on depth.
 For example, if a product belongs to "Adidas -> Yeezy",
 this field should be:
 [
   {"brand_depth": 1, "id_or_name":"Adidas"},
   {"brand_depth": 2, "id_or_name":"Yeezy"},
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Brand brands = 3;

getBrands

ByteplusSaasRetail.Product.Brand getBrands(int index)

 Required.
 Missing this will significantly hurt the performance.
 The order should be asending on depth.
 For example, if a product belongs to "Adidas -> Yeezy",
 this field should be:
 [
   {"brand_depth": 1, "id_or_name":"Adidas"},
   {"brand_depth": 2, "id_or_name":"Yeezy"},
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Brand brands = 3;

getBrandsCount

int getBrandsCount()

 Required.
 Missing this will significantly hurt the performance.
 The order should be asending on depth.
 For example, if a product belongs to "Adidas -> Yeezy",
 this field should be:
 [
   {"brand_depth": 1, "id_or_name":"Adidas"},
   {"brand_depth": 2, "id_or_name":"Yeezy"},
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Brand brands = 3;

getBrandsOrBuilderList

List<? extends ByteplusSaasRetail.Product.BrandOrBuilder> getBrandsOrBuilderList()

 Required.
 Missing this will significantly hurt the performance.
 The order should be asending on depth.
 For example, if a product belongs to "Adidas -> Yeezy",
 this field should be:
 [
   {"brand_depth": 1, "id_or_name":"Adidas"},
   {"brand_depth": 2, "id_or_name":"Yeezy"},
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Brand brands = 3;

getBrandsOrBuilder

ByteplusSaasRetail.Product.BrandOrBuilder getBrandsOrBuilder(int index)

 Required.
 Missing this will significantly hurt the performance.
 The order should be asending on depth.
 For example, if a product belongs to "Adidas -> Yeezy",
 this field should be:
 [
   {"brand_depth": 1, "id_or_name":"Adidas"},
   {"brand_depth": 2, "id_or_name":"Yeezy"},
 ]
 

repeated .bytedance.byteplus.rec.retail.Product.Brand brands = 3;

hasPrice

boolean hasPrice()

 Required.
 The product price info.
 Please make sure the accuracy and recency.
 

.bytedance.byteplus.rec.retail.Product.Price price = 4;

返回:

Whether the price field is set.

getPrice

ByteplusSaasRetail.Product.Price getPrice()

 Required.
 The product price info.
 Please make sure the accuracy and recency.
 

.bytedance.byteplus.rec.retail.Product.Price price = 4;

返回:

The price.

getPriceOrBuilder

ByteplusSaasRetail.Product.PriceOrBuilder getPriceOrBuilder()

 Required.
 The product price info.
 Please make sure the accuracy and recency.
 

.bytedance.byteplus.rec.retail.Product.Price price = 4;

getIsRecommendable

int getIsRecommendable()

 Required.
 1 if the product is recommendable (result in `Predict` call).
 0 if the product isn't recommendable.
 Note: Any change of this takes up to 1 hour to take effect.
 Note: Even if a product isn't recommendable, please still send this to us.
 This is because that users might interact with such products historically,
 therefore it provides reasonably strong signals.
 

int32 is_recommendable = 5;

返回:

The isRecommendable.

getTitle

String getTitle()

 Required.
 The product title.
 

string title = 6;

返回:

The title.

getTitleBytes

com.google.protobuf.ByteString getTitleBytes()

 Required.
 The product title.
 

string title = 6;

返回:

The bytes for title.

getQualityScore

double getQualityScore()

 Optional.
 The product quality score.
 Note: this is different than user ratings.
 It is normally computed as a composite score considering many factors,
 including sales, customer feedback, information completeness, etc.
 This score should be normalized to [1.0, 5.0]
 

double quality_score = 7;

返回:

The qualityScore.

getTagsList

List<String> getTagsList()

 Optional.
 The tags given by the seller for this product.
 This is used to lift the performance.
 Sample values are: "New", "Summer", "Clearance", etc.
 

repeated string tags = 8;

返回:

A list containing the tags.

getTagsCount

int getTagsCount()

 Optional.
 The tags given by the seller for this product.
 This is used to lift the performance.
 Sample values are: "New", "Summer", "Clearance", etc.
 

repeated string tags = 8;

返回:

The count of tags.

getTags

String getTags(int index)

 Optional.
 The tags given by the seller for this product.
 This is used to lift the performance.
 Sample values are: "New", "Summer", "Clearance", etc.
 

repeated string tags = 8;

参数:

index - The index of the element to return.

返回:

The tags at the given index.

getTagsBytes

com.google.protobuf.ByteString getTagsBytes(int index)

 Optional.
 The tags given by the seller for this product.
 This is used to lift the performance.
 Sample values are: "New", "Summer", "Clearance", etc.
 

repeated string tags = 8;

参数:

index - The index of the value to return.

返回:

The bytes of the tags at the given index.

hasDisplay

boolean hasDisplay()

 Optional.
 The display information of the product.
 

.bytedance.byteplus.rec.retail.Product.Display display = 9;

返回:

Whether the display field is set.

getDisplay

ByteplusSaasRetail.Product.Display getDisplay()

 Optional.
 The display information of the product.
 

.bytedance.byteplus.rec.retail.Product.Display display = 9;

返回:

The display.

getDisplayOrBuilder

ByteplusSaasRetail.Product.DisplayOrBuilder getDisplayOrBuilder()

 Optional.
 The display information of the product.
 

.bytedance.byteplus.rec.retail.Product.Display display = 9;

hasProductSpec

boolean hasProductSpec()

 Optional.
 The product specs.
 

.bytedance.byteplus.rec.retail.Product.ProductSpec product_spec = 10;

返回:

Whether the productSpec field is set.

getProductSpec

ByteplusSaasRetail.Product.ProductSpec getProductSpec()

 Optional.
 The product specs.
 

.bytedance.byteplus.rec.retail.Product.ProductSpec product_spec = 10;

返回:

The productSpec.

getProductSpecOrBuilder

ByteplusSaasRetail.Product.ProductSpecOrBuilder getProductSpecOrBuilder()

 Optional.
 The product specs.
 

.bytedance.byteplus.rec.retail.Product.ProductSpec product_spec = 10;

hasSeller

boolean hasSeller()

 Optional.
 The seller proto.
 

.bytedance.byteplus.rec.retail.Product.Seller seller = 11;

返回:

Whether the seller field is set.

getSeller

ByteplusSaasRetail.Product.Seller getSeller()

 Optional.
 The seller proto.
 

.bytedance.byteplus.rec.retail.Product.Seller seller = 11;

返回:

The seller.

getSellerOrBuilder

ByteplusSaasRetail.Product.SellerOrBuilder getSellerOrBuilder()

 Optional.
 The seller proto.
 

.bytedance.byteplus.rec.retail.Product.Seller seller = 11;

getExtraCount

int getExtraCount()

 Optional.
 This is a catch-all field to pass all the additional information.
 Please provide as much information as possible.
 

map<string, string> extra = 100;

containsExtra

boolean containsExtra(String key)

 Optional.
 This is a catch-all field to pass all the additional information.
 Please provide as much information as possible.
 

map<string, string> extra = 100;

getExtra

@Deprecated
Map<String,String> getExtra()

已过时。

Use getExtraMap() instead.

getExtraMap

Map<String,String> getExtraMap()

 Optional.
 This is a catch-all field to pass all the additional information.
 Please provide as much information as possible.
 

map<string, string> extra = 100;

getExtraOrDefault

String getExtraOrDefault(String key,
                         String defaultValue)

 Optional.
 This is a catch-all field to pass all the additional information.
 Please provide as much information as possible.
 

map<string, string> extra = 100;

getExtraOrThrow

String getExtraOrThrow(String key)

 Optional.
 This is a catch-all field to pass all the additional information.
 Please provide as much information as possible.
 

map<string, string> extra = 100;