API Queries - List Campaigns

The list_campaigns function shows all of your Campaigns with their settings and status. There are optional parameters, for search specific Campaigns and Folders. If optional parameters are omitted, the default is to display all campaigns.

Additional Parameters

• campaign - Name of the campaign to search (Keyword or RON). (Optional)
• folder - Name of the folder to search. (Optional)

Note: Make sure to URL encode all values.

Example query and response:

Example query:

Response:

<results>
<result Average_Bid="0.230" Blacklist_Subids="" Campaign="credit cards" Daily_Limit="250.00" 
Folder="Student Loans" Folder_Status="Stopped" Geo_Target="US" Highest_Bid="1.553" 
My_Bid="5.000" Negative_Keywords="" Status="Stopped" Target_URL="http://www.trellian.com" 
Traffic_Type="all" Type="Keyword">
	<Whitelist_Subids>
	<result id="1059815679" price="5.000"/>
	</Whitelist_Subids>
	</result>
</results>

If there are no campaigns in your account, the response will not be an error. Instead, this will be shown:

</results>

Error Responses:

Possible error responses for this function are:

• 420 - Folder not in account
• 420 - Campaign could not be found
• 421 - Campaign may only contain letters, digits and periods
• 421 - Folder name may only contain letters, digits and spaces
• Other general errors, such as 200 - Internal Error or 300 - Username or password invalid.

For a complete list of error responses, see the Error Codes manual page.