Recommendations and Documents
Recommendations
RecommendationResponse
Declared In
SNRRecommendationResponse.h
Related To
Inherits From
[BaseModel]
Declaration
class RecommendationResponse extends BaseModel
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| name | String |
no | Recommendations name |
| campaignHash | String |
no | Campaign Hash |
| campaignID | String |
no | Campaign ID |
| items | [Recommendation] |
no | List of recommendation items |
Recommendation
Declared In
lib/classes/models/Content/Recommendation.js
Related To
Inherits From
Declaration
class Recommendation extends BaseModel
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| gtin | String |
no | Product’s GTIN |
RecommendationOptions
Declared In
SNRRecommendationOptions.h
Related To
RecommendationFiltersJoinerRule
Declaration
class RecommendationOptions
Properties
| Property | Type | Optional | Description |
|---|---|---|---|
| slug | String |
no | Unique identifier of a specific recommendation |
| productID | String |
no | Product identifier |
| productIDs | [String] |
no | List of product identifiers |
| itemsExcluded | [String] |
no | Items that will be excluded from the generated recommendations |
| additionalFilters | String |
no | Additional filters. These are merged with the campaign’s own filters according to the logic in filtersJoiner |
| filtersJoiner | RecommendationFiltersJoinerRule |
no | Defines the logic of merging additionalFilters with the campaign’s existing filters |
| additionalElasticFilters | String |
no | Additional elastic filters. These are merged with the campaign’s own elastic filters according to the logic in elasticFiltersJoiner |
| elasticFiltersJoiner | RecommendationFiltersJoinerRule |
no | Defines the logic of merging additionalElasticFilters with the campaign’s existing elastic filters |
| displayAttribute | [String] |
no | An array of item attributes which value will be returned in a recommendation response |
| includeContextItems | Bool |
no | When true, the recommendation response will include context item metadata |
RecommendationFiltersJoinerRule
Declared In
SNRRecommendationOptions.h
Declaration
enum RecommendationFiltersJoinerRule: Int {
and,
or,
replace
}
Functions
Converts from RecommendationFiltersJoinerRule to String.
func SNR_RecommendationFiltersJoinerRuleToString(_: RecommendationFiltersJoinerRule) -> String
Documents
DocumentsApiQuery
The object to set parameters easily for fetching documents from API.
Declared In
SNRDocumentsApiQuery.h
Related To
Inherits From
Declaration
class DocumentsApiQuery: NSObject
Properties
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| type | DocumentsApiQueryType |
no | .bySchema | Query type |
| typeValue | String |
no | nil | Value for query type |
| version | String |
yes | nil | Specifies document version |
Initializers
init(type: DocumentsApiQueryType, value: String)
DocumentsApiQueryType
Declared In
SNRDocumentsApiQueryType.h
Declaration
enum DocumentsApiQueryType: Int {
bySchema
}
