List of Ads
GET {{campaign_url}}/ads?lineItemId={{lineItemId}}&offset=0&limit=2&sortOrder=asc&sortKey=id
Retrieve a list of ads
You can retrieve all of the ads within a specified advertiser, IO, or LI by sending this GET
request.
Note: advertiserId
, insertionOrderId
, and lineItemId
cannot be used at the same time for a single request.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
advertiserId | string | Limits response results to ads under the advertiser specified. If left unchecked/empty, ads under all advertisers are returned. |
Cannot be defined when ID of any other campaign object is defined. |
| insertionOrderId
| string | | Limits response results to ads under the IO specified.
Cannot be defined when ID of any other campaign object is defined. |
| lineItemId
| string | | Limits response results to ads under the LI specified.
Cannot be defined when ID of any other campaign object is defined. |
| offset
| number | | The starting index in the list of ads. |
| limit
| number | | The number of ads to return. |
| sortOrder
| string | | Direction by which results should be sorted.
Allowed values: asc, desc |
| sortKey
| string | | Field by which results should be sorted.
Allowed values: id, name |