com.byteplus.rec.sdk.content.protocol

接口 ByteplusSaasContent.ContentOrBuilder

所有超级接口:

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

所有已知实现类:

ByteplusSaasContent.Content, ByteplusSaasContent.Content.Builder

封闭类:

ByteplusSaasContent

public static interface ByteplusSaasContent.ContentOrBuilder
extends com.google.protobuf.MessageOrBuilder

方法概要

限定符和类型	方法和说明
boolean	containsExtra(String key) Optional.
String	getCategories() Optional.
com.google.protobuf.ByteString	getCategoriesBytes() Optional.
String	getCollectionId() Optional.
com.google.protobuf.ByteString	getCollectionIdBytes() Optional.
String	getContentId() Required.
com.google.protobuf.ByteString	getContentIdBytes() Required.
String	getContentOwnerId() Optional.
com.google.protobuf.ByteString	getContentOwnerIdBytes() Optional.
String	getContentTitle() Optional.
com.google.protobuf.ByteString	getContentTitleBytes() Optional.
String	getContentType() Optional.
com.google.protobuf.ByteString	getContentTypeBytes() Optional.
float	getCurrentPrice() Optional.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() 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.
String	getImageUrls() Optional.
com.google.protobuf.ByteString	getImageUrlsBytes() Optional.
boolean	getIsPaidContent() Optional.
int	getIsRecommendable() Optional. 1 if the content is recommendable (i.e. to return the content in the recommendation result).
String	getLanguage() Optional.
com.google.protobuf.ByteString	getLanguageBytes() Optional.
String	getLinkedProductId() Optional.
com.google.protobuf.ByteString	getLinkedProductIdBytes() Optional.
float	getOriginalPrice() Optional.
long	getPublishTimestamp() Optional.
String	getSource() Optional.
com.google.protobuf.ByteString	getSourceBytes() Optional.
String	getTags() Optional.
com.google.protobuf.ByteString	getTagsBytes() Optional.
float	getUserRating() Optional.
int	getVideoDuration() Optional.
String	getVideoUrls() Optional.
com.google.protobuf.ByteString	getVideoUrlsBytes() Optional.

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

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

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

isInitialized

方法详细资料

getContentId

String getContentId()

 Required.
 The unique identifier for the content, can be series_id/entity_id/video_id/other unique identifier.
 

string content_id = 1;

返回:

The contentId.

getContentIdBytes

com.google.protobuf.ByteString getContentIdBytes()

 Required.
 The unique identifier for the content, can be series_id/entity_id/video_id/other unique identifier.
 

string content_id = 1;

返回:

The bytes for contentId.

getContentType

String getContentType()

 Optional.
 The type of the content. .
 

string content_type = 2;

返回:

The contentType.

getContentTypeBytes

com.google.protobuf.ByteString getContentTypeBytes()

 Optional.
 The type of the content. .
 

string content_type = 2;

返回:

The bytes for contentType.

getIsRecommendable

int getIsRecommendable()

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

int32 is_recommendable = 3;

返回:

The isRecommendable.

getLanguage

String getLanguage()

 Optional.
 The languages used in the content.
 

string language = 4;

返回:

The language.

getLanguageBytes

com.google.protobuf.ByteString getLanguageBytes()

 Optional.
 The languages used in the content.
 

string language = 4;

返回:

The bytes for language.

getContentTitle

String getContentTitle()

 Optional.
 The title of the content.
 

string content_title = 5;

返回:

The contentTitle.

getContentTitleBytes

com.google.protobuf.ByteString getContentTitleBytes()

 Optional.
 The title of the content.
 

string content_title = 5;

返回:

The bytes for contentTitle.

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 in origin json object, if a content has "Movie -> Comedy"
 This should be:
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Movie"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Comedy"}] }
 ]
 If a content belongs to 2 different categories,
 "Movie -> Comedy" and "Movie -> Action"
 then
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Movie"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Comedy"},
                       {"id_or_name":"Action"}] }
 ]
 then you should serialize the json object to string, for example in python:
 categories = json.dumps( [
     {"category_depth":1,
      "category_nodes": [{"id_or_name":"Movie"}] },
     {"category_depth":2,
      "category_nodes": [{"id_or_name":"Comedy"}] }
   ])
 

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 in origin json object, if a content has "Movie -> Comedy"
 This should be:
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Movie"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Comedy"}] }
 ]
 If a content belongs to 2 different categories,
 "Movie -> Comedy" and "Movie -> Action"
 then
 [
   {"category_depth":1,
    "category_nodes": [{"id_or_name":"Movie"}] },
   {"category_depth":2,
    "category_nodes": [{"id_or_name":"Comedy"},
                       {"id_or_name":"Action"}] }
 ]
 then you should serialize the json object to string, for example in python:
 categories = json.dumps( [
     {"category_depth":1,
      "category_nodes": [{"id_or_name":"Movie"}] },
     {"category_depth":2,
      "category_nodes": [{"id_or_name":"Comedy"}] }
   ])
 

string categories = 6;

返回:

The bytes for categories.

getTags

String getTags()

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

string tags = 7;

返回:

The tags.

getTagsBytes

com.google.protobuf.ByteString getTagsBytes()

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

string tags = 7;

返回:

The bytes for tags.

getCollectionId

String getCollectionId()

 Optional.
 The ID of the colllection, if any, to which the content belongs.
 

string collection_id = 8;

返回:

The collectionId.

getCollectionIdBytes

com.google.protobuf.ByteString getCollectionIdBytes()

 Optional.
 The ID of the colllection, if any, to which the content belongs.
 

string collection_id = 8;

返回:

The bytes for collectionId.

getPublishTimestamp

long getPublishTimestamp()

 Optional.
 The timestamp when the content was published.
 

int64 publish_timestamp = 9;

返回:

The publishTimestamp.

getContentOwnerId

String getContentOwnerId()

 Optional.
 The user_id of the content creator.
 

string content_owner_id = 10;

返回:

The contentOwnerId.

getContentOwnerIdBytes

com.google.protobuf.ByteString getContentOwnerIdBytes()

 Optional.
 The user_id of the content creator.
 

string content_owner_id = 10;

返回:

The bytes for contentOwnerId.

getVideoDuration

int getVideoDuration()

 Optional.
 The length of the video in milliseconds.
 

int32 video_duration = 11;

返回:

The videoDuration.

getDescription

String getDescription()

 Optional.
 The detailed description of the content.
 

string description = 12;

返回:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Optional.
 The detailed description of the content.
 

string description = 12;

返回:

The bytes for description.

getLinkedProductId

String getLinkedProductId()

 Optional.
 The product_id of the goods sold via the content.
 

string linked_product_id = 13;

返回:

The linkedProductId.

getLinkedProductIdBytes

com.google.protobuf.ByteString getLinkedProductIdBytes()

 Optional.
 The product_id of the goods sold via the content.
 

string linked_product_id = 13;

返回:

The bytes for linkedProductId.

getVideoUrls

String getVideoUrls()

 Optional.
 The URL of the video. Format into JSON serialized string.
 

string video_urls = 14;

返回:

The videoUrls.

getVideoUrlsBytes

com.google.protobuf.ByteString getVideoUrlsBytes()

 Optional.
 The URL of the video. Format into JSON serialized string.
 

string video_urls = 14;

返回:

The bytes for videoUrls.

getImageUrls

String getImageUrls()

 Optional.
 The URL of the image (e.g. thumbnail). Format into JSON serialized string.
 

string image_urls = 15;

返回:

The imageUrls.

getImageUrlsBytes

com.google.protobuf.ByteString getImageUrlsBytes()

 Optional.
 The URL of the image (e.g. thumbnail). Format into JSON serialized string.
 

string image_urls = 15;

返回:

The bytes for imageUrls.

getUserRating

float getUserRating()

 Optional.
 The rating of the content. Non-negative value.
 

float user_rating = 16;

返回:

The userRating.

getIsPaidContent

boolean getIsPaidContent()

 Optional.
 True if the content requires payment/subscription to view
 

bool is_paid_content = 17;

返回:

The isPaidContent.

getSource

String getSource()

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

string source = 18;

返回:

The source.

getSourceBytes

com.google.protobuf.ByteString getSourceBytes()

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

string source = 18;

返回:

The bytes for source.

getCurrentPrice

float getCurrentPrice()

 Optional.
 The price (after discount) of the content in cents if it is paid content.
 

float current_price = 19;

返回:

The currentPrice.

getOriginalPrice

float getOriginalPrice()

 Optional.
 The price (before discount) of the content in cents if it is paid content.
 

float original_price = 20;

返回:

The originalPrice.

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;