Commerce Foundation ContentSelectorCollection

This commerce entity lets you batch multiple content selector ContentSelector queriesinto a single operation. This is required to make sure that successive content selector queries do not select duplicate advertisements. ContentSelectorCollectionCampaignHistory member returns the aggregate history generated for all ContentSelector queries that run during the operation. You should associate ContentSelectorCollection.CampaignHistory with the current shopper in a ContentSelectorCollection query, instead of the child ContentSelector.CampaignHistory values.

Model

This commerce entity can be modified, as required. This model, taken from the out-of-the-box site, is provided as an example.

<CommerceEntity name="ContentSelectorCollection">
    <DisplayName value="Content Selector Collection"/>
    <Description value="Represents a set of ContentSelectors that will be queried in a way that prevents duplicate Advertisements from being selected, and with in a single operation request."/>
    <Properties>
      <Property name="CampaignHistory" dataType="Array">
        <DisplayName value="Campaign History"/>
        <Description value="The ids of the advertisements that have been recently viewed by the user for which the advertising content is being selected. "/>
      </Property>
    </Properties>
    <Relationships>
      <Relationship name="ContentSelectors" type="Relationship" modelName="ContentSelector" isMultipleItems="true">
        <DisplayName value="Content Selectors"/>
        <Description value="Represents the set of ContentSelectors that will be queried."/>
      </Relationship>
    </Relationships>
</CommerceEntity>

Properties

Property

Type

Description

CampaignHistory

String[]

Aggregate campaign history generated by all ContentSelector queries that are run during the operation.

Relationships

Property

Description

ContentSelectors

Relationship list that contains a set of ContentSelectors that the system should run in a single operation.

Supported Operations

The Content Selector Collection entity supports the following operations:

Commerce Foundation ContentSelectorCollection CommerceQuery

See Also

Other Resources

Commerce Foundation ContentSelector

Commerce Foundation ContentSelectorCollection CommerceQuery