banners/list
List Banners in a Campaign.
GET /campaigns/#{campaign_id}/banners.xml
// Code
banners_list($campaign_id, $page=1, $perpage=6)
Parameters:
- campaign_id. Required. A Campaign ID.
- page. Optional. The desired page.
- perpage. Optional. How many items per page.
banners/show
Show details about a Banner.
GET /campaigns/#{campaign_id}/banners/{$banner_id}.xml
// Code
banner_show($campaign_id, $banner_id)
Parameters:
- campaign_id. Required. A Campaign ID.
- banner_id. Required. A Banner ID.
banners/search
Search for Banners.
GET /campaigns/#{campaign_id}/banners/search.xml
// Code
banners_search($campaign_id, $search, $page=1, $perpage=6, $sort='date')
Parameters:
- campaign_id. Required. A Campaign ID or 'approved' for searching in campaigns that has the affiliate approved.
- search. Required. Keywords. Use advanced searching syntax to search through all the fields of each banner.
- page. Optional. The desired page.
- perpage. Optional. How many items per page.
- sort. Optional. Sort (by date, clicks, actions, abc [this is alphabetical], update_type [manual added products, from widget and imported], random)
banners/create
Merchants: Create a Banner.
POST /campaigns/{$campaign_id}/banners.xml
// Code
banner_create($campaign_id,$banner, $banner_picture)
Parameters:
- campaign_id. Required. A Campaign ID.
- banner. Required. An array that contains "url" => "where to redirect", "b_type" => "image or flash", "category" => "a category name (optional)", "deep_link" => "1 or 0", "help" => "help (optional)"
- banner_picture. Required. An array that contains "url" => "http:// where to download the banner from", "width" => "width (only if banner is flash)", "height" => "height (only if banner is flash)"
banners/update
Merchants: Update a Banner.
PUT /campaigns/{$campaign_id}/banners/{$banner_id}.xml
// Code
banner_update($campaign_id, $banner_id, $banner)
Parameters:
- campaign_id. Required. A Campaign ID.
- banner_id. Required. A Banner ID.
- banner. Required. The modified Banner.
banners/destroy
Merchants: Delete a Banner.
DELETE /campaigns/{$campaign_id}/banners/{$banner_id}.xml
// Code
banner_destroy($campaign_id, $banner_id)
Parameters:
- campaign_id. Required. A Campaign ID.
- banner_id. Required. A Banner ID.