What are ETARGET XML RPC methods?

ETARGET XML RPC methods let developers automate common tasks in their ETARGET account, whether they are using client, agency or partner accounts. With these methods, they can use ETARGET system far more efficiently and manage large or complex amounts of data.

Using XML RPC methods is easy, you don't need to sing up, you don't need no approvals just an active ETARGET account.

Below are examples of methods currently supported by our system, if you would need some other functionality, do let us know and contact us on develop@etarget.sk. Also if you need any help or explanation, feel free to ask.

What is XML-RPC?

It's a spec and a set of implementations that allow software running on disparate operating systems, running in different environments to make procedure calls over the Internet. You can develop in any language of your choice. XML RPC interface is supported by all popular programming languages such as PHP, Java, Python, .NET, Perl... It's remote procedure calling using HTTP as the transport and XML as the encoding. XML-RPC is designed to be as simple as possible, while allowing complex data structures to be transmitted, processed and returned.

(show all)
Usage: www.etarget.sk/rpc/index.php?s=XMLRPCstring

Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>agencyCampaignsStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>agency_login</value>
      </param>
      <param>
        <name>password</name>
        <value>agency_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>customer</name>
        <value>1163</value>
      </param>
      <param>
        <name>amount_without_vat</name>
        <value>5000</value>
      </param>
   </params>
</methodCall>
loginAgency login
passwordAgency password
idAgency ID
customerID of customer to recieve credit
amount_without_vatAmount to be moved
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
   <methodCall>
       <methodName>campaignStarter</methodName>
       <params>
           <param>
               <name>login</name>
               <value>my_login</value>
           </param>
           <param>
               <name>password</name>
               <value>my_password</value>
           </param>
           <param>
               <name>id</name>
               <value>12345</value>
           </param>
           <param>
               <name>action</name>
               <value>stop</value>
           </param>
       </params>
   </methodCall>
loginClient's login
passwordClient's password
idClient's ID
actionstop|start
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>campaignUrl</methodName>
    <params>
        <param>
            <name>login</name>
            <value>my_login</value>
        </param>
        <param>
            <name>password</name>
            <value>my_password</value>
        </param>
        <param>
            <name>id</name>
            <value>12345</value>
        </param>
        <param>
            <name>campaigns</name>
            <value>
                <campaign>
                    <id>1</id>
                    <url>http://www.dovolenka.sk/chorvatsko/dovolenka.asp?id=23&#x0026;from=etarget</url>
                </campaign>
                <campaign>
                    <id>2</id>
                    <url>http://www.dovolenka.sk/chorvatsko/dovolenka.asp?id=26&#x0026;from=etarget</url>
                </campaign>
            </value>
        </param>
    </params>
</methodCall>
loginAgency's login
passwordAgency's password
idAgency's ID
campaignsList of campaigns
campaign.idUnique identifier for the campaign
campaign.urlSets the campaign's REAL url to the given value
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>createCustomer</methodName>
    <params>
        <param>
            <name>login</name>
            <value>my_agency_login</value>
        </param>
        <param>
            <name>password</name>
            <value>my_agency_password</value>
        </param>
        <param>
            <name>id</name>
            <value>12345</value>
        </param>
        <param>
            <name>customers</name>
            <value>
                <customer>
                    <id>1</id>
                    <login>unique_loginname</login>
                    <password>password</password>
                    <name>customer_name</name>
                </customer>
                <customer>
                    <id>2</id>
                    <name>customer_name2</name>
                </customer>
            </value>
        </param>
    </params>
</methodCall>
loginAgency's login
passwordAgency's password
idAgency's ID
customersList of customers
customer.idREQUIRED: some unique identifier for customer
customer.loginloginname for customer - optional if missing loginname is automatically generated
customer.passwordpassword for customer - optional if missing password is automatically generated
customer.namecustomer's name
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>dynamicKeywords</methodName>
    <params>
        <param>
            <name>login</name>
            <value>my_login</value>
        </param>
        <param>
            <name>password</name>
            <value>my_password</value>
        </param>
        <param>
            <name>id</name>
            <value>12345</value>
        </param>
        <param>
            <name>dynamic_keywords</name>
            <value>
                <dynamic_keyword>
                    <keyword>nokia</keyword>
                    <text>Nokia</text>
                    <id>9876</id>
                    <attr1>900Sk</attr1>
                    <attr2>Vypredaj</attr2>
                    <attr3></attr3>
                    <id_campaign>1</id_campaign>
                </dynamic_keyword>
                <dynamic_keyword>
                    <keyword>sony</keyword>
                    <text>Sony Ericsson</text>
                    <id>54321</id>
                    <attr1>900Sk</attr1>
                    <attr2>Vypredaj</attr2>
                    <attr3>Uz iba 10 kusov</attr3>
                    <id_campaign>1</id_campaign>
                </dynamic_keyword>
            </value>
        </param>
    </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
dynamic_keywordsList of dynamic keywords
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>campaignPriority</methodName>
    <params>
        <param>
            <name>id_partner</name>
            <value>12345</value>
        </param>
        <param>
            <name>password</name>
            <value>my_password</value>
        </param>
        <param>
            <name>categories</name>
            <value>
                <category>
                    <id>1</id>
                    <keywords>0</keywords>
                    <name>Cars</name>
                </category>
                <category>
                    <id>2</id>
                    <keywords>100</keywords>
                    <name>Fruits</name>
                </category>
            </value>
        </param>
    </params>
</methodCall>
idPartners's ID
passwordAgency's password
categoriesList of categories
categoryCategory data
category.idUnique identifier for the category
category.nameCategory name - optional
category.keywordsKeywords for actual category
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>updateCampaigns</methodName>
    <params>
        <param>
            <name>login</name>
            <value>my_login</value>
        </param>
        <param>
            <name>password</name>
            <value>my_password</value>
        </param>
        <param>
            <name>id</name>
            <value>12345</value>
        </param>
        <param>
            <name>campaigns</name>
            <value>
                <campaign>
                    <id>1234</id>
                    <title>Many #KEYWORD# in our webshop</title>
                    <description>Wide range of the latest #KEYWORD# and <br/>accessories at the Official my_web.com shop.</description>
                    <url>http://www.my_web.com/product.php?id=#ID#</url>
                    <broad_price>0.4</broad_price>
                </campaign>
                <campaign>
                    <id>1235</id>
                    <title>Cheap Sony cameras</title>
                    <description>The place to go before you buy Sony cameras.</description>
                    <url>http://www.my_web.com/sony</url>
                    <broad_price>0.7</broad_price>
                </campaign>
            </value>
        </param>
        <param>
            <name>keywords</name>
            <value>
                <keyword>
                    <keyword>nokia</keyword>
                    <id_campaign>1234</id_campaign>
                    <price>0.5</price>
                    <text>Nokia</text>
                    <id>9876</id>
                </keyword>
                <keyword>
                    <keyword>sony</keyword>
                    <id_campaign>1235</id_campaign>
                    <price>0.4</price>
                </keyword>
            </value>
        </param>
    </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
campaignsList of campaigns
keywordsList of keywords
deleteOtherWhether to delete all campaigns and keywords not included in current method call (<value>0</value> or <value>1</value>)
Method output XML input
(show all)
Usage: www.etarget.sk/rpc/index.php?s=XMLRPCstring

Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>agencyCampaignsStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>agency_login</value>
      </param>
      <param>
        <name>password</name>
        <value>agency_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>customer</name>
        <value>import_id</value>
      </param>
      <param>
        <name>onlyActiveCampaigns</name>
        <value>1</value>
      </param>
      <param>
        <name>from</name>
        <value>22.03.2004</value>
      </param>
      <param>
        <name>to</name>
        <value>25.03.2004</value>
      </param>
   </params>
</methodCall>
loginAgency login
passwordAgency password
idAgency ID
customerOptional. If present only the campaigns owned by customer with this import ID is returned.
onlyActiveCampaignsOptional. If set only active campaigns are returned
fromBeginning date for statistics (e.g. <value><int>#TIMESTAMP</int></value> or <value>25.3.2004</value> or <<value>2004.3.25</value>)
toEnding date for statistics (same format as 'from')
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>agencyTopWords</methodName>
   <params>
      <param>
        <name>login</name>
        <value>agency_login</value>
      </param>
      <param>
        <name>password</name>
        <value>agency_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
   </params>
</methodCall>
loginAgency login
passwordAgency password
idAgency ID
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>campaignsStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>my_login</value>
      </param>
      <param>
        <name>password</name>
        <value>my_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
   </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>campaignsStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>my_login</value>
      </param>
      <param>
        <name>password</name>
        <value>my_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>from</name>
        <value>22.03.2004</value>
      </param>
      <param>
        <name>to</name>
        <value>25.03.2004</value>
      </param>
   </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
fromBeginning date for statistics (e.g. <value><int>#TIMESTAMP</int></value> or <value>25.3.2004</value> or <<value>2004.3.25</value>)
toEnding date for statistics (same format as 'from')
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>catalogCategory</methodName>
   <params>
      <param>
        <name>login</name>
        <value>partner_login</value>
      </param>
      <param>
        <name>password</name>
        <value>partner_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>categoryid</name>
        <value>12345</value>
      </param>
   </params>
</methodCall>
loginPartner login
passwordPartner password
idPartner ID
categoryidCategory ID
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>checkLogin</methodName>
   <params>
      <param>
        <name>login</name>
        <value>my_login</value>
      </param>
   </params>
</methodCall>
loginClient's login
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>customerCredit</methodName>
   <params>
      <param>
        <name>login</name>
        <value>customer_login</value>
      </param>
      <param>
        <name>password</name>
        <value>customer_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
   </params>
</methodCall>
loginCustomer login
passwordCustomer password
idCustomer ID
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>customerCredit</methodName>
   <params>
      <param>
        <name>login</name>
        <value>customer_login</value>
      </param>
      <param>
        <name>password</name>
        <value>customer_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>from</name>
        <value>22.03.2004</value>
      </param>
      <param>
        <name>to</name>
        <value>25.03.2004</value>
      </param>
   </params>
</methodCall>
loginCustomer login
passwordCustomer password
idCustomer ID
fromBeginning date for statistics (e.g. <value><int>#TIMESTAMP</int></value> or <value>25.3.2004</value> or <<value>2004.3.25</value>)
toEnding date for statistics (same format as 'from')
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>dailyWordSearchStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>customer_login</value>
      </param>
      <param>
        <name>password</name>
        <value>customer_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>word</name>
        <value>dvd</value>
      </param>
   </params>
</methodCall>
loginLogin
passwordPassword
idCustomer ID
wordWord
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>campaignsStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>my_login</value>
      </param>
      <param>
        <name>password</name>
        <value>my_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>id_campaign</name>
        <value>12345</value>
      </param>
      <param>
        <name>from</name>
        <value>22.03.2004</value>
      </param>
      <param>
        <name>to</name>
        <value>25.03.2004</value>
      </param>
   </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
id_campaignCampaign ID
fromBeginning date for statistics (e.g. <value><int>#TIMESTAMP</int></value> or <value>25.3.2004</value> or <<value>2004.3.25</value>)
toEnding date for statistics (same format as 'from')
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>keywordsStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>agency_login</value>
      </param>
      <param>
        <name>password</name>
        <value>agency_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>campaign</name>
        <value>campaign_id</value>
      </param>
      <param>
        <name>type</name>
        <value>fulltext</value>
      </param>
      <param>
        <name>from</name>
        <value>22.03.2004</value>
      </param>
      <param>
        <name>to</name>
        <value>25.03.2004</value>
      </param>
   </params>
</methodCall>
loginLogin
passwordPassword
idCustomer ID
campaigncampaign
typefulltext|context|broad|all(default)
fromBeginning date for statistics (e.g. <value><int>#TIMESTAMP</int></value> or <value>25.3.2004</value> or <<value>2004.3.25</value>)
toEnding date for statistics (same format as 'from')
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>keywordsStatsWithLogos</methodName>
   <params>
      <param>
        <name>login</name>
        <value>agency_login</value>
      </param>
      <param>
        <name>password</name>
        <value>agency_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>campaign</name>
        <value>campaign_id</value>
      </param>
      <param>
        <name>type</name>
        <value>fulltext</value>
      </param>
      <param>
        <name>from</name>
        <value>22.03.2004</value>
      </param>
      <param>
        <name>to</name>
        <value>25.03.2004</value>
      </param>
   </params>
</methodCall>
loginLogin
passwordPassword
idCustomer ID
campaigncampaign
typefulltext|context|broad|all(default)
fromBeginning date for statistics (e.g. <value><int>#TIMESTAMP</int></value> or <value>25.3.2004</value> or <<value>2004.3.25</value>)
toEnding date for statistics (same format as 'from')
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>publisherStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>publisher_login</value>
      </param>
      <param>
        <name>password</name>
        <value>publisher_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>from</name>
        <value>22.03.2004</value>
      </param>
      <param>
        <name>to</name>
        <value>25.03.2004</value>
      </param>
      <param>
        <name>group_by_days</name>
        <value>false</value>
      </param>
   </params>
</methodCall>
loginPublisher login
passwordPublisher password
idPublisher ID
fromBeginning date for statistics (e.g. <value><int>#TIMESTAMP</int></value> or <value>25.3.2004</value> or <<value>2004.3.25</value>)
toEnding date for statistics (same format as 'from')
group_by_daysDefault = false, if set to true, the results are grouped by days
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>publisherStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>publisher_login</value>
      </param>
      <param>
        <name>password</name>
        <value>publisher_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>area</name>
        <value>12345</value>
      </param>
      <param>
        <name>from</name>
        <value>22.03.2004</value>
      </param>
      <param>
        <name>to</name>
        <value>25.03.2004</value>
      </param>
   </params>
</methodCall>
loginPublisher login
passwordPublisher password
idPublisher ID
areaidArea ID
fromBeginning date for statistics (e.g. <value><int>#TIMESTAMP</int></value> or <value>25.3.2004</value> or <<value>2004.3.25</value>)
toEnding date for statistics (same format as 'from')
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>publisherStats</methodName>
   <params>
      <param>
        <name>login</name>
        <value>publisher_login</value>
      </param>
      <param>
        <name>password</name>
        <value>publisher_password</value>
      </param>
      <param>
        <name>id</name>
        <value>12345</value>
      </param>
      <param>
        <name>area</name>
        <value>12345</value>
      </param>
      <param>
        <name>from</name>
        <value>22.03.2004</value>
      </param>
      <param>
        <name>to</name>
        <value>25.03.2004</value>
      </param>
   </params>
</methodCall>
loginPublisher login
passwordPublisher password
idPublisher ID
areaidArea ID
fromBeginning date for statistics (e.g. <value><int>#TIMESTAMP</int></value> or <value>25.3.2004</value> or <<value>2004.3.25</value>)
toEnding date for statistics (same format as 'from')
Method output XML input