core_v2_contentRecommendation Script API

Ben Tiedt — Fri, 23 Apr 2021 19:55:18 GMT

Current Revision posted to API Documentation by Ben Tiedt on 04/23/2021 19:55:18

Enables scripted content fragments to use content recommendations

IgnoreRecommendation
List

Methods

IgnoreRecommendation

The ignore content recommendations for the accessing user

Velocity

$core_v2_contentRecommendation.IgnoreRecommendation($contentId)

JavaScript

core_v2_contentRecommendation.IgnoreRecommendation(contentId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Returns

Nothing

List

Retrieve a specific content recommendations for the accessing user

Velocity

#set($pagedListResponse = $core_v2_contentRecommendation.List("%{ ContainerIds = $containerIdsArg, ContentTypeIds = $contentTypeIdsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, UseCache = $useCacheArg }"))

JavaScript

var pagedListResponse = core_v2_contentRecommendation.List({ ContainerIds: containerIdsArg, ContentTypeIds: contentTypeIdsArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, UseCache: useCacheArg });

Parameters

Name	Type	Description	Required	Default
options	Options	Set of optional parameters including:	Required
ContainerIds	`String`	Specify the comma-separated list of containers used to scope recommendations.	Optional
ContentTypeIds	`String`	Specify the comma-separated list of types of content to return in recommendations.	Optional
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
UseCache	`Boolean`	Specify whether or not caching can be used to satisfy the request.	Optional

Returns

[[PagedList Script API Type|PagedList]] of [[ContentRecommendation Script API Type|ContentRecommendation]]