Skip to content

BYOA

Custom Brain

Custom Brain allows the client to use the BYOA API to upload a set of logistic coefficients corresponding to any of the variables currently in use by the MediaMath Brain. These coefficients will then be used by participating strategies to calculate the predicted response rate for each impression. The bidder will calculate bid price by multipling the predicted response rate by the strategy's goal value. Goal values can be modified using the MediaMath Platform campaign management API.

It is best for you to contact us early in your process by emailing developers@mediamath.com, as it may take about 48 hours before you are granted API access to begin work on your model.

BYOM

Download OpenAPI description
byoa-api.json
byoa-api.yaml
Overview
URL
http://devblog.mediamath.com
BYOA API Support
byoa@mediamath.com
License
Apache 2.0
Languages
Servers
https://api.byoa.mediamath.com

Campaign Settings

BYOA (Bring Your Own Algorithm) allows advertisers to apply their own bidding algorithms within MediaMath. The participating campaigns and strategies are configured with the BYOA Campaign Settings

Operations

Custom Bid Router

Custom Bid Router further extends the BYOA architecture allowing advertisers to apply their own bidding algorithms in their own ecosystem. The MediaMath system will invoke an external call to the client with the bid request and await a response that MediaMath can use in our internal auction. Forwarded bid requests adhere to OpenRTB v2.4 format and may be enriched with certain information such as segment membership and pixel recency.

Operations

Configuration Summary

Request

Get a summary of the service consisting of the defined executors, environments, and endpoints. This summary will help you identify that you have correctly configured all your endpoints for all the regions

Security
oauth2
Path
org_idinteger(int32)required

Your organization ID

Headers
string

_

Bodyapplication/json

_

any
curl -i -X GET \
  'https://api.byoa.mediamath.com/custombidrouter/{org_id}/configuration' \
  -H ': string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

VAR_NAME (under executors) can be any executor name

Bodyapplication/json
dataobject
metaobject
Response
application/json
{
  "data": {
    "ACME Org Production Executor": { … }
  },
  "meta": {
    "status": "success"
  }
}

Executor Details

Request

The details of the Custom Bid Router executor and all attached Endpoints

Security
oauth2
Path
executor_idinteger(int32)required

The Executor ID identifies an Executor which provide a logical grouping for your Bid Valuation endpoints which are then applied to specific campaigns

org_idinteger(int32)required

Your organization ID

executor_idinteger(int32)required

The Executor ID identifies an Executor which provide a logical grouping for your Bid Valuation endpoints which are then applied to specific campaigns

org_idinteger(int32)required

Your organization ID

curl -i -X GET \
  'https://api.byoa.mediamath.com/custombidrouter/{org_id}/executors/{executor_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

VAR_NAME is variable, the name of an executor

Bodyapplication/json
dataobject
metaobject
Response
application/json
{
  "data": {
    "ACME Org Production Executor": { … }
  },
  "meta": {
    "status": "success"
  }
}

Executor Update

Request

The sample rate defines the percentage of the bid opportunities that are forwarded to your endpoints. The sample rate can be adjusted by the client collectively for all endpoints of an executor. This feature is useful to manage and budget system utilization.

Security
oauth2
Path
executor_idinteger(int32)required

The Executor ID identifies an Executor which provide a logical grouping for your Bid Valuation endpoints which are then applied to specific campaigns

org_idinteger(int32)required

Your organization ID

executor_idinteger(int32)required

_

org_idinteger(int32)required

_

Bodyapplication/json

_

sample_rateinteger
curl -i -X PATCH \
  'https://api.byoa.mediamath.com/custombidrouter/{org_id}/executors/{executor_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sample_rate": 0
  }'

Responses

VAR_NAME is variable, the name of an executor

Bodyapplication/json
dataobject
metaobject
Response
application/json
{
  "data": {
    "ACME Org Production Executor": { … }
  },
  "meta": {
    "status": "success"
  }
}

Custom Brain

In Customized Brain, the client uses the BYOA API to upload a set of logistic coefficients corresponding to any of the variables currently in use by the MediaMath Brain. These coefficients will then be used by participating strategies to calculate the predicted response rate for each impression. The bidder will calculate bid price by multiplying the predicted response rate by the strategy's goal value. Goal values can be modified using the T1 campaign management API.

Operations