editKeywordCampaign

Definition

The editKeywordCampaign API Command is used to edit the keywords from an existing campaign.

Cost

Using this command consumes 1 credit.

Module

The command is included in the Campaign API Module and will only consume credits assigned for Campaign API Operations.

Parameters

campaignId The ID Number of the campaign.
action The action to be taken for the keyword. Values:

delete – Removes the keyword from the campaign;
nrKeywords Number of keywords that are going to be introduced in the campaign.
keyword(*) The keyword order you are going to insert. *number taking value from 1 to nrKeywords parameter
se* The Search Engine you want to add the keyword on. It’s not a mandatory field and can have the values: Google, Bing, Yahoo.
locale* The country where the tracking is made. It’s not a mandatory field and can take values from here: http://support.cognitiveseo.com/knowledgebase/getsupportedcountrycodes/
mobile* Allows you to decide if the tracking should be made on mobile or desktop. It’s not mandatory and can take the values “yes” or “no”. The default is “no”.
location* Allows you to choose the location of the tracking. It’s not mandatory and can take the standard values given by Google (Canonical Name for Geographical Targeting). The default is Universal Ranking.

*if any of these parameters is missing (se, locale, mobile, location) the keywords for any of the cases will be deleted.

Input URL Example

http://api.cognitiveseo.com/command.php?apiKey=your_api_key&command=editKeywordCampaign&campaignId=7&action=delete&nrKeywords=2&keyword1=aaa&keyword2=bbb

Output Example

Running this command will result in the following JSON output:

 

Output Details

status The status of the command (success or error).
message How many keywords were deleted (paused, activated or had the country changed).
credits The credit cost of the command.
time The time it took to process the command.
Go Top