Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 2.48 KB

CreateTemplateCampaign.md

File metadata and controls

35 lines (28 loc) · 2.48 KB
Raw

TalonOne::CreateTemplateCampaign

Properties

Name Type Description Notes
name String A user-facing name for this campaign.
description String A detailed description of the campaign. [optional]
template_id Integer The ID of the Campaign Template which will be used in order to create the Campaign.
campaign_attributes_overrides Object Custom Campaign Attributes. If the Campaign Template defines the same values, they will be overridden. [optional]
template_param_values Array<Binding> Actual values to replace the template placeholder values in the Ruleset bindings. Values for all Template Parameters must be provided. [optional]
limit_overrides Array<LimitConfig> Limits for this Campaign. If the Campaign Template or Application define default values for the same limits, they will be overridden. [optional]
campaign_groups Array<Integer> The IDs of the campaign groups this campaign belongs to. [optional]
tags Array<String> A list of tags for the campaign. If the campaign template has tags, they will be overridden by this list. [optional]
evaluation_group_id Integer The ID of the campaign evaluation group the campaign belongs to. [optional]
linked_store_ids Array<Integer> A list of store IDs that are linked to the campaign. Note: Campaigns with linked store IDs will only be evaluated when there is a customer session update that references a linked store. [optional]

Code Sample

require 'TalonOne'

instance = TalonOne::CreateTemplateCampaign.new(name: Discount campaign,
                                 description: This template is for discount campaigns.,
                                 template_id: 4,
                                 campaign_attributes_overrides: null,
                                 template_param_values: null,
                                 limit_overrides: null,
                                 campaign_groups: [1, 3],
                                 tags: [summer],
                                 evaluation_group_id: 2,
                                 linked_store_ids: [1, 2, 3])