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 (at) 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.pl/rpc/index.php?s=XMLRPCstring

Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>addKeywords</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>campaign</name>
            <value>12345</value>
        </param>
        <param>
            <name>keywords</name>
            <value>
                <keyword>
                    <value>nokia</value>                    
                    <price>0.5</price>
                </keyword>
                <keyword>
                    <value>sony</value>
                    <price>0.4</price>
                </keyword>
            </value>
        </param>                               
    </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
campaignCampaign's ID
keywordsList of keywords and prices
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>addOrEditCampaign</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>campaign</name>
            <value>            
                <version>
                    <title>nokia</title>                    
                    <line_1>line 1</line_1>
                    <line_2>line 2</line_2>
                    <real_url>www.real.com</real_url>
                    <shown_url>www.shown.com</shown_url>
                    <version_num>1</version_num>
                    <version_status>active</version_status>
                    <version_img>base64_encode(raw_image_data)</version_img>
                </version>
                <version>
                    <title>nokia</title>                    
                    <line_1>line 1</line_1>
                    <line_2>line 2</line_2>
                    <real_url>www.real.com</real_url>
                    <shown_url>www.shown.com</shown_url>
                    <version_num>2</version_num>
                    <version_status>stop</version_status>
                    <version_img>base64_encode(raw_image_data)</version_img>
                </version>
                <version>
                    <title>nokia</title>                    
                    <line_1>line 1</line_1>
                    <line_2>line 2</line_2>
                    <real_url>www.real.com</real_url>
                    <shown_url>www.shown.com</shown_url>
                    <version_num>3</version_num>
                    <version_status>active</version_status>
                </version>                
            </value>
        </param>         
    </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
id_campaignCampaign ID, if 0 new campaign will be added.
campaigncampaign data
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>addOrEditEshopCampaign</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>campaign_name</name>
            <value>name</value>
        </param>
        <param>
            <name>status</name>
            <value>active</value>
        </param>
        <param>
            <name>title</name>
            <value>nokia e51</value>
        </param>
        <param>
            <name>line_1</name>
            <value>line 1</value>
        </param>
        <param>
            <name>line_2</name>
            <value>line2</value>
        </param>
        <param>
            <name>real_url</name>
            <value>www.real_url.com</value>
        </param>
        <param>
            <name>old_price</name>
            <value>15</value>
        </param>
        <param>
            <name>new_price</name>
            <value>9.99</value>
        </param>
        <param>
            <name>img</name>
            <value>base64_encode(raw_image_data)</value>
        </param>                 
    </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
id_campaignCampaign ID, if 0 new campaign will be added.
campaign_nameCampaign name
statusCampaign status {active/stop}
titlecampaign title
line_1campaign text line 1
line_2campaign text line 2
real_urlURL
old_priceold price of the product
new_pricenew price of the product
imgimage of the product
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>changeCampaignStatus</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>new_status</name>
            <value>activate</value>
        </param>
        <param>
            <name>version</name>
            <value>1</value>
        </param>
        
    </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
id_campaignCampaign ID
new_status{activate/stop}
version{all/1/2/3}
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>deleteCampaign</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>                       
    </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
id_campaignCampaign ID
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
    <methodName>deleteKeywords</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>keywords</name>
            <value>
                <keyword>nokia</keyword>                    
                <keyword>sony</keyword>
            </value>
        </param>                         
    </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
keywordsList of keywords separated with ,
Method output XML input
(show all)
Usage: www.etarget.pl/rpc/index.php?s=XMLRPCstring

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>customerSpending</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>getAgencyCampaignKeywords</methodName>
   <params>
      <param>
        <name>login</name>
        <value>agency_login</value>
      </param>
      <param>
        <name>password</name>
        <value>agency_password</value>
      </param>
      <param>
        <name>id_agency</name>
        <value>12345</value>
      </param>
      <param>
        <name>id_customer</name>
        <value>12345</value>
      </param>
      <param>
        <name>id_campaign</name>
        <value>12345</value>
      </param>      
   </params>
</methodCall>
loginAgency login
passwordAgency password
idAgency ID
customer0 - all customers, otherwise only the campaigns owned by customer with this ID is returned.
id_campaign0 - all campaigns, otherwise only the keywords owned by campaign with this ID is returned.
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>getAgencyCampaigns</methodName>
   <params>
      <param>
        <name>login</name>
        <value>agency_login</value>
      </param>
      <param>
        <name>password</name>
        <value>agency_password</value>
      </param>
      <param>
        <name>id_agency</name>
        <value>12345</value>
      </param>
      <param>
        <name>id_customer</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>
loginAgency login
passwordAgency password
idAgency ID
customer0 - all customers, otherwise only the campaigns owned by customer with this ID is 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>getCampaignKeywords</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>      
   </params>
</methodCall>
loginClient's login
passwordClient's password
idClient's ID
id_campaignCampaign ID
Method output XML input
Parameters:[show example input string]
<?xml version="1.0"?>
<methodCall>
   <methodName>getCampaigns</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>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