Reserved Campaign

A reserved campaign represents a campaign that is reserved (or booked) for a specific advertiser. It is used to forecast how reserved campaigns will impact future inventory availability.

Fields

reservedCampaignId

• Type: integer
• Required: Yes
• Description: The reserved campaign ID.

accept

• Type: string
• Enum: application/json, text/plain
• Defaults to: application/json

Response

200

• Description: Normal response, containing a JSON object with the reserved campaign, if it exists.

404

• Description: The entity doesn't exist.

Example Response

{
  "id": 1234,
  "name": "Holiday Campaign 2025",
  "status": "reserved",
  "description": "Premium holiday campaign for Q4",
  "salesProbabilityWeight": 75,
  "advertiser": {
    "id": 10,
    "frequencyCap": {
      "type": 2,
      "duration": 1,
      "value": 5
    },
    "placementLimit": 0,
    "caps": {}
  },
  "capType": 1,
  "dailyCapAmount": 10000,
  "lifetimeCapAmount": 1000000,
  "frequencyCap": {
    "type": 2,
    "duration": 1,
    "value": 5
  },
  "flights": [
    {
      "id": 5678,
      "priorityId": 221170,
      "rate": {
        "rateType": 2,
        "price": 5.5
      },
      "keywordTargeting": "keyword1,keyword2\nkeyword3\n!keyword1,keyword2",
      "siteZoneTargeting": [
        null
      ],
      "geoTargeting": [
        {
          "CountryCode": "US",
          "Region": "NY",
          "MetroCode": "10001",
          "IsExclude": true
        }
      ],
      "distanceTargeting": [
        {
          "distance": 20,
          "latitude": 41.40338,
          "longitude": 2.17403
        }
      ],
      "customTargeting": "[\"order_confirmation\"] contains screen",
      "duplicateMode": 1,
      "ads": [
        {
          "id": 9012,
          "adType": 4649
        }
      ],
      "segmentTargeting": [
        {
          "segmentId": 12345,
          "isExclude": false
        }
      ],
      "startDate": "2025-01-01T00:00:00.000",
      "endDate": "2025-03-31T23:59:59.000",
      "timeZone": "America/New_York",
      "goalType": 1,
      "goalAmount": 1000000,
      "capType": 1,
      "dailyCapAmount": 10000,
      "lifetimeCapAmount": 1000000,
      "frequencyCap": {
        "type": 2,
        "duration": 1,
        "value": 5
      },
      "searchTerms": [
        {
          "term": "running shoes",
          "matchType": "broad",
          "isExclude": false
        }
      ],
      "bidModifiers": [
        {
          "match": {
            "Keyword": "string",
            "Site": 0,
            "Zone": 0,
            "Segment": 0,
            "SearchTerm": {
              "Term": "string"
            }
          },
          "price": 7.5,
          "multiplier": 1.5
        }
      ]
    }
  ]
}

Updated

• 2 months ago