View
 

Tools: Text Ads API Methods


txtads/list

List Text Ads in a Campaign.

 

  GET /campaigns/#{campaign_id}/txtads.xml 

 

// Code

txtads_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.

txtads/show

Show details about a Text Ad.

 

  GET /campaigns/#{campaign_id}/txtads/#{txtad_id}.xml 

 

 

// Code
txtad_show($campaign_id, $txtad_id) 

 

Parameters:

  • campaign_id. Required. A Campaign ID.
  • txtad_id. Required. A Text Ad ID.

txtads/search

Search for Text Ads.

 

  GET /campaigns/#{campaign_id}/txtads/search.xml 

 

// Code

txtads_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 text ad.
  • 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)

txtads/create

Merchants:  Create a new Text Ad.

 

  POST /campaigns/{$campaign_id}/txtads.xml 

 

// Code

txtad_create($campaign_id, $txtad) 

 

 Parameters: 

  • campaign_id. Required. A Campaign ID.
  • txtad. Required. An Array that contains ("title" => "title", "content" => "content", "url" => "url", "help" => "help") or XML equivalent.

txtads/update

Merchants:  Update a Text Ad.

 

  PUT /campaigns/{$campaign_id}/txtads/#{txtad_id}.xml 

 

// Code

txtad_update($campaign_id, $txtad_id, $txtad) 

 

Parameters:

  • campaign_id. Required. A Campaign ID.
  • txtad_id. Required. A Text Ad ID.
  • txtad. Required. The modified Text Ad.

txtads/destroy

Merchants:  Delete a Text Ad.

 

  DELETE /campaigns/{$campaign_id}/txtads/#{txtad_id}.xml 

 

// Code

txtad_destroy($campaign_id, $txtad_id) 

 

Parameters:

  • campaign_id. Required. A Campaign ID.
  • txtad_id.  Required. A Text AD ID.