Campaigns API (xx.xx.xx)

MediaMath Platform API

Download OpenAPI description
Languages
Servers
Mock server
https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/

Organizations

Organizations

Operations

Agencies

Agencies

Operations

Advertisers

Advertisers

Operations

Campaigns

Campaigns

Operations

Strategies

Strategies

Operations

Targeting

Targeting

Operations

Vendor Contracts

Vendor Contracts

Operations

Strategy Templates

Strategy Templates

Operations

Atomic Creatives

Atomic Creatives

Operations

Concepts

Concepts

Operations

Creatives

Creatives

Operations

Pixel Bundles

Pixel Bundles

Operations

Campaign Plans

Campaign Plans

Operations

Strategy Plans

Strategy Plans

Operations

Bulk Update

Bulk Update

Operations

Marketplaces

Marketplaces

Operations

Users

Users

Operations

Enterprise Controls

Enterprise Controls

Operations

General

General

Operations

Currency Rates

Currency Rates

Operations

Site Lists

Site Lists

Operations

Timezones

Timezones

Operations

Strategy Groups

Strategy Groups

Operations

Strategy Day Parts

Strategy Day Parts

Operations

Strategy Deals

Strategy Deals

Operations

Strategy IP Addresses

Strategy IP Addresses

Operations

Strategy Concepts

Strategy Concepts

Operations

Targeting Segments

Targeting Segments

Operations

Strategy Target Values

Strategy Target Values

Operations

List Organization Settings

Operations

Update Organization Settings

Operations

New Strategy Plans

Operations

Post ephemeral new strategy plan to run a forecast

Request

Post a strategy plan object to run forcast without saving the strategy plan

Bodyapplication/jsonrequired
advertiser_idinteger
campaign_plan_idinteger
channelsArray of strings
namestring<= 128 characters
feature_compatibilitystring<= 1024 characters
device_graph_onlyboolean
idinteger
versioninteger
campaign_idinteger
zone_namestring
Example: "America/New_York"
campaign_service_typestring
typestring
durationobject(strategy_plan_duration)
budgetobject(strategy_plan_budget)
goalsobject(strategy_plan_goals)
frequencyobject(strategy_plan_frequency)
inventoryobject(strategy_plan_inventory)
targetingobject(strategy_plan_targeting)
creativesobject(strategy_plan_creatives)
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_strategy_plans/forecast \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "advertiser_id": 0,
    "campaign_plan_id": 0,
    "channels": [
      "string"
    ],
    "name": "string",
    "feature_compatibility": "string",
    "device_graph_only": true,
    "id": 0,
    "version": 0,
    "campaign_id": 0,
    "zone_name": "America/New_York",
    "campaign_service_type": "string",
    "type": "string",
    "duration": {
      "use_campaign_start": true,
      "use_campaign_end": true,
      "start_date": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24T14:15:22Z"
    },
    "budget": {
      "budget": 0.1,
      "currency_code": "string"
    },
    "goals": {
      "goal_type": "spend",
      "goal_value": 999999999.9999,
      "min_bid": 9999999.99,
      "max_bid": 0.01,
      "roi_target": 999999999.99,
      "bid_min_devices": 0,
      "bid_aggressiveness": 100,
      "bid_price_is_media_only": true,
      "max_bid_wm": 9999999.99,
      "use_bid_shading": true
    },
    "frequency": {
      "frequency_type": "even",
      "frequency_interval": "hour",
      "frequency_amount": 0,
      "frequency_optimization": true
    },
    "inventory": {
      "run_on_all_pmp": true,
      "run_on_all_exchanges": true,
      "site_restriction_transparent_urls": true,
      "domain_restrictions": {
        "include": [
          {
            "domain": "www.mediamath.com",
            "target_type": "DOMAIN"
          }
        ],
        "exclude": [
          {
            "domain": "www.mediamath.com",
            "target_type": "DOMAIN"
          }
        ]
      },
      "site_lists": [
        {
          "site_list_id": 0,
          "assigned": true
        }
      ],
      "deals": [
        {
          "deal_id": 0
        }
      ],
      "deal_groups": [
        {
          "deal_group_id": 0
        }
      ],
      "supply_sources": [
        {
          "supply_source_id": 0
        }
      ]
    },
    "targeting": {
      "fold_position": [
        "ABOVE"
      ],
      "audience": {
        "include": [
          {
            "operator": "AND",
            "segments": [
              {
                "audience_segment_id": 0,
                "user_cpm": 0.1
              }
            ]
          }
        ],
        "exclude": {
          "operator": "AND",
          "segments": [
            {
              "audience_segment_id": 0,
              "user_cpm": 0.1
            }
          ]
        }
      },
      "contextual": {
        "include": [
          {
            "code": "string",
            "operator": "AND",
            "segments": [
              {
                "targeting_segment_id": 0,
                "user_cpm": 0.1
              }
            ]
          }
        ],
        "exclude": {
          "code": "string",
          "operator": "AND",
          "segments": [
            {
              "targeting_segment_id": 0,
              "user_cpm": 0.1
            }
          ]
        }
      },
      "postal_codes": {
        "restriction": "INCLUDE",
        "codes": [
          "us-14392",
          "us-24981",
          "us-25632",
          "us-16191",
          "us-48574",
          "us14392",
          "us24981",
          "us25632",
          "us16191",
          "us48574",
          "14392",
          "24981",
          "25632",
          "16191",
          "48574"
        ]
      },
      "geofence": {
        "include": {
          "operator": "AND",
          "segments": [
            {
              "geofence_segment_id": 0
            }
          ]
        },
        "exclude": {
          "operator": "AND",
          "segments": [
            {
              "geofence_segment_id": 0
            }
          ]
        }
      },
      "my_data": {
        "include": {
          "operator": "AND",
          "pixels": [
            {
              "pixel_id": 0
            }
          ]
        },
        "exclude": {
          "operator": "AND",
          "pixels": [
            {
              "pixel_id": 0
            }
          ]
        }
      },
      "location": {
        "include": [
          {
            "operator": "string",
            "target_value_id": 0,
            "code": "DMAX"
          }
        ],
        "exclude": [
          {
            "operator": "string",
            "target_value_id": 0,
            "code": "DMAX"
          }
        ]
      },
      "technology": {
        "include": [
          {
            "operator": "string",
            "code": "BSER",
            "target_value_id": 0
          }
        ],
        "exclude": [
          {
            "operator": "string",
            "code": "BSER",
            "target_value_id": 0
          }
        ]
      },
      "ip_addresses": {
        "restriction": "INCLUDE",
        "codes": [
          "string"
        ]
      },
      "day_parts": [
        {
          "user_time": true,
          "start_hour": 1,
          "end_hour": 5,
          "days": [
            "M",
            "T",
            "W",
            "S",
            "U"
          ]
        }
      ],
      "recency": [
        {
          "pixel_id": 0,
          "from_hour": 0,
          "to_hour": 0
        }
      ],
      "language_codes": [
        {
          "code": "string",
          "name": "string"
        }
      ]
    },
    "creatives": {
      "ad_expandable": true,
      "ad_formats": [
        "string"
      ],
      "ad_sizes": [
        "string"
      ]
    }
  }'

Responses

new strategy plan response

Bodyapplication/json
dataobject(new_strategy_plan_full)

New Strategy Plan

metaobject
Response
application/json
{ "data": { "campaign_start_date": "2019-08-24T14:15:22Z", "campaign_end_date": "2019-08-24T14:15:22Z", "campaign_zone_name": "string", "name": "string", "feature_compatibility": "string", "device_graph_only": true, "id": 0, "version": 0, "campaign_id": 0, "zone_name": "America/New_York", "campaign_service_type": "string", "type": "string", "duration": {}, "budget": {}, "goals": {}, "frequency": {}, "inventory": {}, "targeting": {}, "creatives": {} }, "meta": { "status": "success" } }

Run and update forecast for given strategy_plan_id

Request

Run and update forecast for given strategy_plan_id

Path
strategy_plan_idintegerrequired

Numeric ID of the strategy_plan object to run a forecast

curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_strategy_plans/{strategy_plan_id}/forecast' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

new strategy plan response

Bodyapplication/json
dataobject(new_strategy_plan_full)

New Strategy Plan

metaobject
Response
application/json
{ "data": { "campaign_start_date": "2019-08-24T14:15:22Z", "campaign_end_date": "2019-08-24T14:15:22Z", "campaign_zone_name": "string", "name": "string", "feature_compatibility": "string", "device_graph_only": true, "id": 0, "version": 0, "campaign_id": 0, "zone_name": "America/New_York", "campaign_service_type": "string", "type": "string", "duration": {}, "budget": {}, "goals": {}, "frequency": {}, "inventory": {}, "targeting": {}, "creatives": {} }, "meta": { "status": "success" } }

Get Strategy Plan

Request

Get a strategy plan

Path
strategy_plan_idintegerrequired

Numeric ID of the strategy_plan object to get

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_strategy_plans/{strategy_plan_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

new strategy plan response

Bodyapplication/json
dataobject(new_strategy_plan_full)

New Strategy Plan

metaobject
Response
application/json
{ "data": { "campaign_start_date": "2019-08-24T14:15:22Z", "campaign_end_date": "2019-08-24T14:15:22Z", "campaign_zone_name": "string", "name": "string", "feature_compatibility": "string", "device_graph_only": true, "id": 0, "version": 0, "campaign_id": 0, "zone_name": "America/New_York", "campaign_service_type": "string", "type": "string", "duration": {}, "budget": {}, "goals": {}, "frequency": {}, "inventory": {}, "targeting": {}, "creatives": {} }, "meta": { "status": "success" } }

Update a strategy plan

Request

Update a strategy plan

Path
strategy_plan_idintegerrequired

Numeric ID of the strategy_plan object to update

Bodyapplication/jsonrequired
versioninteger
campaign_plan_idinteger
channelsArray of strings
namestring<= 128 characters
feature_compatibilitystring<= 1024 characters
device_graph_onlyboolean
idinteger