Children Quota Examples
Unlike all other qualification codes - the qualification codes for child age & child gender do not go in the qualifications array. These targeting criteria should be defined in the quota's targeting criteria only.
When declaring quotas for children- you must always include qualification code 218 (has children), 220 (child's gender), 230 (child's age)
Create a survey with nested quotas. The survey is looking for 1000 completes.
Children (rename to Kids): 218, No children is 111, have children is 112
Kids Gender: 220, Boy 111, Girl 112
Kids Age Range: 230 (from-to ranges)
(from-to ranges)
Create Survey
Request
POST $apihost/$basepath/surveys
($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header)
Parameters:
Body:
Result
Response Code
201
Response Body
Notes
// This example will itemize multiple scenarios as listed below:
// 1. … 400 completes with kids and 600 without kids
// 2. … 1000 completes with kids
// 3. 1000 with kids age range 4-12
// 4. 1000 completes with kids; Only Boys
// 5. 1000 completes with kids; 400 with boys, 600 with girls
// 6. 1000 completes with kids; 200 boys, age-range 0-3; 300 boys age-range 4-9; 500 girls
// 7. 400 with kids, 600 without kids; of the 400 with kids, 300 boys age 4-6 100 boys age 7-9
// Scenario-1: 400 completes with kids and 600 without kids
{
"survey_title": "Automobile Preferences",
"survey_category_code": 231,
"survey_localization": "en_US",
"completes_required": 1000,
"expected_ir": 60,
"expected_loi": 60,
"live_url": "http://www.mybuyer.com/surveys_134",
"test_url": "http://www.mybuyer.com/surveys_134t",
"field_time": 10,
"qualifications": [
{
"qualification_code": 218,
"condition_codes": ["111", "112"]
}
],
"quotas": [
{
"buyer_quota_id": "b11111",
"required_count": 400,
"criteria": [
{"qualification_code": 218,"condition_codes": ["111"]} //Have children
]
},
{
"buyer_quota_id": "b11112",
"required_count": 600,
"criteria": [
{"qualification_code": 218,"condition_codes": ["112"]} //Don't have children
]
}
]
}
// Scenario-2: 1000 completes with kids
{
//...
"qualifications": [
{
"qualification_code": 218,
"condition_codes": ["111"]
}
]
// No need to set quotas because all completes will be for respondents with kids
}
// Scenario-3: 1000 with kids age range 4-12
{
"qualifications": [
{"qualification_code": 218,"condition_codes": ["111"]}
],
"quotas": [
{
"buyer_quota_id": "b11111",
"required_count": 400,
"criteria": [
{"qualification_code": 230,"range_sets": [{"from": 4,"to": 12,"units": 311}]},
{"qualification_code": 218,"condition_codes": ["111"]},
{"qualification_code": 220,"condition_codes": ["111","112"]}]
}
]
}
// Scenario-4: 1000 completes with only Boys
{
"qualifications": [
{"qualification_code": 218,"condition_codes": ["111"]}
],
"quotas": [
{
"buyer_quota_id": "b11111",
"required_count": 400,
"criteria": [
{"qualification_code": 230,"range_sets": [{"from": 0,"to": 18,"units": 311}]},
{"qualification_code": 218,"condition_codes": ["111"]},
{"qualification_code": 220,"condition_codes": ["111"]}
]
}
]
}
// Scenario-5: 1000 completes with Kids, 400 boys 600 girls
{
"qualifications": [
{"qualification_code": 218,"condition_codes": ["111"]}
],
"quotas": [
{
"buyer_quota_id": "b11111",
"required_count": 400,
"criteria": [
{"qualification_code": 230,"range_sets": [{"from": 0,"to": 18,"units": 311}]},
{"qualification_code": 218,"condition_codes": ["111"]},
{"qualification_code": 220,"condition_codes": ["111"]}
]
},
{
"buyer_quota_id": "b11112",
"required_count": 600,
"criteria": [
{"qualification_code": 230,"range_sets": [{"from": 0,"to": 18,"units": 311}]},
{"qualification_code": 218,"condition_codes": ["111"]},
{"qualification_code": 220,"condition_codes": ["112"]}
]
}
]
}
// 6. 1000 completes with kids; 200 boys, age-range 0-3; 300 boys age-range 4-9; 500 girls
{
"qualifications": [
{"qualification_code": 218,"condition_codes": ["111"]}
],
"quotas": [
{
"buyer_quota_id": "b11111",
"required_count": 200,
"criteria": [
{"qualification_code": 230,"range_sets": [{"from": 0,"to": 3,"units": 311}]},
{"qualification_code": 218,"condition_codes": ["111"]},
{"qualification_code": 220,"condition_codes": ["111"]}
]
},
{
"buyer_quota_id": "b11112",
"required_count": 300,
"criteria": [
{"qualification_code": 230,"range_sets": [{"from": 4,"to": 9,"units": 311}]},
{"qualification_code": 218,"condition_codes": ["111"]},
{"qualification_code": 220,"condition_codes": ["111"]}
]
},
{
"buyer_quota_id": "b11113",
"required_count": 500,
"criteria": [
{"qualification_code": 230,"range_sets": [{"from": 4,"to": 9,"units": 311}]},
{"qualification_code": 218,"condition_codes": ["111"]},
{"qualification_code": 220,"condition_codes": ["112"]}
]
}
]
}
// 7. 400 with kids, 600 without kids; of the 400 with kids, 300 boys age 4-6 100 boys age 7-9
{
"qualifications": [
{
"qualification_code": 218,
"condition_codes": ["111", "112"]
},
],
"quotas": [
{
"buyer_quota_id": "b11111",
"required_count": 400,
"criteria": [
{"qualification_code": 218,"condition_codes": ["111"]} //Have children
]
},
{
"buyer_quota_id": "b11112",
"required_count": 600,
"criteria": [
{"qualification_code": 218,"condition_codes": ["112"]} //Don't have children
]
},
{
"buyer_quota_id": "b11113",
"required_count": 300,
"criteria": [
{"qualification_code": 218,"condition_codes": ["111"]},
{"qualification_code": 220,"condition_codes": ["111"]}, //Boys
{"qualification_code": 230, "range_sets": [{"from": 4,"to": 6,"units": 111}] } // age range 4-6
]
},
{
"buyer_quota_id": "b11114",
"required_count": 100,
"criteria": [
{"qualification_code": 218,"condition_codes": ["111"]},
{"qualification_code": 220,"condition_codes": ["111"]}, //Boys
{"qualification_code": 230, "range_sets": [{"from": 7,"to": 9,"units": 111}] } // age range 7-9
]
}
]
}