The Ad data object represents an ad.
| Restrictions * | ||||
|---|---|---|---|---|
| Element | Data Type | Description | Add | Full-Up |
| accountID | string | The ID of the account. | RO | RO |
|
adOptimization Weight |
long | The weight of the ad in a placement. The number (1 - 100) represents the number of times the ad will be displayed (the weight), when compared to the other ads in the placement. Set the value here if the placement's adOptimization flag is set to false. By default, the weight will be set to 1 if there are multiple ads assigned to the placement. | RO | Opt |
| clickThroughURLs | CompositeURL[] | The click through and (optional) click tracking URLs for the ad. | RO | RO |
| createTimestamp | dateTime | The date the ad was added. | RO | RO |
| creativeCode | string | The creative code for the ad, returned only if ad is retrieved using ad filter. | RO | RO |
| endDate | dateTime | The flight end date. | Opt | Opt |
| iabKey | string | The IAB compliant Impression Exchange Solution ad ID (IES ID) generated by the publisher for reconciling publisher's data with data from third-party ad servers. | RO | Req |
| ID | long | The ID of the ad (in the placement). | RO | Req |
|
impressionTracking URLs |
string[] | The impression tracking URLs for the ad, returned only if ad is retrieved using ad filter. | RO | RO |
| lastUpdateTimestamp | dateTime | The date the ad was last updated. | RO | RO |
| legacyAdGroupID | long | The ID of the (legacy) ad group to which the ad was assigned. | RO | RO |
| libraryAdID | long | The ID of the ad (in the ad library). | Req | RO |
| placementID | long | The ID of the placement that the ad is assigned to. | Req | RO |
| startDate | dateTime | The flight start date. This date cannot be before the placement start date and, if this start date is the same as the placement start date, ensure that the ad start time is not before the placement start time. | Opt | Opt |
| status | AdStatus | The status of the ad. | RO | RO |
| testGrpID | long | The ID of the test group that the ad is assigned to. | Opt | Opt |
| type | long | The type of ad. | RO | RO |