core_v2_contentViews Script API

Former Member — Fri, 13 May 2022 19:25:11 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:25:11

Enables scripted content fragments to use Content Views

Methods

Get the total number of views of a piece of content

#set($contentViewedItemResponse = $core_v2_contentViews.GetViewCount($contentId, $contentTypeId, "%{ ViewTypeId = $viewTypeIdArg }"))

var contentViewedItemResponse = core_v2_contentViews.GetViewCount(contentId, contentTypeId, { ViewTypeId: viewTypeIdArg });

Name	Type	Description	Required
contentId	`Guid`	ID of the content being viewed	Required
contentTypeId	`Guid`	Content Type ID of the content being viewed	Required
options	Options	Set of optional parameters including:	Required
ViewTypeId	`Guid`	ID representing type of view	Optional

[[ContentViewedItem Script API Type|ContentViewedItem]]

Create a record of a piece of content being viewed. DEPRECATED in v12: Instead use the method signature that includes an options parameter.

$core_v2_contentViews.IncrementViewCount($contentId, $contentTypeId, $viewTypeId)

core_v2_contentViews.IncrementViewCount(contentId, contentTypeId, viewTypeId);

Name	Type	Description	Required
contentId	`Guid`	ID of the content being viewed	Required
contentTypeId	`Guid`	Content Type ID of the content being viewed	Required
viewTypeId	`Guid`	ID representing type of view	Required

Create a record of a piece of content being viewed

$core_v2_contentViews.IncrementViewCount($contentId, $contentTypeId, "%{ ViewTypeId = $viewTypeIdArg }")

core_v2_contentViews.IncrementViewCount(contentId, contentTypeId, { ViewTypeId: viewTypeIdArg });

Name	Type	Description	Required
contentId	`Guid`	ID of the content being viewed	Required
contentTypeId	`Guid`	Content Type ID of the content being viewed	Required
options	Options	Set of optional parameters including:	Required
ViewTypeId	`Guid`	The view type id of the content view. As of 12.1 the default value is '00000000-0000-0000-0000-000000000000'. If passing in a legacy value, the return value will contain a ViewTypeId value of '00000000-0000-0000-0000-000000000000'.	Optional

Nothing