Use these requests to retrieve information about Target Groups.
Interest Target Group
This request retrieves a list of Interest Target Groups and includes the unique ID of any groups returned.
Data Element | Type | Conditional | Description |
---|---|---|---|
brand_ID | Int | True | The unique ID of your account |
is_deleted | Bit | True | Whether the Target Group has been deleted |
target_group_id | Int | True | The unique ID of the Target Group |
target_group_name | String | True | The name of the Target Group (550-character max.) |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Test Brand</Brand> <User></User> <Password></Password> (only required if not using authentication) <Grids> <Grid type="interest_target_group"> <ReturnFields> <DataElement>is_deleted</DataElement> <DataElement>target_group_id</DataElement> <DataElement>target_group_name</DataElement> </ReturnFields> </Grid> </Grids> </GridRequest>
Response
<?xml version="1.0" encoding="utf-16"?> <GridResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Test Brand</Brand> <User></User> <Grids> <Grid type="interest_target_group"> <Record row="1"> <Fields> <Field element="is_deleted">0</Field> <Field element="target_group_id">208907</Field> <Field element="target_group_name">Opt-Ins</Field> </Fields> </Record> <Record row="2"> <Fields> <Field element="is_deleted">0</Field> <Field element="target_group_id">208958</Field> <Field element="target_group_name">Test Interest 57934</Field> </Fields> </Record> … <Record row="45"> <Fields> <Field element="is_deleted">0</Field> <Field element="target_group_id">208959</Field> <Field element="target_group_name">zip1</Field> </Fields> </Record> </Grid> </Grids> </GridResponse>
Target Group Counts
This request retrieves a count of how many Target Groups there are of the specified Target Group type (type_name).
Data Element | Type | Conditional | Description |
---|---|---|---|
name | string | True | The name of the Target Group (550-character max.) |
id | int | True | The unique ID of the Target Group |
description | string | True | A description of the Target Group (1000-character max.) |
target_group_count | int | True | The number of Target Groups of the specified type |
count_date | datetime | True | The date on which the count was retrieved |
target_group_count_error | bit | True | Indicates whether there was an error during the last count |
last_used_date | datetime | True | The date on which the Target Group was last used |
type_name | string | True | The type (e.g., Action-based, Demographic) of Target Group (100-character max.) |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Password></Password> <Brand id="9999">Test Brand</Brand> <User></User> <Grids> <Grid type=”target_group_counts"> <Conditions> <Condition> <Single> <DataElement>id</DataElement> <DataValue>66699</DataValue> <Comparator>EQ</Comparator> </Single> </Condition> </Conditions> <ReturnFields> <DataElement>name</DataElement> <DataElement>id</DataElement> <DataElement>description</DataElement> <DataElement>target_group_count</DataElement> <DataElement>type_name</DataElement> <DataElement>count_date</DataElement> <DataElement>target_group_count_error</DataElement> <DataElement>last_used_date</DataElement> </ReturnFields> </Grid> </Grids> </GridRequest>
Response
<?xml version="1.0" encoding="utf-8"?> <GridResponse xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Test Brand</Brand> <User></User> <Grids> <Grid type="target_group_counts"> <Record row="1"> <Fields> <Field element="name">survey test</Field> <Field element="id">66699</Field> <Field element="description">Answered question Name on Survey : ! survey with additions</Field> <Field element="target_group_count">0</Field> <Field element="type_name">Action-Based</Field> <Field element="count_date" /> <Field element="target_group_count_error">0</Field> <Field element="last_used_date" /> </Fields> </Record> </Grid> </Grids> </GridResponse>