Market Plan Locks
- Michael Riccio (Unlicensed)
Created by Michael Riccio (Unlicensed)
Jan 26, 2022
7 min read
Loading data...
When creating a plan sometimes a user will want to lock a certain parameter like number of a media type or TRPs.
This can be accomplished in the https://api.geopath.org/v2.1/inventory/plans endpoint and using the lock object to set what you want locked. The lock object can be provided within different objects depending on the lock requirements. A Goal object is always required when using the endpoint, but can be set at 0 for a measure.
Call:
This call locks the total number of Bulletin inventory in a specific market with a TRP goal of 100 over 1 week. Note that locking the number of inventory might make the request fail to reach a set goal.
{
"target_geography_list": [
"DMA623"
],
"target_segment": 2032,
"media_type_group_list": [
{
"measures_range_list": [
{
"type": "index_comp_target",
"min": 50,
"max": 1000
},
{
"type": "imp_target",
"min": 0
}
],
"media_type_list": [
"Bulletin"
],
"lock": {
"measure": "spots",
"value": 25
}
}
],
"allocation_method": "equal",
"goal": {
"period_days": 7,
"measure": "trp",
"value": 100
}
}
Response:
The response shows that the number of inventory was locked at 25 spots and failed to meet the goal of 100 TRPs.
{
"allocation_list": [
{
"measures": {
"measures_type": "plan_measures",
"period_days": 7,
"base_segment": "2032",
"target_segment": "2032",
"target_geo": "DMA623",
"market": "DMA623",
"index_comp_target": 100.0,
"pct_comp_pop_target_inmkt": 1.0,
"pct_comp_imp_target": 1.0,
"pct_comp_imp_target_inmkt": 1.0,
"freq_avg": 2.446190288,
"imp_target_inmkt": 7043622.180732,
"imp_target": 8212218.20723589,
"imp_inmkt": 7043622.180732,
"imp": 8212218.20723589,
"pct_imp_inmkt": 0.8577003196,
"pct_imp_target_inmkt": 0.8577003196,
"pop_inmkt": 8191034,
"pop_target_inmkt": 8191034,
"reach_pct": 35.153379787,
"reach_net": 2879425,
"trp": 85.991856226,
"eff_freq_min": 3,
"eff_freq_avg": 5.345805722,
"eff_reach_net": 1317598,
"eff_reach_pct": 16.085855097,
"spots": 25
},
"media_type_group": {
"classification_type_list": null,
"construction_type_list": null,
"media_type_list": [
"Bulletin"
],
"frame_media_name_list": null,
"operator_name_list": null,
"include_spot_list": null,
"exclude_spot_list": null,
"digital": null,
"rotating": null,
"measures_range_list": [
{
"type": "index_comp_target",
"min": 50.0,
"max": 1000.0
},
{
"type": "imp_target",
"min": 0.0,
"max": null
}
],
"lock": {
"measure": "spots",
"value": 25.0
}
}
}
],
"summaries": {
"by_media_type_group": [
{
"measures": {
"measures_type": "plan_measures",
"period_days": 7,
"base_segment": "2032",
"target_segment": "2032",
"target_geo": "DMA623",
"market": "DMA623",
"index_comp_target": 100.0,
"pct_comp_pop_target_inmkt": 1.0,
"pct_comp_imp_target": 1.0,
"pct_comp_imp_target_inmkt": 1.0,
"freq_avg": 2.446190288,
"imp_target_inmkt": 7043622.180732,
"imp_target": 8212218.20723589,
"imp_inmkt": 7043622.180732,
"imp": 8212218.20723589,
"pct_imp_inmkt": 0.8577003196,
"pct_imp_target_inmkt": 0.8577003196,
"pop_inmkt": 8191034,
"pop_target_inmkt": 8191034,
"reach_pct": 35.153379787,
"reach_net": 2879425,
"trp": 85.991856226,
"eff_freq_min": 3,
"eff_freq_avg": 5.345805722,
"eff_reach_net": 1317598,
"eff_reach_pct": 16.085855097,
"spots": 25
},
"media_type_group": {
"classification_type_list": null,
"construction_type_list": null,
"media_type_list": [
"Bulletin"
],
"frame_media_name_list": null,
"operator_name_list": null,
"include_spot_list": null,
"exclude_spot_list": null,
"digital": null,
"rotating": null,
"measures_range_list": [
{
"type": "index_comp_target",
"min": 50.0,
"max": 1000.0
},
{
"type": "imp_target",
"min": 0.0,
"max": null
}
],
"lock": {
"measure": "spots",
"value": 25.0
}
}
}
],
"by_operator": [
{
"measures": {
"measures_type": "plan_measures",
"period_days": 7,
"base_segment": "2032",
"target_segment": "2032",
"target_geo": "DMA623",
"market": "DMA623",
"index_comp_target": 100.0,
"pct_comp_pop_target_inmkt": 1.0,
"pct_comp_imp_target": 1.0,
"pct_comp_imp_target_inmkt": 1.0,
"freq_avg": 2.446190288,
"imp_target_inmkt": 7043622.180732,
"imp_target": 8212218.20723589,
"imp_inmkt": 7043622.180732,
"imp": 8212218.20723589,
"pct_imp_inmkt": 0.8577003196,
"pct_imp_target_inmkt": 0.8577003196,
"pop_inmkt": 8191034,
"pop_target_inmkt": 8191034,
"reach_pct": 35.153379787,
"reach_net": 2879425,
"trp": 85.991856226,
"eff_freq_min": 3,
"eff_freq_avg": 5.345805722,
"eff_reach_net": 1317598,
"eff_reach_pct": 16.085855097,
"spots": 25
},
"media_type_group": {
"classification_type_list": null,
"construction_type_list": null,
"media_type_list": [
"Bulletin"
],
"frame_media_name_list": null,
"operator_name_list": null,
"include_spot_list": null,
"exclude_spot_list": null,
"digital": null,
"rotating": null,
"measures_range_list": [
{
"type": "index_comp_target",
"min": 50.0,
"max": 1000.0
},
{
"type": "imp_target",
"min": 0.0,
"max": null
}
],
"lock": {
"measure": "spots",
"value": 25.0
}
}
}
],
"total": {
"measures": {
"measures_type": "plan_measures",
"period_days": 7,
"base_segment": "2032",
"target_segment": "2032",
"target_geo": "DMA623",
"market": "DMA623",
"index_comp_target": 100.0,
"pct_comp_pop_target_inmkt": 1.0,
"pct_comp_imp_target": 1.0,
"pct_comp_imp_target_inmkt": 1.0,
"freq_avg": 2.446190288,
"imp_target_inmkt": 7043622.180732,
"imp_target": 8212218.20723589,
"imp_inmkt": 7043622.180732,
"imp": 8212218.20723589,
"pct_imp_inmkt": 0.8577003196,
"pct_imp_target_inmkt": 0.8577003196,
"pop_inmkt": 8191034,
"pop_target_inmkt": 8191034,
"reach_pct": 35.153379787,
"reach_net": 2879425,
"trp": 85.991856226,
"eff_freq_min": 3,
"eff_freq_avg": 5.345805722,
"eff_reach_net": 1317598,
"eff_reach_pct": 16.085855097,
"spots": 25
},
"media_type_group": {
"classification_type_list": null,
"construction_type_list": null,
"media_type_list": [
"Bulletin"
],
"frame_media_name_list": null,
"operator_name_list": null,
"include_spot_list": null,
"exclude_spot_list": null,
"digital": null,
"rotating": null,
"measures_range_list": [
{
"type": "index_comp_target",
"min": 50.0,
"max": 1000.0
},
{
"type": "imp_target",
"min": 0.0,
"max": null
}
],
"lock": {
"measure": "spots",
"value": 25.0
}
}
}
}
}
Call:
This call is locking the amount of inventory for a specific operators bulletins, while maintaining no lock on specific operators posters. Note that there are two lock objects set within the objects in the media_type_group_list.
{
"target_geography_list": [
"DMA501"
],
"target_segment": 2032,
"media_type_group_list": [
{
"operator_name_list": [
"Lamar"
],
"frame_media_name_list": [],
"measures_range_list": [
{
"type": "index_comp_target",
"min": 50,
"max": 1000
},
{
"type": "imp_target",
"min": 0
}
],
"media_type_list": [
"Bulletin"
],
"lock": {
"measure": "spots",
"value": 15
}
},
{
"operator_name_list": [
"Lamar"
],
"frame_media_name_list": [],
"measures_range_list": [
{
"type": "index_comp_target",
"min": 50,
"max": 1000
},
{
"type": "imp_target",
"min": 0
}
],
"media_type_list": [
"Poster"
]
},
{
"operator_name_list": [
"OUTFRONT"
],
"frame_media_name_list": [],
"measures_range_list": [
{
"type": "index_comp_target",
"min": 50,
"max": 1000
},
{
"type": "imp_target",
"min": 0
}
],
"media_type_list": [
"Bulletin"
],
"lock": {
"measure": "spots",
"value": 15
}
},
{
"operator_name_list": [
"OUTFRONT"
],
"frame_media_name_list": [],
"measures_range_list": [
{
"type": "index_comp_target",
"min": 50,
"max": 1000
},
{
"type": "imp_target",
"min": 0
}
],
"media_type_list": [
"Poster"
]
}
],
"allocation_method": "equal",
"goal": {
"period_days": 14,
"measure": "trp",
"value": 150
}
}
Response:
The response shows the plan results in different as a total and by different aggregations. Note that locking the bulletins at 15 per operator failed to meet the TRP goal.
Â