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	getAvailableLocation() ''' Optional.
com.google.protobuf.ByteString	getAvailableLocationBytes() ''' Optional.
String	getCategories() ''' Required.
com.google.protobuf.ByteString	getCategoriesBytes() ''' Required.
String	getCollectionId() ''' Optional.
com.google.protobuf.ByteString	getCollectionIdBytes() ''' Optional.
int	getCommentsCount() ''' Optional.
String	getContentId() ''' Required.
com.google.protobuf.ByteString	getContentIdBytes() ''' Required.
String	getContentOwner() ''' Optional.
com.google.protobuf.ByteString	getContentOwnerBytes() ''' Optional.
int	getContentOwnerFollowers() ''' Optional.
String	getContentOwnerName() ''' Optional.
com.google.protobuf.ByteString	getContentOwnerNameBytes() ''' Optional.
float	getContentOwnerRating() ''' Optional.
String	getContentTitle() ''' Optional.
com.google.protobuf.ByteString	getContentTitleBytes() ''' Optional.
String	getContentType() ''' Required.
com.google.protobuf.ByteString	getContentTypeBytes() ''' Required.
int	getCopyrightEndTimestamp() ''' Optional.
int	getCopyrightStartTimestamp() ''' Optional.
int	getCurrentPrice() ''' Required.
String	getDescription() ''' Optional.
com.google.protobuf.ByteString	getDescriptionBytes() ''' Optional.
int	getDetailPicNum() ''' 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() ''' Required. 1 if the content is recommendable (i.e. we can return this content in the recommendation result). 0 if the content isn't recommendable.
String	getLanguage() ''' Optional.
com.google.protobuf.ByteString	getLanguageBytes() ''' Optional.
int	getLikesCount() ''' Optional.
int	getOriginalPrice() ''' Optional.
int	getPublishTimestamp() ''' Optional.
String	getRelatedContentIds() ''' Optional.
com.google.protobuf.ByteString	getRelatedContentIdsBytes() ''' Optional.
int	getSaveCount() ''' Optional.
int	getSharesCount() ''' Optional.
int	getSoldCount() ''' Optional.
String	getSource() ''' Optional.
com.google.protobuf.ByteString	getSourceBytes() ''' Optional.
String	getTags() ''' Optional.
com.google.protobuf.ByteString	getTagsBytes() ''' Optional.
String	getTopicTags() ''' Optional.
com.google.protobuf.ByteString	getTopicTagsBytes() ''' Optional.
int	getUpdateTimestamp() ''' Optional.
float	getUserRating() ''' Optional.
int	getVideoDuration() ''' Based content_type.
String	getVideoUrls() ''' Optional.
com.google.protobuf.ByteString	getVideoUrlsBytes() ''' Optional.
int	getViewsCount() ''' 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.
 Sample values are "12345678", "146582662088489399", etc.
 '''
 

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.
 Sample values are "12345678", "146582662088489399", etc.
 '''
 

string content_id = 1;

返回:

The bytes for contentId.

getIsRecommendable

int getIsRecommendable()

 '''
 Required.
 1 if the content is recommendable (i.e. we can return this content in the recommendation result).
 0 if the content isn't recommendable.
 Note:
  * Even if a content isn't recommendable, please still send this to us.
    This is because that users might interact with such contents historically,
    therefore it provides reasonably strong signals.
 '''
 

int32 is_recommendable = 2;

返回:

The isRecommendable.

getCategories

String getCategories()

 '''
 Required.
 Json Array, should serializer to string
 The categories this content belongs to.
 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 = 3;

返回:

The categories.

getCategoriesBytes

com.google.protobuf.ByteString getCategoriesBytes()

 '''
 Required.
 Json Array, should serializer to string
 The categories this content belongs to.
 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 = 3;

返回:

The bytes for categories.

getContentType

String getContentType()

 '''
 Required.
 Type of the content.
 The accepted values are "picture", "gif", "video", "text", "other".
 Note:
  * if the content_type is video, video_duration must be non-zero.
 '''
 

string content_type = 4;

返回:

The contentType.

getContentTypeBytes

com.google.protobuf.ByteString getContentTypeBytes()

 '''
 Required.
 Type of the content.
 The accepted values are "picture", "gif", "video", "text", "other".
 Note:
  * if the content_type is video, video_duration must be non-zero.
 '''
 

string content_type = 4;

返回:

The bytes for contentType.

getVideoDuration

int getVideoDuration()

 '''
 Based content_type.
 If content_type is video, this field is required.
 Provide the length this video, in milliseconds.
 Sample values are 1200000, etc.
 '''
 

int32 video_duration = 5;

返回:

The videoDuration.

getContentTitle

String getContentTitle()

 '''
 Optional.
 The content title.
 Sample values are "Video #1", "Titanic clip", etc.
 '''
 

string content_title = 6;

返回:

The contentTitle.

getContentTitleBytes

com.google.protobuf.ByteString getContentTitleBytes()

 '''
 Optional.
 The content title.
 Sample values are "Video #1", "Titanic clip", etc.
 '''
 

string content_title = 6;

返回:

The bytes for contentTitle.

getDescription

String getDescription()

 '''
 Optional.
 The content description.
 '''
 

string description = 7;

返回:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 '''
 Optional.
 The content description.
 '''
 

string description = 7;

返回:

The bytes for description.

getContentOwner

String getContentOwner()

 '''
 Optional.
 The account who created the content (i.e. the user_id) or the publisher of a video.
 Sample values are "1234567", "359938082141597", "665DEA957EBFB34D41B1F1D80E4B5F89" etc.
 '''
 

string content_owner = 8;

返回:

The contentOwner.

getContentOwnerBytes

com.google.protobuf.ByteString getContentOwnerBytes()

 '''
 Optional.
 The account who created the content (i.e. the user_id) or the publisher of a video.
 Sample values are "1234567", "359938082141597", "665DEA957EBFB34D41B1F1D80E4B5F89" etc.
 '''
 

string content_owner = 8;

返回:

The bytes for contentOwner.

getContentOwnerFollowers

int getContentOwnerFollowers()

 '''
 Optional.
 The number of followers of the content owner.
 Sample values are 0, 1000, 1000000, etc.
 '''
 

int32 content_owner_followers = 9;

返回:

The contentOwnerFollowers.

getContentOwnerRating

float getContentOwnerRating()

 '''
 Optional.
 The rating, if any, of this content owner.
 Sample values are 3.5, 98.0 etc.
 '''
 

float content_owner_rating = 10;

返回:

The contentOwnerRating.

getContentOwnerName

String getContentOwnerName()

 '''
 Optional.
 The name of this content owner.
 Sample values are "testuser#1", etc.
 '''
 

string content_owner_name = 11;

返回:

The contentOwnerName.

getContentOwnerNameBytes

com.google.protobuf.ByteString getContentOwnerNameBytes()

 '''
 Optional.
 The name of this content owner.
 Sample values are "testuser#1", etc.
 '''
 

string content_owner_name = 11;

返回:

The bytes for contentOwnerName.

getCollectionId

String getCollectionId()

 '''
 Optional.
 If this content belongs to any collection, put the collection id here.
 Sample values are "1234" etc.
 '''
 

string collection_id = 12;

返回:

The collectionId.

getCollectionIdBytes

com.google.protobuf.ByteString getCollectionIdBytes()

 '''
 Optional.
 If this content belongs to any collection, put the collection id here.
 Sample values are "1234" etc.
 '''
 

string collection_id = 12;

返回:

The bytes for collectionId.

getTags

String getTags()

 '''
 Optional.
 Json Array, should serializer to string.
 Internal label of this content.
 Sample values are "[\"New\", \"Trending\"]", etc.
 '''
 

string tags = 13;

返回:

The tags.

getTagsBytes

com.google.protobuf.ByteString getTagsBytes()

 '''
 Optional.
 Json Array, should serializer to string.
 Internal label of this content.
 Sample values are "[\"New\", \"Trending\"]", etc.
 '''
 

string tags = 13;

返回:

The bytes for tags.

getTopicTags

String getTopicTags()

 '''
 Optional.
 Json Array, should serializer to string.
 If this content belongs to a topic, put the tags of the topic here.
 Sample values are "[\"Political\", \"Latest\"]", etc.
 '''
 

string topic_tags = 14;

返回:

The topicTags.

getTopicTagsBytes

com.google.protobuf.ByteString getTopicTagsBytes()

 '''
 Optional.
 Json Array, should serializer to string.
 If this content belongs to a topic, put the tags of the topic here.
 Sample values are "[\"Political\", \"Latest\"]", etc.
 '''
 

string topic_tags = 14;

返回:

The bytes for topicTags.

getImageUrls

String getImageUrls()

 '''
 Optional.
 Json Array, should serializer to string.
 Provide the url to the image file here.
 Sample values are "[\"https://images-na.ssl-images-amazon.com/images/I/81WmojBxvbL._AC_UL1500_.jpg\"]", etc.
 '''
 

string image_urls = 15;

返回:

The imageUrls.

getImageUrlsBytes

com.google.protobuf.ByteString getImageUrlsBytes()

 '''
 Optional.
 Json Array, should serializer to string.
 Provide the url to the image file here.
 Sample values are "[\"https://images-na.ssl-images-amazon.com/images/I/81WmojBxvbL._AC_UL1500_.jpg\"]", etc.
 '''
 

string image_urls = 15;

返回:

The bytes for imageUrls.

getDetailPicNum

int getDetailPicNum()

 '''
 Optional.
 The number of images that are displayed on the detail page.
 Sample values are 1, 5, etc.
 '''
 

int32 detail_pic_num = 16;

返回:

The detailPicNum.

getVideoUrls

String getVideoUrls()

 '''
 Optional.
 Json Array, should serializer to string.
 Provide the url to the video file here.
 Sample values are "[\"https://test_video.mov\"]", etc.
 '''
 

string video_urls = 17;

返回:

The videoUrls.

getVideoUrlsBytes

com.google.protobuf.ByteString getVideoUrlsBytes()

 '''
 Optional.
 Json Array, should serializer to string.
 Provide the url to the video file here.
 Sample values are "[\"https://test_video.mov\"]", etc.
 '''
 

string video_urls = 17;

返回:

The bytes for videoUrls.

getUserRating

float getUserRating()

 '''
 Optional.
 The rating given by the users.
 The value is normalized to [0.0, 5.0].
 The accepted value range is [0.0, 5.0].
 '''
 

float user_rating = 18;

返回:

The userRating.

getViewsCount

int getViewsCount()

 '''
 Optional.
 The number of views for this content.
 Sample values are 10000, etc.
 '''
 

int32 views_count = 19;

返回:

The viewsCount.

getCommentsCount

int getCommentsCount()

 '''
 Optional.
 The number of comments for this content.
 Sample values are 100, etc.
 '''
 

int32 comments_count = 20;

返回:

The commentsCount.

getLikesCount

int getLikesCount()

 '''
 Optional.
 The number of likes for this content.
 Sample values are 10, etc.
 '''
 

int32 likes_count = 21;

返回:

The likesCount.

getSharesCount

int getSharesCount()

 '''
 Optional.
 The number of shares for this content.
 Sample values are 50, etc.
 '''
 

int32 shares_count = 22;

返回:

The sharesCount.

getSaveCount

int getSaveCount()

 '''
 Optional.
 The number of saves for this content.
 Sample values are 50, etc.
 '''
 

int32 save_count = 23;

返回:

The saveCount.

getCurrentPrice

int getCurrentPrice()

 '''
 Required.
 If this is paid_content, send the current price (after discount) in cents.
 e.g. $100.12 should be 10012 here.
 '''
 

int32 current_price = 24;

返回:

The currentPrice.

getOriginalPrice

int getOriginalPrice()

 '''
 Optional.
 If this is paid_content, send the original price (before discount) in cents
 e.g. $100.12 should be 10012 here.
 '''
 

int32 original_price = 25;

返回:

The originalPrice.

getAvailableLocation

String getAvailableLocation()

 '''
 Optional.
 Json Array, should serializer to string.
 The location tags of this content.
 Sample values are "[\"Cafe 101\"]", etc.
 '''
 

string available_location = 26;

返回:

The availableLocation.

getAvailableLocationBytes

com.google.protobuf.ByteString getAvailableLocationBytes()

 '''
 Optional.
 Json Array, should serializer to string.
 The location tags of this content.
 Sample values are "[\"Cafe 101\"]", etc.
 '''
 

string available_location = 26;

返回:

The bytes for availableLocation.

getPublishTimestamp

int getPublishTimestamp()

 '''
 Optional.
 The timestamp that the content is published.
 Sample values are 1623193487, etc.
 '''
 

int32 publish_timestamp = 27;

返回:

The publishTimestamp.

getUpdateTimestamp

int getUpdateTimestamp()

 '''
 Optional.
 The timestamp that the content is updated.
 Sample values are 1623193487, etc.
 '''
 

int32 update_timestamp = 28;

返回:

The updateTimestamp.

getCopyrightStartTimestamp

int getCopyrightStartTimestamp()

 '''
 Optional.
 The timestamp when this content can be shown to users.
 Sample values are 1623193487, etc.
 '''
 

int32 copyright_start_timestamp = 29;

返回:

The copyrightStartTimestamp.

getCopyrightEndTimestamp

int getCopyrightEndTimestamp()

 '''
 Optional.
 The timestamp when this content stop being available to users.
 Sample values are 1623193487, etc.
 '''
 

int32 copyright_end_timestamp = 30;

返回:

The copyrightEndTimestamp.

getIsPaidContent

boolean getIsPaidContent()

 '''
 Optional.
 Whether this content requires payment/subscription to view.
 '''
 

bool is_paid_content = 31;

返回:

The isPaidContent.

getLanguage

String getLanguage()

 '''
 Optional.
 The languages used in this content.
 Sample values are "English", "Chinese", etc.
 '''
 

string language = 32;

返回:

The language.

getLanguageBytes

com.google.protobuf.ByteString getLanguageBytes()

 '''
 Optional.
 The languages used in this content.
 Sample values are "English", "Chinese", etc.
 '''
 

string language = 32;

返回:

The bytes for language.

getRelatedContentIds

String getRelatedContentIds()

 '''
 Optional.
 Json Array, should serializer to string.
 If your platform currently provides "Related Content" recommendation, send the list of related content ids here.
 Sample values are "[\"12345678\",\"12345679\"]", etc.
 '''
 

string related_content_ids = 33;

返回:

The relatedContentIds.

getRelatedContentIdsBytes

com.google.protobuf.ByteString getRelatedContentIdsBytes()

 '''
 Optional.
 Json Array, should serializer to string.
 If your platform currently provides "Related Content" recommendation, send the list of related content ids here.
 Sample values are "[\"12345678\",\"12345679\"]", etc.
 '''
 

string related_content_ids = 33;

返回:

The bytes for relatedContentIds.

getSoldCount

int getSoldCount()

 '''
 Optional.
 If this content requires payment, provide the number of purchases.
 Sample values are 100, etc.
 '''
 

int32 sold_count = 34;

返回:

The soldCount.

getSource

String getSource()

 '''
 Optional.
 The source of the content.
 The accepted values are ["self", "thirdparty", "other"].
 '''
 

string source = 35;

返回:

The source.

getSourceBytes

com.google.protobuf.ByteString getSourceBytes()

 '''
 Optional.
 The source of the content.
 The accepted values are ["self", "thirdparty", "other"].
 '''
 

string source = 35;

返回:

The bytes for source.

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;