Google Cloud Discovery Engine V1beta Client - Class MediaConfig (0.11.3)

Version 0.11.3

• 1.3.1 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class MediaConfig.

Specifies the configurations needed for Media Discovery. Currently we support:

• demote_content_watched: Threshold for watched content demotion.

Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result.

• promote_fresh_content: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Generated from protobuf message google.cloud.discoveryengine.v1beta.ServingConfig.MediaConfig

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta \ ServingConfig

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ content_watched_percentage_threshold	float Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
↳ content_watched_seconds_threshold	float Specifies the content watched minutes threshold for demotion.
↳ demotion_event_type	string Specifies the event type used for demoting recommendation result. Currently supported values: * view-item: Item viewed. * media-play: Start/resume watching a video, playing a song, etc. * media-complete: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.
↳ content_freshness_cutoff_days	int Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.

getContentWatchedPercentageThreshold

Specifies the content watched percentage threshold for demotion.

Threshold value must be between [0, 1.0] inclusive.

Returns
Type	Description
float

hasContentWatchedPercentageThreshold

setContentWatchedPercentageThreshold

Specifies the content watched percentage threshold for demotion.

Threshold value must be between [0, 1.0] inclusive.

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getContentWatchedSecondsThreshold

Specifies the content watched minutes threshold for demotion.

Returns
Type	Description
float

hasContentWatchedSecondsThreshold

setContentWatchedSecondsThreshold

Specifies the content watched minutes threshold for demotion.

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getDemotionEventType

Specifies the event type used for demoting recommendation result.

Currently supported values:

• view-item: Item viewed.
• media-play: Start/resume watching a video, playing a song, etc.
• media-complete: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.

Returns
Type	Description
string

setDemotionEventType

Specifies the event type used for demoting recommendation result.

Currently supported values:

• view-item: Item viewed.
• media-play: Start/resume watching a video, playing a song, etc.
• media-complete: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getContentFreshnessCutoffDays

Specifies the content freshness used for recommendation result.

Contents will be demoted if contents were published for more than content freshness cutoff days.

Returns
Type	Description
int

setContentFreshnessCutoffDays

Specifies the content freshness used for recommendation result.

Contents will be demoted if contents were published for more than content freshness cutoff days.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getDemoteContentWatched

Returns
Type	Description
string