function MCAPI::campaignSegmentTest in Mailchimp 7

Same name and namespace in other branches

5.2 MCAPI.class.php \MCAPI::campaignSegmentTest()
5 MCAPI.class.php \MCAPI::campaignSegmentTest()
6.2 MCAPI.class.php \MCAPI::campaignSegmentTest()
6 MCAPI.class.php \MCAPI::campaignSegmentTest()

Allows one to test their segmentation rules before creating a campaign using them

@example mcapi_campaignSegmentTest.php @example xml-rpc_campaignSegmentTest.php

Parameters

string $list_id the list to test segmentation on - get lists using lists():

array $options with 2 keys:: string "match" controls whether to use AND or OR when applying your options - expects "any" (for OR) or "all" (for AND) array "conditions" - up to 10 different criteria to apply while segmenting. Each criteria row must contain 3 keys - "field", "op", and "value" - and possibly a fourth, "extra", based on these definitions:

Field = "date" : Select based on various dates we track Valid Op(eration): eq (is) / gt (after) / lt (before) Valid Values: string last_campaign_sent uses the date of the last campaign sent string campaign_id - uses the send date of the campaign that carriers the Id submitted - see campaigns() string YYYY-MM-DD - any date in the form of YYYY-MM-DD - note: anything that appears to start with YYYY will be treated as a date

Field = "interests": Valid Op(erations): one / none / all Valid Values: a comma delimited of interest groups for the list - see listInterestGroups()

Field = "aim" Valid Op(erations): open / noopen / click / noclick Valid Values: "any" or a valid AIM-enabled Campaign that has been sent

Field = "rating" : allows matching based on list member ratings Valid Op(erations): eq (=) / ne (!=) / gt (>) / lt (<) Valid Values: a number between 0 and 5

Field = "ecomm_prod" or "ecomm_prod": allows matching product and category names from purchases Valid Op(erations): eq (=) / ne (!=) / gt (>) / lt (<) / like (like '%blah%') / nlike (not like '%blah%') / starts (like 'blah%') / ends (like '%blah') Valid Values: any string

Field = "ecomm_spent_one" or "ecomm_spent_all" : allows matching purchase amounts on a single order or all orders Valid Op(erations): gt (>) / lt (<) Valid Values: a number

Field = "ecomm_date" : allow matching based on order dates Valid Op(eration): eq (is) / gt (after) / lt (before) Valid Values: string YYYY-MM-DD - any date in the form of YYYY-MM-DD

Field = An Address Merge Var. Use Merge0-Merge30 or the Custom Tag you've setup for your merge field - see listMergeVars(). Note, Address fields can still be used with the default operations below - this section is broken out solely to highlight the differences in using the geolocation routines. Valid Op(erations): geoin Valid Values: The number of miles an address should be within Extra Value: The Zip Code to be used as the center point

Default Field = A Merge Var. Use Merge0-Merge30 or the Custom Tag you've setup for your merge field - see listMergeVars() Valid Op(erations): eq (=) / ne (!=) / gt (>) / lt (<) / like (like '%blah%') / nlike (not like '%blah%') / starts (like 'blah%') / ends (like '%blah') Valid Values: any string

Return value

integer total The total number of subscribers matching your segmentation options

File

./MCAPI.class.php, line 246

Class

MCAPI

Code

function campaignSegmentTest($list_id, $options) {
  $params = array();
  $params["list_id"] = $list_id;
  $params["options"] = $options;
  return $this
    ->callServer("campaignSegmentTest", $params);
}

You are here