Skip to end of metadata
Go to start of metadata

Profile Summary Service

The Profile Summary service is a read-only service. Given a line item ID and a list of profile target types, this service returns the IDs of campaigns under the line item with profiles targeting the given target types. Currently, this service only supports line items with no more than 250 campaigns.

On This Page

REST API

For a specific line item, view the IDs of campaigns that are targeting specific target types: 
GET https://api.appnexus.com/profile-summary?entity_type=line_item&entity_id=12345&summary_fields=postal_code,city,region

In the example above, the entity_id is the ID of the line item for which you want to view this summary and summary_ fields is the types of targeting that you want to include in the summary. Possible values for summary_fieldspostal codecityregiondmacountrydomain, domain_list, segment, age, gender, daypart. Note that you can combine up to 10 of these values in a comma-separated list. 

JSON Fields

Field

Type

Description

postal_code_targets_exist

object

An object containing an array of the campaign IDs for any campaigns that have postal code targeting.

city_targets_existobject

An object containing an array of the campaign IDs for any campaigns that have city targeting.

region_targets_existobject

An object containing an array of the campaign IDs for any campaigns that have region targeting.

dma_targets_existobject

An object containing an array of the campaign IDs for any campaigns that have designated market area targeting.

country_targets_existobject

An object containing an array of the campaign IDs for any campaigns that have country targeting.

domain_targets_existobject

An object containing an array of the campaign IDs for any campaigns that have domain targeting.

domain_list_targets_existobject

An object containing an array of the campaign IDs for any campaigns that have domain list targeting.

segment_targets_existobject

An object containing an array of the campaign IDs for any campaigns that have segment targeting.

age_targets_existobject

An object containing an array of the campaign IDs for any campaigns that have age targeting.

daypart_targets_existobjectAn object containing an array of the campaign IDs for any campaigns that have daypart targeting.
operating_system_family_targets_existobjectAn object containing an array of the campaign IDs for any campaigns that have operating system family targeting.
operating_system_targets_existobjectAn object containing an array of the campaign IDs for any campaigns that have operating system targeting.
browser_targeting_existsobjectAn object containing an array of the campaign IDs for any campaigns that have browser targeting.
device_model_targets_existobjectAn object containing an array of the campaign IDs for any campaigns that have device model targeting.
carrier_targets_existobjectAn object containing an array of the campaign IDs for any campaigns that have carrier targeting.
device_type_targets_existobjectAn object containing an array of the campaign IDs for any campaigns that have device type targeting.
supply_type_targets_existobjectAn object containing an array of the campaign IDs for any campaigns that have supply type targeting.

Example

 View a targeting summary for campaigns with postal code, city, region, dma, or country targeting
  • No labels