PDF

ad object

The functional unit that displays in the ad space and which represents the message that an advertiser wants an end-user to view.

The ad object has the following calls:

Call	Description
`DELETE /ad`	Delete the specified ads.
`DELETE /ad/ad_UID`	Delete the specified ad.
`GET /ad`	List all ads.
`GET /ad/ad_UID`	Read the specified ad.
`GET /ad/available_fields?type_full=ad.type`	List the `available_fields` to create or update an ad object of the specified type. See ad object example.
`POST /ad`	Create one or more ads.
`POST /ad/ad_UID/clone`	Create a copy of the specified ad.
`POST /ad/ad_UID/recycle`	Restart the specified ad.
`POST /ad/ad_UID/stop`	Pause the specified ad.
`PUT /ad`	Update the specified ads.
`PUT /ad/ad_UID`	Update the specified ad.

Example

Sample response for GET /ad/available_fields?type_full=ad.type_full=ad.image.

Expand example

{
  "account_id": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "int"
  },
  "account_uid": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "account_uid"
  },
  "ad_type_id": {
    "auto": true,
    "default": "1",
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "int",
    "value": "1"
  },
  "ad_weight": {
    "has_dependencies": false,
    "maximum": "100.0",
    "readonly": false,
    "required": false,
    "type": "decimal(4,1)"
  },
  "alt_text": {
    "has_dependencies": false,
    "maxlen": 25000,
    "readonly": false,
    "required": false,
    "type": "varchar"
  },
  "click_target_window": {
    "default": "_self",
    "has_dependencies": false,
    "maxlen": 255,
    "readonly": false,
    "required": true,
    "type": "varchar",
    "url": "/options/click_target_window_options"
  },
  "click_url": {
    "has_dependencies": false,
    "maxlen": 2000,
    "readonly": false,
    "required": true,
    "type": "varchar"
  },
  "created_date": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "datetime"
  },
  "days_of_week": {
    "default": {},
    "has_dependencies": false,
    "items": {
      "has_dependencies": false,
      "readonly": false,
      "required": false,
      "type": "int",
      "url": "/options/days_of_week_options"
    },
    "readonly": false,
    "required": false,
    "type": "array"
  },
  "deleted": {
    "auto": true,
    "default": "0",
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "int"
  },
  "deliver_by_default": {
    "has_dependencies": false,
    "readonly": false,
    "required": false,
    "type": "int"
  },
  "end_date": {
    "has_dependencies": false,
    "readonly": false,
    "required": false,
    "type": "datetime"
  },
  "external_id": {
    "has_dependencies": false,
    "maxlen": 255,
    "readonly": false,
    "required": false,
    "type": "varchar"
  },
  "flight_timezone": {
    "default": "Advertiser",
    "has_dependencies": false,
    "maxlen": 255,
    "readonly": false,
    "required": false,
    "type": "varchar",
    "url": "/options/flight_timezone_options"
  },
  "hours_of_day": {
    "default": {},
    "has_dependencies": false,
    "items": {
      "has_dependencies": false,
      "readonly": false,
      "required": false,
      "type": "int",
      "url": "/options/hours_of_day_options"
    },
    "readonly": false,
    "required": false,
    "type": "array"
  },
  "id": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "int"
  },
  "individual_display_cap": {
    "has_dependencies": false,
    "readonly": false,
    "required": false,
    "type": "int"
  },
  "instance_uid": {
    "auto": true,
    "has_dependencies": false,
    "maxlen": 255,
    "readonly": true,
    "required": false,
    "type": "varchar"
  },
  "lineitem_id": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "int"
  },
  "lineitem_uid": {
    "has_dependencies": false,
    "readonly": false,
    "required": true,
    "type": "uid"
  },
  "modified_date": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "datetime"
  },
  "name": {
    "has_dependencies": false,
    "maxlen": 255,
    "readonly": false,
    "required": true,
    "type": "varchar"
  },
  "notes": {
    "has_dependencies": false,
    "maxlen": 25000,
    "readonly": false,
    "required": false,
    "type": "varchar"
  },
  "order_id": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "int"
  },
  "order_uid": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "uid"
  },
  "primary_creative_id": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "int"
  },
  "primary_creative_uid": {
    "has_dependencies": false,
    "readonly": false,
    "required": true,
    "type": "uid"
  },
  "remote_media_file": {
    "has_dependencies": false,
    "maxlen": 255,
    "readonly": false,
    "required": false,
    "type": "varchar"
  },
  "session_display_cap": {
    "has_dependencies": false,
    "readonly": false,
    "required": false,
    "type": "int"
  },
  "session_duration": {
    "has_dependencies": false,
    "readonly": false,
    "required": false,
    "type": "int"
  },
  "size": {
    "has_dependencies": false,
    "maxlen": 255,
    "readonly": false,
    "required": true,
    "type": "varchar",
    "url": "/options/web_size_options"
  },
  "start_date": {
    "has_dependencies": false,
    "readonly": false,
    "required": false,
    "type": "datetime"
  },
  "status": {
    "has_dependencies": false,
    "maxlen": 12,
    "readonly": false,
    "required": true,
    "type": "varchar",
    "url": "/options/ad_status_options"
  },
  "type": {
    "auto": true,
    "has_dependencies": false,
    "maxlen": 255,
    "readonly": true,
    "required": false,
    "type": "varchar",
    "url": "/options/model_types"
  },
  "type_full": {
    "has_dependencies": false,
    "maxlen": 64,
    "readonly": false,
    "required": true,
    "type": "varchar",
    "value": "ad.image"
  },
  "uid": {
    "auto": true,
    "has_dependencies": false,
    "readonly": true,
    "required": false,
    "type": "uid"
  },
  "v": {
    "auto": true,
    "default": "3",
    "has_dependencies": false,
    "options": [],
    "readonly": true,
    "required": false,
    "type": "int"
  }
}