The audience sheet tag and decorator triggers the platform to place a quota in the Audience Quotas applet, allowing you to manage the quota with targets, percentages, and variance. The tag references a system or local spreadsheet known as an audience sheet.
setlist: GENLIST
1. Male
2. Female
1. What is your gender?
type: radio
optsfrom: GENLIST
GENDER. Gender quota
type: quotas
audience sheet: system.audience_us_gender
optsfrom: Q1
2. What is your age?
type: radio
create quota: AGEQ {desc: Age quota} {audience sheet: system.audience_us_age}
1. 18 to 24
2. 25 to 34
3. 35 to 44
4. 45 to 54
5. 55 to 64
6. 65 or more
Details
- The
audience sheettag should be placed on a quota variable created withtype: quotaand requires an audience sheet as the input. - The
audience sheetdecorator should be placed inline with thecreate quotatag. - The
audience typetag organizes quotas into groups within the Audience Quotas applet. The tag is used in conjunction with the 'audtype' parameter. This tag is optional. - If you use the
audience typetag, you must also use theaudtypeparameter in the entry URL.
Additional examples
'audience type' tag
Each audience type has one field for setting the target "N" and variance. All audience quotas without the audience type tag are grouped into a single table. When you apply the audience type tag, all audience quotas with the same type (e.g., REP) are grouped into another table.
You can create your own audience type by inputting any single-word value. There are also three system audience types available: 'REP' (Rep Sample), 'GS' (General Sample), and 'OS' (Over Sample).
setlist: GENLIST
1. Male
2. Female
1. What is your gender?
type: radio
optsfrom: GENLIST
GENDER. Gender group quota
type: quotas
audience sheet: system.audience_us_gender
audience type: REP
optsfrom: Q1
Note: At this time, the audience type tag is not supported for usage with click balance quotas. This could change in the future as we launch new features.
'audtype' parameter
Although the audience type tag is optional, you must use the audtype parameter in the entry URL if you use it. The parameter is needed for audience quotas to "punch" and increment their counts in the Audience Quotas applet. The audtype parameter should match the audience type value used in the quota variable.
If we use QGENDER above as an example, the entry URL should be http://surveydomain.com/pub/survey_ID/record_ID?audtype=REP.
For more information on formatting URL parameters, see Passing in parameters.
Audience sheet overview
Audience sheets can be found by going to Resources > Sheets in the left navigation menu. Then, type "audience" in the search box to see the system's available audience sheets.
Tip! If a system audience sheet doesn't meet your fielding needs, try creating your own audience sheet.
Audience sheets contain the following columns and information:
| Column | Required for | Description |
| id | Audience sheets |
The ID assigned to the option. Note, the option set used in the quota variable must match the option set in the sheet exactly. |
| text | Audience sheets | The text describing the option. |
| percent | Audience sheets | The percent allocated to the quota option (out of 100%). |
| sample_code | Auto-Sample applet |
The value stored in the database for the specific quota group. You must use a registered (expected) value so that the system can look up the quota criteria. |
| country |
Auto-Sample applet |
The country for which the quota group was created. Note, IntelliSurvey uses this reference for country codes. |
| difficult | -- |
This optional field is used with the Auto-Sample applet. The difficult column acts as a flag to the system, indicating that a specific quota group is more challenging to fill than others. If the cell has a value of '1', the software will request sample at a higher rate. If the cell is empty or has a value of '0', the software will request sample at a regular rate. |
Comments
0 comments
Please sign in to leave a comment.