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.
String	getBrands() Optional.
com.google.protobuf.ByteString	getBrandsBytes() Optional.
String	getCategories() Optional.
com.google.protobuf.ByteString	getCategoriesBytes() Optional.
int	getCommentCount() Optional.
float	getCurrentPrice() Optional.
String	getDisplayCoverMultimediaUrl() Optional.
com.google.protobuf.ByteString	getDisplayCoverMultimediaUrlBytes() 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() Optional. 1 if the product is recommendable (i.e. to return the product in the recommendation result).
float	getOriginalPrice() Optional.
String	getProductGroupId() Optional.
com.google.protobuf.ByteString	getProductGroupIdBytes() Optional.
String	getProductId() Required.
com.google.protobuf.ByteString	getProductIdBytes() Required.
long	getPublishTimestamp() Optional.
String	getSellerId() Required.
com.google.protobuf.ByteString	getSellerIdBytes() Required.
String	getSellerLevel() Optional.
com.google.protobuf.ByteString	getSellerLevelBytes() Optional.
float	getSellerRating() Optional.
int	getSoldCount() Optional.
String	getSource() Optional.
com.google.protobuf.ByteString	getSourceBytes() Optional.
String	getTags() Optional.
com.google.protobuf.ByteString	getTagsBytes() Optional.
String	getTitle() Optional.
com.google.protobuf.ByteString	getTitleBytes() Optional.
float	getUserRating() 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.

getIsRecommendable

int getIsRecommendable()

 Optional.
 1 if the product is recommendable (i.e. to return the product in the recommendation result).
 Note: Even if a product isn't recommendable, please include it still.
 the is because that users might have interacted with such product in the past, hence providing insights into behavioural propensities.
 

int32 is_recommendable = 2;

返回:

The isRecommendable.

getCurrentPrice

float getCurrentPrice()

 Optional.
 The current/displayed/discounted price of the product. Round to 2.d.p.
 

float current_price = 3;

返回:

The currentPrice.

getOriginalPrice

float getOriginalPrice()

 Optional.
 The original price of the product. Round to 2.d.p.
 

float original_price = 4;

返回:

The originalPrice.

getPublishTimestamp

long getPublishTimestamp()

 Optional.
 The timestamp when the product was published.
 

int64 publish_timestamp = 5;

返回:

The publishTimestamp.

getCategories

String getCategories()

 Optional.
 The (sub)categories the content fall under. Format requirements:
  1. JSON serialised string
  2. Depth starts from 1, in consecutive postive integers
  3. "Category_nodes" should not contain empty value. If empty value exists, replace with "null" .
  4. Only one "id_or_name" key-value pair is allowed under each "category_nodes"
 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"}] },
 ]
 

string categories = 6;

返回:

The categories.

getCategoriesBytes

com.google.protobuf.ByteString getCategoriesBytes()

 Optional.
 The (sub)categories the content fall under. Format requirements:
  1. JSON serialised string
  2. Depth starts from 1, in consecutive postive integers
  3. "Category_nodes" should not contain empty value. If empty value exists, replace with "null" .
  4. Only one "id_or_name" key-value pair is allowed under each "category_nodes"
 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"}] },
 ]
 

string categories = 6;

返回:

The bytes for categories.

getTags

String getTags()

 Optional.
 The (internal) label of the product. Format into JSON serialized string.
 Sample values are: "[\"New\", \"Summer\", \"Clearance\"]", etc.
 

string tags = 7;

返回:

The tags.

getTagsBytes

com.google.protobuf.ByteString getTagsBytes()

 Optional.
 The (internal) label of the product. Format into JSON serialized string.
 Sample values are: "[\"New\", \"Summer\", \"Clearance\"]", etc.
 

string tags = 7;

返回:

The bytes for tags.

getTitle

String getTitle()

 Optional.
 The title/name of the product.
 

string title = 8;

返回:

The title.

getTitleBytes

com.google.protobuf.ByteString getTitleBytes()

 Optional.
 The title/name of the product.
 

string title = 8;

返回:

The bytes for title.

getBrands

String getBrands()

 Optional.
 The brand of the product.
 

string brands = 9;

返回:

The brands.

getBrandsBytes

com.google.protobuf.ByteString getBrandsBytes()

 Optional.
 The brand of the product.
 

string brands = 9;

返回:

The bytes for brands.

getUserRating

float getUserRating()

 Optional.
 The rating given by the users. Non-negative value.
 

float user_rating = 10;

返回:

The userRating.

getSoldCount

int getSoldCount()

 Optional.
 The number of sales of the content if it is paid content.
 

int32 sold_count = 11;

返回:

The soldCount.

getProductGroupId

String getProductGroupId()

 Optional.
 The ID of the group/unit for products with common characteristics.
 

string product_group_id = 12;

返回:

The productGroupId.

getProductGroupIdBytes

com.google.protobuf.ByteString getProductGroupIdBytes()

 Optional.
 The ID of the group/unit for products with common characteristics.
 

string product_group_id = 12;

返回:

The bytes for productGroupId.

getDisplayCoverMultimediaUrl

String getDisplayCoverMultimediaUrl()

 Optional.
 The URL of the cover multimedia for the product. Format into JSON serialized string.
 

string display_cover_multimedia_url = 13;

返回:

The displayCoverMultimediaUrl.

getDisplayCoverMultimediaUrlBytes

com.google.protobuf.ByteString getDisplayCoverMultimediaUrlBytes()

 Optional.
 The URL of the cover multimedia for the product. Format into JSON serialized string.
 

string display_cover_multimedia_url = 13;

返回:

The bytes for displayCoverMultimediaUrl.

getCommentCount

int getCommentCount()

 Optional.
 The number of comments of the content.
 

int32 comment_count = 14;

返回:

The commentCount.

getSource

String getSource()

 Optional.
 The source of the product..
 For example, "self", "thirdparty", "other".
 

string source = 15;

返回:

The source.

getSourceBytes

com.google.protobuf.ByteString getSourceBytes()

 Optional.
 The source of the product..
 For example, "self", "thirdparty", "other".
 

string source = 15;

返回:

The bytes for source.

getSellerId

String getSellerId()

 Required.
 The ID of the seller.
 

string seller_id = 16;

返回:

The sellerId.

getSellerIdBytes

com.google.protobuf.ByteString getSellerIdBytes()

 Required.
 The ID of the seller.
 

string seller_id = 16;

返回:

The bytes for sellerId.

getSellerLevel

String getSellerLevel()

 Optional.
 The tier/level of the seller.
 

string seller_level = 17;

返回:

The sellerLevel.

getSellerLevelBytes

com.google.protobuf.ByteString getSellerLevelBytes()

 Optional.
 The tier/level of the seller.
 

string seller_level = 17;

返回:

The bytes for sellerLevel.

getSellerRating

float getSellerRating()

 Optional.
 The seller's rating given by the customers. Non-negative value.
 

float seller_rating = 21;

返回:

The sellerRating.

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;