|
|
TargetingConverterService
TargetingConverterService provides operations for converting a generic targeting object to a strongly typed targeting object and vice versa.
Generic targeting is targeting by means of TargetingAttribute. The TargetingAttributeDescriptor object is an example of a generic targeting object as it can refer to any typed targeting object depending on its ID and TargetingType. This object is used with the TargetingAttribute object.
Typed targeting is targeting by means of TargetingProfile. AgeRange, DayPartingTargeting, Gender, GeoLocation, UnderAgeFilter are examples of strongly typed targeting objects. These objects are used with TargetingProfile object.
The converter service can interpret/decipher the ID in a generic targeting object (such as TargetingAttributeDescriptor) to meaningful typed objects (such as AgeRange, Gender) and vice versa.
Operations
- getAgeRangeByTargetingAttributeDescriptor
- getDayPartingTargetingByTargetingAttributeDescriptor
- getGenderByTargetingAttributeDescriptor
- getGeoLocationByTargetingAttributeDescriptor
- getNetworkByTargetingAttributeDescriptor (added in Version 5.2.0)
- getTargetingAttributeDescriptorByAgeRange
- getTargetingAttributeDescriptorByDayPartingTargeting
- getTargetingAttributeDescriptorByGender
- getTargetingAttributeDescriptorByGeoLocation
- getTargetingAttributeDescriptorByNetwork (added in Version 5.2.0)
- getTargetingAttributeDescriptorByUnderAgeFilter
- getUnderAgeFilterByTargetingAttributeDescriptor
getAgeRangeByTargetingAttributeDescriptor
Retrieve the age range value for the specified targeting type and ID.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| targetingAttributeDescriptor | TargetingAttributeDescriptor | The targeting type details. |
Response
AgeRange - The age range value for the specified targeting type and ID.
getDayPartingTargetingByTargetingAttributeDescriptor
Retrieve the day parting setting for the specified targeting type and ID.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| targetingAttributeDescriptor | TargetingAttributeDescriptor | The targeting type details. |
Response
DayPartingTargeting - The day parting setting for the specified targeting type and ID.
getGenderByTargetingAttributeDescriptor
Retrieve the gender value for the specified targeting type and ID.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| targetingAttributeDescriptor | TargetingAttributeDescriptor | The targeting type details. |
Response
Gender - The gender value for the specified targeting type and ID.
getGeoLocationByTargetingAttributeDescriptor
Retrieve the geographical location details for the specified targeting type and ID.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| targetingAttributeDescriptor | TargetingAttributeDescriptor | The targeting type details. |
Response
GeoLocation - The geographical location details for the specified targeting type and ID.
getNetworkByTargetingAttributeDescriptor
Retrieve the network details for the specified targeting type and ID.
Added in: Version 5.2.0
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| targetingAttributeDescriptor | TargetingAttributeDescriptor | The targeting type details. |
Response
Network - The network details for the specified targeting type and ID.
getTargetingAttributeDescriptorByAgeRange
Retrieve the targeting type and ID for the specified age range.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| ageRange | AgeRange | The age range. Use the getAgeRanges operation in TargetingDictionaryService to retrieve the supported age ranges. |
Response
TargetingAttributeDescriptor - The targeting type and ID of the specified AgeRange.
getTargetingAttributeDescriptorByDayPartingTargeting
Retrieve the targeting type and ID for the specified day parting. DayParting's targetingAttributeID is a string containing XML. Note that premium values in DayPartingTarget object will be ignored as a result of conversion.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| dayPartingTargeting | DayPartingTargeting | The day parting. |
Response
TargetingAttributeDescriptor - The targeting type and ID of the specified day parting.
getTargetingAttributeDescriptorByGender
Retrieve the targeting type and ID for the specified gender.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| gender | Gender | The gender. |
Response
TargetingAttributeDescriptor - The targeting type and ID of the specified gender.
getTargetingAttributeDescriptorByGeoLocation
Retrieve the targeting type and ID for the specified geographical location.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| geoLocation | GeoLocation | The geographical location. Use the getGeoLocations operation in GeographicalDictionaryService to retrieve the supported geographical locations. |
Response
TargetingAttributeDescriptor - The targeting type and ID of the specified geographical location.
getTargetingAttributeDescriptorByNetwork
Retrieve the targeting type and ID for the specified network.
Added in: Version 5.2.0
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| network | Network | The network. Use the getNetworksByTacticType operation in TargetingDictionaryService to retrieve the supported networks. |
Response
TargetingAttributeDescriptor - The targeting type and ID of the specified geographical location.
getTargetingAttributeDescriptorByUnderAgeFilter
Retrieve the targeting type and ID for the specified under-age filter settings. The only valid input to this API is UnderAgeFilter.Enable. There is no TargetingAttributeDescriptor for UnderAgeFilter.Disable. See TargetingService Overview for more details.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| underAgeFilter | UnderAgeFilter | The under-age filter. |
Response
TargetingAttributeDescriptor - The targeting type and ID of the specified under-age filter.
getUnderAgeFilterByTargetingAttributeDescriptor
Retrieve the under-age filter setting for the specified targeting type and ID.
Capability required: CampaignRead
License command group: Marketing
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| targetingAttributeDescriptor | TargetingAttributeDescriptor | The targeting type details. |
Response
UnderAgeFilter - The under-age filter setting for the specified targeting type and ID.