Enhancements in profile and creative services

2024-04-29

Enhancements in profile service

You can define targets at the Smart line item level using the Profile Service, where a profile is a set of targeting parameters, such as gender, age, geography, and frequency. In order to the Smart line item (and Smart insertion order) capabilities to function, specific parameter-based profiles are appended to the line items generated by Smart Line Item Service. Only enhanced_performance line items should utilize profiles intended for Smart line items, which include the Profile ID, at the line-item level.

Note

The profile for Smart line item(s) can accommodates a subset of targeting parameters, which are listed in the JSON fields below. An error will occur if any targeting parameters not included in the JSON field are referenced.

The current Profile Service is unchanged in terms of endpoint and methods. The same can be used to view, edit, and create profiles.

Profile service JSON

Field	Type (Length)	Description
`age_targets`	array of strings	The list of age ranges to target for this profile. The `allow_unknown` field is available as a Boolean in order to account for ad calls where the age of the user is not available. For more details and examples, see age targets section. Only the following ranges are allowed: - `['low' => 18, 'high' => 24]`, -`['low' => 25, 'high' => 34]`, -`['low' => 35, 'high' => 49]`, -`['low' => 50, 'high' => 64]`, -`['low' => 65, 'high' => 100]`
`city_action`	enum	Action to be taken on the `city_targets` list. Possible values: - `include` - `exclude` Default: `exclude`
`city_target`	array of objects	The IDs of cities to be either included or excluded in a profile, as defined by the `city_action` field. You can use the City Service to retrieve a list of city IDs. For more details and format, see City Targets below. Required On: POST/PUT, when `city_action` is include.
`country_action`	enum	Action to be taken on the `country_targets` list. Possible values: - `include` - `exclude` Default: `exclude`
`country_targets`	array of objects	The country IDs to be either excluded or included in a profile, as defined by the `country_action` field. You can use the Country Service to retrieve a list of country IDs. For more details and format, see Country Targets. Required On: POST/PUT, when `country_action` is include.
`daypart_targets`	array of objects	The day parts during which to serve the campaign. For more details, see Daypart Targets. Note: If you do not set any daypart targets, the campaign will serve on all days of the week at all times.
`device_type_targets`	array of strings	The types of devices to either include in or exclude from your targeting, as defined by the `device_type_action` field. Possible values: - `phone` - `tablet` - `pc` For more details and format, see Device Type Targets
`device_type_action`	enum	Action to be taken on `device_type_targets`. `device_type` can only be defined using `device_type_action = include`, and can only target the device types mentioned above: Possible values: `include` or `exclude` Default: `exclude`
`gender_targets`	object	The gender targeting used for the profile. Possible values for gender are: - `m(male)` - `f(female)`. The `allow_unknown` field is available as a Boolean in order to account for ad calls where the gender of the user is not available. For more details, see Gender Targets.
`postal_code_targets`	object	The postal code IDs to target. IDs can be fetched using the Postal Code Service.
`postal_code_action_include`	array of objects	The Postal code list API will allow buyers to create a list of postal codes and reuse it across different objects for targeting. For more details, see Postal Code List Service
`region_action`	enum	Action to be taken on the `region_targets` list. Possible values: - `include` - `exclude` Default: `exclude`
`region_targets`	array of objects	The region/state IDs to be either included or excluded in a profile, as defined by the `region_action` field. You can use the Region Service to retrieve a list of region IDs. For more details and format, see Region Targets. Required On: POST/PUT, when `region_action` is include.
`segment_group_target`	array of objects	The segment groups to target. Whereas the `segment_targets` array allows you to define Boolean logic between individual segments, this array allows you to establish groups of segments, defining Boolean logic between the groups as well as between the segments within each group. You define the Boolean logic between groups with the `segment_boolean_operator` field outside of the array; you define the Boolean logic between segments in a group with the `boolean_operator` field within the group object. For more details, see Segment Group Targets. Segment group targets can only define 1 exclude group and 1 include group, and these two can only be OR’ed. Only 'In-Market' segments are allowed to be targeted. Note: Null segments cannot be added. You may not add null segments to this array using `POST` or `PUT`.

Enhancements in creative service

The Creative Service can be used to add creatives to our system. Only native ad types can be uploaded when associating a creative with a Smart line item. As with the profile service mentioned above, you must use the following parameters in JSON fields within the creative service when adding creatives.

JSON fields for creative service

Field	Type (Length)	Description
`native_attribute`	object	This is the new native object which contains elements required for native ads. For more details, see Native Attribute object below. Default: null Required On: Required for native ad with template 39461.

Native attribute

The native_attribute object contains the following fields.

Field	Type (Length)	Description
`link`	object	This is the non-null URL(s) associated with the native creative. For details, see Link object.
`data_assets`	object	The asset type for the native creative. For more details, see Data Asset Required values: - `title`: Title of the creative. -`description`: Description of the product or service being advertised. -`sponsored_by`: Brand name of the sponsor. It has a maximum length of 25 characters. Optional: - The bidder will utilize data asset types `custom_title_1`, `custom_title_2`, `custom_title_3`, and `custom_title_4` if provided. Each data asset type has a maximum length of 30 characters. If the length exceeds this limit, the creative cannot be associated with the Smart line item. - If there is a `custom_title_5` entry, this custom title will be ignored by the bidder, but the creative will still be allowed to be associated with the Smart line item. - The bidder will utilize data asset types `custom_body_1`, `custom_body_2`, `custom_body_3`, and `custom_body_4` if provided, but they are optional. Each data asset type has a maximum length of 90 characters. If the length exceeds this limit, the creative cannot be associated with the Smart line item. - If there is a `custom_body_5` entry, this custom title will be ignored by the bidder, but the creative will still be allowed to be associated with the Smart line item. - Other fields, such as `call_to_action` are allowed, but will be ignored by the bidder.
`image_assets`	array of objects	Attributes of each individual image. For more details, see Image Asset. Required values: - `main_image`: Primary image that will appear when the native creative is rendered. Note: - All image_assets of type `main_image`, `custom_image_1` - `custom_image_5` must have a minimum width of `703` pixles and minimum height of `368` pixels. - `icon_image’`,`‘custom_icon_1` - `custom_icon_5’` will be allowed but will be ignored by the bidder.

Share via