Translations:API/1/en — различия между версиями
Admin (обсуждение | вклад) (Новая страница: «== API authorization == To access the API, you will need a user ID (app_id) and a signature (signature). Calling different methods is carried out using queries o…») |
Admin (обсуждение | вклад) |
||
| Строка 36: | Строка 36: | ||
</code> | </code> | ||
'''Signature (signature)''' is created using a temporary token (access_token), which can be obtained using the app_id and secret key parameters. | '''Signature (signature)''' is created using a temporary token (access_token), which can be obtained using the app_id and secret key parameters. | ||
| − | <br> Parameters app_id (user ID) and the key "secret key" are available on request to support. | + | <br /> Parameters app_id (user ID) and the key "secret key" are available on request to support. |
| − | <br> Getting a token: | + | <br /> Getting a token: |
<code> | <code> | ||
<pre> | <pre> | ||
| Строка 103: | Строка 103: | ||
== Campaign Statistics == | == Campaign Statistics == | ||
| − | To get campaign statistics, use the method <b>ads.analytic.campaign.get</b><br/> | + | To get campaign statistics, use the method <b>ads.analytic.campaign.get</b><br /> |
<table> | <table> | ||
<tr bgcolor = #DCDCDC> | <tr bgcolor = #DCDCDC> | ||
| Строка 146: | Строка 146: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b>Result:</b><br/> | + | <b>Result:</b><br /> |
Returns an object with data | Returns an object with data | ||
<code> | <code> | ||
| Строка 167: | Строка 167: | ||
== Statistics on sites in the advertiser's account == | == Statistics on sites in the advertiser's account == | ||
Statistics on sites in the advertiser's account means statistics on views and clicks on the site in the context of each campaign. | Statistics on sites in the advertiser's account means statistics on views and clicks on the site in the context of each campaign. | ||
| − | <br>To get statistics on sites, use the <b> ads.campaigns.statblock.get </b> method (GET request) | + | <br />To get statistics on sites, use the <b> ads.campaigns.statblock.get </b> method (GET request) |
<table> | <table> | ||
<tr bgcolor = #DCDCDC> | <tr bgcolor = #DCDCDC> | ||
| Строка 260: | Строка 260: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an object with data, example: | Returns an object with data, example: | ||
<code> | <code> | ||
| Строка 349: | Строка 349: | ||
== Statistics on all campaign materials == | == Statistics on all campaign materials == | ||
| − | To get statistics on all campaign materials, use the <b> ads.analytic.materials.get </b> method <br/> | + | To get statistics on all campaign materials, use the <b> ads.analytic.materials.get </b> method <br /> |
<table> | <table> | ||
| Строка 388: | Строка 388: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an object with data | Returns an object with data | ||
<code> | <code> | ||
| Строка 410: | Строка 410: | ||
== Material statistics == | == Material statistics == | ||
| − | For statistics on the material, use the method <b> ads.analytic.material.get </b> <br/> | + | For statistics on the material, use the method <b> ads.analytic.material.get </b> <br /> |
<table> | <table> | ||
<tr bgcolor = #DCDCDC> | <tr bgcolor = #DCDCDC> | ||
| Строка 448: | Строка 448: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an object with data | Returns an object with data | ||
<code> | <code> | ||
| Строка 469: | Строка 469: | ||
== Creating an advertising campaign == | == Creating an advertising campaign == | ||
| − | To create a new advertising campaign, use the <b> ads.campaigns.put </b> <br> method | + | To create a new advertising campaign, use the <b> ads.campaigns.put </b> <br /> method |
| − | The number of campaigns created with a single request is 50. <br/> | + | The number of campaigns created with a single request is 50. <br /> |
<table> | <table> | ||
<tr bgcolor = #DCDCDC> | <tr bgcolor = #DCDCDC> | ||
| Строка 657: | Строка 657: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to queries in the data array. The corresponding object in the output array contains the id of the created campaign, and the error_code and error_desc fields in case of an error. | Returns an array of responses to queries in the data array. The corresponding object in the output array contains the id of the created campaign, and the error_code and error_desc fields in case of an error. | ||
<p> Errors: </p> | <p> Errors: </p> | ||
| Строка 664: | Строка 664: | ||
== Editing ad campaigns == | == Editing ad campaigns == | ||
| − | To edit ad campaigns, use the <b> ads.campaigns.update </b> <br> method | + | To edit ad campaigns, use the <b> ads.campaigns.update </b> <br /> method |
| − | The maximum number of campaigns edited with a single query is 50. <br> | + | The maximum number of campaigns edited with a single query is 50. <br /> |
Version log: 1.0.1 - added status parameter | Version log: 1.0.1 - added status parameter | ||
<table> | <table> | ||
| Строка 795: | Строка 795: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to each request in the data array. The corresponding object in the output array contains the id of the client being changed and, in case of an error, the error_code and error_desc fields. | Returns an array of responses to each request in the data array. The corresponding object in the output array contains the id of the client being changed and, in case of an error, the error_code and error_desc fields. | ||
<p> Errors: </p> | <p> Errors: </p> | ||
| Строка 851: | Строка 851: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of campaign objects, each of which contains the following fields: | Returns an array of campaign objects, each of which contains the following fields: | ||
<code> | <code> | ||
| Строка 882: | Строка 882: | ||
== Archiving an advertising campaign == | == Archiving an advertising campaign == | ||
| − | To archive an advertising campaign, use the <b> ads.campaigns.delete </b> <br> method | + | To archive an advertising campaign, use the <b> ads.campaigns.delete </b> <br /> method |
| − | The maximum number of clients edited with a single query is 10. <br/> | + | The maximum number of clients edited with a single query is 10. <br /> |
<table> | <table> | ||
| Строка 900: | Строка 900: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to each request. Each answer is either 0, which means successful deletion, or an error array. | Returns an array of responses to each request. Each answer is either 0, which means successful deletion, or an error array. | ||
<p> Errors: </p> | <p> Errors: </p> | ||
| Строка 908: | Строка 908: | ||
== Receiving codes for CPA campaigns == | == Receiving codes for CPA campaigns == | ||
| − | Use the <b> ads.campaigns.cpa.mode.get </b> <br/> method to get the codes for the CPA campaigns | + | Use the <b> ads.campaigns.cpa.mode.get </b> <br /> method to get the codes for the CPA campaigns |
<table> | <table> | ||
| Строка 922: | Строка 922: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an object with data. | Returns an object with data. | ||
<code> | <code> | ||
| Строка 935: | Строка 935: | ||
== Getting a list of categories for a given filter == | == Getting a list of categories for a given filter == | ||
| − | To return the list of categories for a given filter, use the <b> ads.campaigns.categories.get </b> <br/> method | + | To return the list of categories for a given filter, use the <b> ads.campaigns.categories.get </b> <br /> method |
<table> | <table> | ||
| Строка 956: | Строка 956: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to queries in the response array. | Returns an array of responses to queries in the response array. | ||
<code> | <code> | ||
| Строка 975: | Строка 975: | ||
== Getting the list of ad formats == | == Getting the list of ad formats == | ||
| − | Use the <b> ads.campaigns.formats.get </b> <br/> method to get the list of ad formats. | + | Use the <b> ads.campaigns.formats.get </b> <br /> method to get the list of ad formats. |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to queries in the response array. | Returns an array of responses to queries in the response array. | ||
<code> | <code> | ||
| Строка 992: | Строка 992: | ||
== Getting the list of platforms == | == Getting the list of platforms == | ||
| − | For a list of platforms, use the <b> ads.targeting.platforms.get </b> <br/> method | + | For a list of platforms, use the <b> ads.targeting.platforms.get </b> <br /> method |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to queries in the response array. | Returns an array of responses to queries in the response array. | ||
<code> | <code> | ||
| Строка 1010: | Строка 1010: | ||
== Getting Browser List == | == Getting Browser List == | ||
| − | For a list of browsers, use the <b> ads.targeting.browsers.get </b> <br/> method | + | For a list of browsers, use the <b> ads.targeting.browsers.get </b> <br /> method |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to queries in the response array. | Returns an array of responses to queries in the response array. | ||
<code> | <code> | ||
| Строка 1027: | Строка 1027: | ||
== Getting a list of conversion notifications for the CPA == | == Getting a list of conversion notifications for the CPA == | ||
| − | To get a list of conversion notifications for CPA, use the <b> ads.targeting.cpa.modes.get </b> <br/> method | + | To get a list of conversion notifications for CPA, use the <b> ads.targeting.cpa.modes.get </b> <br /> method |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to queries in the response array. | Returns an array of responses to queries in the response array. | ||
<code> | <code> | ||
| Строка 1044: | Строка 1044: | ||
== Getting a list of ages == | == Getting a list of ages == | ||
| − | To get the list of views, use the <b> ads.targeting.ages.get </b> <br/> method | + | To get the list of views, use the <b> ads.targeting.ages.get </b> <br /> method |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to queries in the response array. | Returns an array of responses to queries in the response array. | ||
<code> | <code> | ||
| Строка 1061: | Строка 1061: | ||
== Creating advertising agency clients == | == Creating advertising agency clients == | ||
| − | To create ad agency clients, use the <b> ads.clients.put method </b> <br/> | + | To create ad agency clients, use the <b> ads.clients.put method </b> <br /> |
The allowable number of clients created with a single request is 50. | The allowable number of clients created with a single request is 50. | ||
| Строка 1090: | Строка 1090: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to queries in the data array. The corresponding object in the output array contains the client information or the error array in case of an error (for each client separately). | Returns an array of responses to queries in the data array. The corresponding object in the output array contains the client information or the error array in case of an error (for each client separately). | ||
<code> | <code> | ||
| Строка 1103: | Строка 1103: | ||
== Editing advertising agency clients == | == Editing advertising agency clients == | ||
| − | To edit ad agency clients, use the <b> ads.clients.update method </b> <br/> | + | To edit ad agency clients, use the <b> ads.clients.update method </b> <br /> |
The maximum number of clients edited with a single query is 50. | The maximum number of clients edited with a single query is 50. | ||
| Строка 1137: | Строка 1137: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to each request in the data array. The corresponding object in the output array contains the id of the client being changed and, in case of an error, the error_code and error_desc fields. | Returns an array of responses to each request in the data array. The corresponding object in the output array contains the id of the client being changed and, in case of an error, the error_code and error_desc fields. | ||
== Getting a list of advertising agency clients == | == Getting a list of advertising agency clients == | ||
| − | To return the list of clients of an advertising agency, use the <b> ads.clients.get method </b> <br/> | + | To return the list of clients of an advertising agency, use the <b> ads.clients.get method </b> <br /> |
<table> | <table> | ||
| Строка 1157: | Строка 1157: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of client objects of the agency, each of which contains the following fields: | Returns an array of client objects of the agency, each of which contains the following fields: | ||
<code> | <code> | ||
| Строка 1174: | Строка 1174: | ||
== Archiving advertising agency clients == | == Archiving advertising agency clients == | ||
| − | For archiving ad agency clients, use the <b> ads.clients.delete method </b> <br/> | + | For archiving ad agency clients, use the <b> ads.clients.delete method </b> <br /> |
<table> | <table> | ||
| Строка 1192: | Строка 1192: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to each request. Each answer is either 0, which means successful deletion, or an error array. | Returns an array of responses to each request. Each answer is either 0, which means successful deletion, or an error array. | ||
== Tying a client to an advertising agency == | == Tying a client to an advertising agency == | ||
| − | To bind a client to an advertising agency, use the <b> ads.clients.bind.put method </b> <br/> | + | To bind a client to an advertising agency, use the <b> ads.clients.bind.put method </b> <br /> |
<table> | <table> | ||
| Строка 1216: | Строка 1216: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns: | Returns: | ||
<code> | <code> | ||
| Строка 1228: | Строка 1228: | ||
== Detaching a client from an advertising agency == | == Detaching a client from an advertising agency == | ||
| − | To detach a client from an advertising agency, use the <b> ads.clients.unbind.put method </b> <br/> | + | To detach a client from an advertising agency, use the <b> ads.clients.unbind.put method </b> <br /> |
<table> | <table> | ||
| Строка 1243: | Строка 1243: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns: | Returns: | ||
<code> | <code> | ||
| Строка 1255: | Строка 1255: | ||
== Customer account replenishment == | == Customer account replenishment == | ||
| − | To replenish the client’s account, use the <b> ads.clients.balance.put method </b> <br/> | + | To replenish the client’s account, use the <b> ads.clients.balance.put method </b> <br /> |
<table> | <table> | ||
| Строка 1287: | Строка 1287: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns the url for payment: | Returns the url for payment: | ||
<code> | <code> | ||
| Строка 1301: | Строка 1301: | ||
== Creating advertisements == | == Creating advertisements == | ||
| − | To create ads using the method <b> ads.materials.put </b> <br/> | + | To create ads using the method <b> ads.materials.put </b> <br /> |
The maximum allowable number of ads generated by a single request is 20. | The maximum allowable number of ads generated by a single request is 20. | ||
| Строка 1363: | Строка 1363: | ||
== Update ad data == | == Update ad data == | ||
| − | Use the <b> ads.materials.update </b> <br/> method to update ad data. | + | Use the <b> ads.materials.update </b> <br /> method to update ad data. |
The maximum allowable number of ads generated by a single request is 20. | The maximum allowable number of ads generated by a single request is 20. | ||
| Строка 1396: | Строка 1396: | ||
== Archiving advertisements == | == Archiving advertisements == | ||
| − | For advertising ads using the method <b> ads.materials.delete </b> <br/> | + | For advertising ads using the method <b> ads.materials.delete </b> <br /> |
The maximum number of clients edited with a single query is 50. | The maximum number of clients edited with a single query is 50. | ||
| Строка 1417: | Строка 1417: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to each request. Each answer is either 0, which means successful deletion, or an error array. | Returns an array of responses to each request. Each answer is either 0, which means successful deletion, or an error array. | ||
| Строка 1478: | Строка 1478: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of ad objects, each of which contains the following fields: | Returns an array of ad objects, each of which contains the following fields: | ||
<ul type = "disc"> | <ul type = "disc"> | ||
| Строка 1507: | Строка 1507: | ||
== Getting a list of banner sizes == | == Getting a list of banner sizes == | ||
| − | For a list of banner sizes, use the <b> ads.materials.banner.sizes.get </b> <br/> method | + | For a list of banner sizes, use the <b> ads.materials.banner.sizes.get </b> <br /> method |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to requests in the response array: | Returns an array of responses to requests in the response array: | ||
<code> | <code> | ||
| Строка 1524: | Строка 1524: | ||
== Getting the list of countries == | == Getting the list of countries == | ||
| − | To get the list of countries, use the <b> data.geo.countries.get </b> <br/> method | + | To get the list of countries, use the <b> data.geo.countries.get </b> <br /> method |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to requests in the response array: | Returns an array of responses to requests in the response array: | ||
<code> | <code> | ||
| Строка 1541: | Строка 1541: | ||
== Getting a list of regions for a given filter == | == Getting a list of regions for a given filter == | ||
| − | To get a list of regions for a given filter, use the <b> data.geo.regions.get </b> <br/> method | + | To get a list of regions for a given filter, use the <b> data.geo.regions.get </b> <br /> method |
<table> | <table> | ||
| Строка 1556: | Строка 1556: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to requests in the response array: | Returns an array of responses to requests in the response array: | ||
<code> | <code> | ||
| Строка 1571: | Строка 1571: | ||
== Get a list of available payment systems == | == Get a list of available payment systems == | ||
| − | To get a list of available payment systems, use the <b> data.balance.systems.get </b> <br/> method | + | To get a list of available payment systems, use the <b> data.balance.systems.get </b> <br /> method |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to requests in the response array: | Returns an array of responses to requests in the response array: | ||
<code> | <code> | ||
| Строка 1588: | Строка 1588: | ||
== Download media files == | == Download media files == | ||
| − | To upload media files (jpg, png, gif), use the <b> data.upload.media.update </b> <br/> method | + | To upload media files (jpg, png, gif), use the <b> data.upload.media.update </b> <br /> method |
<table> | <table> | ||
| Строка 1607: | Строка 1607: | ||
</table> | </table> | ||
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array with a reference to the target object or error in case of an error. | Returns an array with a reference to the target object or error in case of an error. | ||
<code> | <code> | ||
| Строка 1665: | Строка 1665: | ||
== Get the current server time == | == Get the current server time == | ||
| − | To get the current server time in ISO 8601 format, use the <b> server.time.get </b> <br/> method | + | To get the current server time in ISO 8601 format, use the <b> server.time.get </b> <br /> method |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
Returns an array of responses to requests in the response array: | Returns an array of responses to requests in the response array: | ||
<code> | <code> | ||
| Строка 1678: | Строка 1678: | ||
== Statistics for Webmasters == | == Statistics for Webmasters == | ||
| − | For statistics on webmasters use the method <b> webmaster.reports.report.get </b> <br/> | + | For statistics on webmasters use the method <b> webmaster.reports.report.get </b> <br /> |
<table> | <table> | ||
| Строка 1702: | Строка 1702: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> Maximum unloading period 1 month </b> <br/> | + | <b> Maximum unloading period 1 month </b> <br /> |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
<ul type = "disc"> | <ul type = "disc"> | ||
<li> <b> blockviews </b> - Block Views </li> | <li> <b> blockviews </b> - Block Views </li> | ||
| Строка 1728: | Строка 1728: | ||
== Money transfer for subsidiary accounts of the agency == | == Money transfer for subsidiary accounts of the agency == | ||
| − | To transfer money, use the <b> ads.clients.balance.update method </b> <br/> | + | To transfer money, use the <b> ads.clients.balance.update method </b> <br /> |
<table> | <table> | ||
| Строка 1757: | Строка 1757: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | <b> The operation can be performed only if there are sufficient funds on the account </b> <br/> | + | <b> The operation can be performed only if there are sufficient funds on the account </b> <br /> |
| − | <b> Money will be withdrawn from the user specified in the app_id </b> <br/> | + | <b> Money will be withdrawn from the user specified in the app_id </b> <br /> |
| − | <b> Result: </b> <br/> | + | <b> Result: </b> <br /> |
The result of the operation will be the withdrawal of funds from the primary user - an output transaction. And the transfer of money to the agency account is an input transaction. | The result of the operation will be the withdrawal of funds from the primary user - an output transaction. And the transfer of money to the agency account is an input transaction. | ||
Текущая версия на 14:47, 11 февраля 2019
Содержание
- 1 API authorization
- 2 Campaign Statistics
- 3 Statistics on sites in the advertiser's account
- 4 Change the multiplier for statistics on sites in the advertiser's account
- 5 Statistics on all campaign materials
- 6 Material statistics
- 7 Creating an advertising campaign
- 8 Editing ad campaigns
- 9 List of campaign advertising campaign
- 10 Archiving an advertising campaign
- 11 Receiving codes for CPA campaigns
- 12 Getting a list of categories for a given filter
- 13 Getting the list of ad formats
- 14 Getting the list of platforms
- 15 Getting Browser List
- 16 Getting a list of conversion notifications for the CPA
- 17 Getting a list of ages
- 18 Creating advertising agency clients
- 19 Editing advertising agency clients
- 20 Getting a list of advertising agency clients
- 21 Archiving advertising agency clients
- 22 Tying a client to an advertising agency
- 23 Detaching a client from an advertising agency
- 24 Customer account replenishment
- 25 Creating advertisements
- 26 Update ad data
- 27 Archiving advertisements
- 28 Getting a list of advertisements
- 29 Getting a list of banner sizes
- 30 Getting the list of countries
- 31 Getting a list of regions for a given filter
- 32 Get a list of available payment systems
- 33 Download media files
- 34 Get the current server time
- 35 Statistics for Webmasters
- 36 Money transfer for subsidiary accounts of the agency
API authorization
To access the API, you will need a user ID (app_id) and a signature (signature).
Calling different methods is carried out using queries on this template:
api.kadam.net?%action%.%method%?%params%
% action% - what are we turning to % method% - type of treatment get - get put - write post - update delete - delete % params% - request parameters required parameters% params% app_id - user id signature - signature
Example:
[GET] http://api.kadam.net/campaigns.get?app_id=%app_id%&signature=%signature%
or
[GET] http://api.kadam.net/campaigns?app_id=%app_id%&signature=%signature%
[GET] - http access method
Signature (signature) is created using a temporary token (access_token), which can be obtained using the app_id and secret key parameters.
Parameters app_id (user ID) and the key "secret key" are available on request to support.
Getting a token:
[GET] http://api.kadam.net/auth.token?app_id=%app_id%&secret_key=%key%
-> {“access_token”: “...”}
Generating signature for the [GET] method:
md5 ( %sort_params% . %access_token% )
%sort_params% - all parameters passed (except signature) are sorted by name
Example:
app_id=1&campaign_id=3…
[PUT] http://api.kadam.net/campaigns?signature=%signature%
+post fields -> %params%
Example for php. Getting a list of campaigns:
<?
$your_secret_key = "jqhwekq8734quo37o498q3p498qp34";
$your_app_id = 1;
$auth_url = "http://api.kadam.net/auth.token?app_id={$your_app_id}&secret_key={$your_secret_key}";
$auth = file_get_contents($auth_url);
$auth = json_decode($auth, true);
if ( !is_array( $auth ) || !isset( $auth['access_token'] ) ) {
die( 'something wrong! ' . print_r( $res, true ) );
}
$token = $auth['access_token'];
$params = array(
'client_id' => $your_app_id,
'app_id' => $your_app_id,
);
ksort( $params );
$result = array ();
foreach( $params as $key => $value ) {
$result[] = $key . '=' . urlencode( $value );
}
$params = implode( '&', $result );
$signature = md5( $params . $token );
$campaign_url = 'http://api.kadam.net/ads.campaigns.get?' . $params . '&signature=' . $signature;
$campaigns = file_get_contents($campaign_url);
$campaigns = json_decode($campaigns, true);
if ( !is_array( $campaigns ) || !isset( $campaigns['response'] ) ) {
die( 'something wrong! ' . print_r( $campaigns, true ) );
}
print_r($campaigns);
Campaign Statistics
To get campaign statistics, use the method ads.analytic.campaign.get
| Parameters | Values | Optional attributes |
|---|---|---|
| campaign_id | campaign's id | int (numeric value), required parameter |
| region_id | region's id: data.geo.regions.get | int (numeric value), required parameter |
| period | The way data is grouped by date:
day — daily statistics; month - monthly statistics Temporary restrictions are set by parameters date_from and date_to |
required parameter, string |
| date_from | The starting date of the statistics to display. Different date format is used for different parameter period values:
day: YYYY-MM-DD, example: 2011-09-27; month: YYYY-MM, example: 2011-09 |
required parameter, string |
| date_to | The final date of the displayed statistics. Different date format is used for different parameter period values:
day: YYYY-MM-DD, example: 2011-09-27; month: YYYY-MM, example: 2011-09 |
required parameter, string |
Result:
Returns an object with data
{
response: {
count: %total items%
items: {
shows
clicks
ctr
cpm
money
}
}
}
Statistics on sites in the advertiser's account
Statistics on sites in the advertiser's account means statistics on views and clicks on the site in the context of each campaign.
To get statistics on sites, use the ads.campaigns.statblock.get method (GET request)
| Parameters | Value | Additional attributes |
|---|---|---|
| date_from | Start date of the statistics output. | string, format YYYY-MM-DD (example: 2017-05-15), filter parameter |
| date_to | The end date of the statistics output. | string, format YYYY-MM-DD (example: 2017-05-15), filter parameter |
| campaign_id | campaign id | required parameter, int (numeric value), filter parameter |
| signature | Signature (generated using a time token, see above) | required parameter, string |
| app_id | user id | required parameter, int (numeric value) |
| macros | site id | int (numeric value), write parameter, filter option |
| leads | Leads | int (numeric value), write parameter, filter option |
| views | Views | int (numeric value), write parameter, filter option |
| clicks | Clicks | int (numeric value), write parameter, filter option |
| conversions | Confirmed Conversions | int (numeric value), write parameter, filter option |
| rejections | Failed Conversions | int (numeric value), write parameter, filter option |
| ctr | CTR | int (numeric value), write parameter, filter option |
| cpm | CPM | int (numeric value), write parameter, filter option |
| cpc | CPC | int (numeric value), write parameter, filter option |
| prelandvisit | Pre-landing Visits | int (numeric value), write parameter, filter option |
| prelanduseful | Pre-landing Useful visits | int (numeric value), write parameter, filter option |
| prelandscroll | Pre-landing Scroll | int (numeric value), write parameter, filter option |
Result:
Returns an object with data, example:
{
"response": {
"count": 1,
"items": [
{
"macros": "12345678901234",
"block": "1234",
"domain": "123456789",
"leads": "0",
"views": "123",
"clicks": "0",
"conversions": "0",
"rejections": "0",
"ctr": "0.0000",
"cpm": "0.00",
"cpc": null,
"moneyOut": "0.000000",
"moneyIn": null,
"prelandvisit": "0",
"prelanduseful": "0",
"prelandscroll": "0",
"landvisit": "0",
"landuseful": "0",
"landscroll": "0",
"multiplier": null,
"blackList": "0"
}
],
"request": {
"campaignId": 123456,
"limit": 10,
"offset": 0
}
}
}
Sorting
Sort Ascending
sort = {parameter}
Example: api.kadam.net?sort=views
Sort descending
sort = - {parameter}
Example: api.kadam.net?sort=-views
Sort by several parameters
sort = {parameter1}, - {parameter2}, {parameter3}
Example: api.kadam.net?sort=views,-clicks,leads
Filtration
{parameter} = {value}
Examples:
api.kadam.net?attr=10
api.kadam.net?attr=string
api.kadam.net?attr=string&date_from=01.05.2016&date_to=01.07.2016
Change the multiplier for statistics on sites in the advertiser's account
To change the multiplier for site statistics, use the ads.campaigns.statblock method (PUT request)
Parameters (all are required):
- app_id - user id, numeric value (int)
- signature - signature, string (string)
- campaign_id - campaign id, numeric value (int)
- block - a numeric value (int)
- domain - numeric value (int)
- multiplier - new multiplier value, numeric value (float)
- multiplierOld - old multiplier value, numeric value (float)
- macros - pad id, numeric value (int)
The block and macros parameters in the account are not displayed, they can be obtained through the method described in the paragraph "Statistics by sites in the advertiser's account".
Statistics on all campaign materials
To get statistics on all campaign materials, use the ads.analytic.materials.get method
| Parameters | Value | Additional attributes |
|---|---|---|
| campaign_id | campaign id | int (numeric value), required parameter |
| period | Method for grouping data by date:
1. day - statistics by day; 2. month - statistics by months; Temporary restrictions are set by date_from and date_to parameters |
required parameter, string |
| date_from | The starting date of the displayed statistics. Different date format is used for different values of the period parameter:
1. day: YYYY-MM-DD, Example: 2011-09-27 2. month: YYYY-MM, example: 2011-09 |
required parameter, string |
| date_to | End date of output statistics. Different date format is used for different values of the period parameter:
1. day: YYYY-MM-DD, Example: 2011-09-27 2. month: YYYY-MM, example: 2011-09 |
required parameter, string |
Result:
Returns an object with data
{
response: {
count:% total items%
items: {
teaser_id
date
shows
clicks
ctr
cpm
money
}
}
}
Material statistics
For statistics on the material, use the method ads.analytic.material.get
| Parameters | Value | Additional attributes |
|---|---|---|
| material_id | material id | int (numeric value), required parameter |
| period | Method for grouping data by date:
1. day - statistics by day; 2. month - statistics by months; Temporary restrictions are set by date_from and date_to parameters |
required parameter, string |
| date_from | The starting date of the displayed statistics. Different date format is used for different values of the period parameter:
1. day: YYYY-MM-DD, Example: 2011-09-27 2. month: YYYY-MM, example: 2011-09 |
required parameter, string |
| date_to | End date of output statistics. Different date format is used for different values of the period parameter:
1. day: YYYY-MM-DD, Example: 2011-09-27 2. month: YYYY-MM, example: 2011-09 |
required parameter, string |
Result:
Returns an object with data
{
response: {
count:% total items%
items: {
date
shows
clicks
ctr
cpm
money
}
}
}
Creating an advertising campaign
To create a new advertising campaign, use the ads.campaigns.put
method
The number of campaigns created with a single request is 50.
| Parameters | Value | Additional attributes |
|---|---|---|
| data </td> | a serialized JSON array of objects describing the campaigns being created. See the client_specification object description below. | required parameter, string |
| client_specification | ||
| app_id | user id | required parameter, int (numeric value) |
| client_id | id of the client in whose advertising account the campaign will be created. It can also take the value app_id (itself) | required parameter, int (numeric value) |
| ad_format | Ad Format:
10 - Teaser; 20 - Banner; 30 - Push Notifications; 40 - Clickunder; 60 - Contextual |
required parameter, int (numeric value) |
| cost_type | Payment method:
0 - CPC; 1 - CPA; 2 - CPM |
required parameter, int (numeric value) |
| name | campaign name | required parameter, string |
| Link_url | link to the advertised object in the format: http: //yoursite.cоm | required parameter, string |
| real_url | link to the real domain of the advertised object in the format: http: //yoursite.cоm | required parameter, string |
| sex | Gender:
3 - any; 2 - male; 1 - female |
required parameter, int (numeric value) |
| age | The age of the target audience. Age category number from 1 to 6 (up to 17, 18-25, 26-34, 35-49, 50-60, over 61) | required parameter, a sequence of numbers separated by a comma |
| regions | Regions, from 1 to 10 (1 - Russia, 2 - Ukraine, etc.) | required parameter, a sequence of numbers separated by a comma |
| cpa_mode | Type of conversion notifications for CPA: /ads.targeting.modes.get | int (numeric value), mandatory for CPA campaigns |
| categories | category IDs: /data.categories.get?ad_format =%
|
array [category_id => cost] |
| tags | keyword targeting | required parameter, a sequence of keywords separated by a comma: [“key1”, “key2”, .., “keyN”] Keywords with price. Only for payment - for clicks or for views: {“key1”: “cost”, “key2”: “cost”, .., “keyN”: “cost”} cost - float example: "data [tags] [qwerty]: 1" is the qwerty keyword with a 1rub rate. |
| day_limit | Daily limit in rubles. For all types except clickunder | positive number |
| all_limit | Total limit in rubles. For all types except clickunder | positive number |
| click_limit | Maximum count. transitions per day. For all types except clickunder. For views and clicks. | positive number |
| conversion_limit | Maximum count. conversions per day. For all types except clickunder. Only for CPA | positive number |
| adult_content | presence of adult content in the advertising campaign:
0 - No; 1 - Yes |
optional parameter, int (numeric value), default 0 |
| adult_site | Display campaign ads on adult content sites:
0 - No; 1 - Yes |
optional parameter, int (numeric value), default 0 |
| time_show | Time Targeting:
& nbsp; & nbsp; * - display in any hours and days of the week & nbsp; & nbsp; {} is an array, where the key is the name of the day of the week ["Sn", "Mn", "Tu", "Wd", "Th", "Fr", "Sa"]: & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; {} - ‘mn’: ‘*’ - all watches are weekly & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; {} - ‘mn’: [0, .., 23] - hours, separated by commas |
optional parameter, * default |
| platforms | platform targeting: /data.platforms | comma separated numbers |
| browsers | browser targeting: /data.browsers | comma separated numbers |
| black_list | black list of sites where ads will not be shown | comma separated site ID number sequence |
| white_list | white list of sites where ads will not be shown | comma separated site ID number sequence |
| black_list_ip | ip lock | sequence of ip addresses separated by a comma or an array |
| unique_day_count | frequency of material shown to one user (times) | positive number |
| unique_days | frequency of advertising material shown to one user (days) | positive number |
Result:
Returns an array of responses to queries in the data array. The corresponding object in the output array contains the id of the created campaign, and the error_code and error_desc fields in case of an error.
Errors:
102 - unknown client 103 - overlimit campaigns
Editing ad campaigns
To edit ad campaigns, use the ads.campaigns.update
method
The maximum number of campaigns edited with a single query is 50.
Version log: 1.0.1 - added status parameter
| Parameters | Value | Additional attributes |
|---|---|---|
| data </td> | is a serialized JSON array of objects describing changes in campaigns. Object descriptions client_mod_specification see below. | required parameter, string |
| client_specification | ||
| campaign_id | id of the edited campaign | required parameter, positive number |
| name | campaign name | optional parameter, a string between 3 and 60 characters |
| link_url | link to the advertised object in the format http: //yoursite.com | optional parameter, string |
| real_url | link to the real domain of the advertised object in the format: http: //yoursite.cоm | optional parameter, string |
| sex | Gender:
3 - any; 2 - male; 1 - female |
optional parameter, int (numeric value) |
| age | age: /data.ages | optional parameter, int (numeric value) |
| categories | category IDs:
/data.categories.get?ad_format =% category_id: {region_id: cost} |
optional parameter |
| tags | keyword targeting | optional parameter, comma separated keyword sequence |
| day_limit | daily limit in rubles. for all types except clickunder | optional parameter, positive number |
| adult_content | presence of adult content in the advertising campaign:
0 - No; 1 - Yes |
optional parameter, int (numeric value), default 0 |
| adult_site | display campaign ads on adult content sites:
0 - No; 1 - Yes |
optional parameter, int (numeric value), default 0 |
| time_show | Time Targeting:
& nbsp; & nbsp; * - display in any hours and days of the week & nbsp; & nbsp; {} is an array, where the key is the name of the day of the week ["Sn", "Mn", "Tu", "Wd", "Th", "Fr", "Sa"]: & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; {} - ‘mn’: ‘*’ - all watches are weekly & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; {} - ‘mn’: [0, .., 23] - hours, separated by commas |
optional parameter, * default |
| platforms | platform targeting: /data.platforms | comma separated numbers |
| browsers | browser targeting: /data.browsers | comma separated numbers |
| black_list | black list of sites where ads will not be shown | comma separated site ID number sequence |
| white_list | white list of sites where ads will not be shown | comma separated site ID number sequence |
| black_list_ip | ip lock | sequence of ip addresses separated by a comma or an array |
| status | start /pause campaign:
0 - suspended; 1 - running |
optional parameter, int (numeric value), default 1 |
Result:
Returns an array of responses to each request in the data array. The corresponding object in the output array contains the id of the client being changed and, in case of an error, the error_code and error_desc fields.
Errors:
100 - unknown campaign 102 - unknown client
List of campaign advertising campaign
To get a list of campaign advertising campaigns use the method ads.campaigns.get
| Parameters | Value | Additional attributes |
|---|---|---|
| client_id | Client ID from which ad campaigns are requested | int (numeric value) |
| include_archive | A flag that specifies whether to display archived ads:
0 - show only active campaigns; 1 - show all campaigns |
Flag, can be 1 or 0 |
| campaign_ids | Filter for displayed ad campaigns.
Serialized JSON array containing campaign id. Only campaigns that are present in the campaign_ids and are campaigns of the specified advertising cabinet will be displayed. If the parameter is null, then all campaigns will be displayed. |
String |
| with_bwlist | Black and white list transfer flag | any value (for example 1) |
| with_tags | Keyword Transfer Flag | any value (for example 1) |
| limit | limit on the number of campaigns returned. Used only if the campaign_ids parameter is null | int (numeric value) |
| offset | offset. Used in the same cases as the limit parameter | int (numeric value) |
Result:
Returns an array of campaign objects, each of which contains the following fields:
response: {
count:% total%
items: [{
id - campaign identifier
name - campaign name
status - campaign status (0 - campaign stopped, 1 - campaign started, 2 - campaign deleted)
day_limit - campaign daily limit in rubles (0 - no limit is set)
all_limit - total campaign limit in rubles (0 - no limit is set)
ad_format - ad format
cost_type - payment type
link_url - link to the advertised object
sex
age - age
regions - region identifiers
categories - category identifiers.
adult_content - the presence of adult content
adult_site - display campaign ads on adult content sites
tags - keywords
bw_list - black and white list
}, ..]
}
Errors:
102 - unknown client
Archiving an advertising campaign
To archive an advertising campaign, use the ads.campaigns.delete
method
The maximum number of clients edited with a single query is 10.
| Parameters | Value | Additional attributes |
|---|---|---|
| ids | Campaign id list separated by comma or array with id campaigns.
For example: “id1, id2, ..., idn“ or [id1, id2, ..., idn] |
required parameter, string |
Result:
Returns an array of responses to each request. Each answer is either 0, which means successful deletion, or an error array.
Errors:
100 - unknown campaign 101 - campaign already archive 102 - unknown client
Receiving codes for CPA campaigns
Use the ads.campaigns.cpa.mode.get
method to get the codes for the CPA campaigns
| Parameters | Value | Additional attributes |
|---|---|---|
| campaign_id | campaign id | int (numeric value), required parameter |
Result:
Returns an object with data.
{
response: {
url:% url%
}
}
Getting a list of categories for a given filter
To return the list of categories for a given filter, use the ads.campaigns.categories.get
method
| Parameters | Value | Additional attributes |
|---|---|---|
| ad_format | ad format:
ads.campaigns.foarmats.get |
required parameter, int (numeric value) |
| category_id | category id. limits displaying only by category id | optional parameter, int (numeric value) |
Result:
Returns an array of responses to queries in the response array.
response: {
count:% total%
items: [{
% category_id%: {
% region_id%: {
min:% min_cost%
max:% max_cost%
}
}
}, ..]
}
Getting the list of ad formats
Use the ads.campaigns.formats.get
method to get the list of ad formats.
Result:
Returns an array of responses to queries in the response array.
response: {
count:% total%
items: [{
id:% format_id%
title: ‘% format title%’
}, ..]
}
Getting the list of platforms
For a list of platforms, use the ads.targeting.platforms.get
method
Result:
Returns an array of responses to queries in the response array.
response: {
count:%
items: [{
id:% platform_id%
title:% platform_name%,
mobile:% is mobile%
}, ..]
}
Getting Browser List
For a list of browsers, use the ads.targeting.browsers.get
method
Result:
Returns an array of responses to queries in the response array.
response: {
count:%
items: [{
id:% browser_id%,
title:% browser_name%,
}, ..]
}
Getting a list of conversion notifications for the CPA
To get a list of conversion notifications for CPA, use the ads.targeting.cpa.modes.get
method
Result:
Returns an array of responses to queries in the response array.
response: {
count:% total%
items: [{
id:% mode_id%
title: ‘% mode title%’
}, ..]
}
Getting a list of ages
To get the list of views, use the ads.targeting.ages.get
method
Result:
Returns an array of responses to queries in the response array.
response: {
count:%
items: [{
id:% age_id%
title:% age_name%
}, ..]
}
Creating advertising agency clients
To create ad agency clients, use the ads.clients.put method
The allowable number of clients created with a single request is 50.
| Parameters | Value | Additional attributes |
|---|---|---|
| data </td> | a serialized JSON array of objects describing the campaigns being created. See the client_specification object description below. | required parameter, string |
| client_specification | ||
| name | client name | string from 3 to 60 characters, required parameter |
| day_limit | daily limit in rubles | int (numeric value) |
Result:
Returns an array of responses to queries in the data array. The corresponding object in the output array contains the client information or the error array in case of an error (for each client separately).
{
client_id - client identifier;
name - the name of the client;
day_limit - client's daily limit in rubles;
}
Editing advertising agency clients
To edit ad agency clients, use the ads.clients.update method
The maximum number of clients edited with a single query is 50.
| Parameters | Value | Additional attributes |
|---|---|---|
| data </td> | is a serialized JSON array of objects describing changes in clients. Description of client_mod_specification objects see below. | required parameter, string |
| client_mod_specification | ||
| client_id | ID of the client being edited | required parameter, positive number |
| name | client name | a string between 3 and 60 characters |
| day_limit | daily limit in rubles | positive number |
Result:
Returns an array of responses to each request in the data array. The corresponding object in the output array contains the id of the client being changed and, in case of an error, the error_code and error_desc fields.
Getting a list of advertising agency clients
To return the list of clients of an advertising agency, use the ads.clients.get method
| Parameters | Value | Additional attributes |
|---|---|---|
| client_ids | A list of client ids separated by commas. For example: “id1, id2, ..., idn“ | optional parameter, string |
Result:
Returns an array of client objects of the agency, each of which contains the following fields:
response: {
count:% total%
items: [{
client_id - client identifier;
name - the name of the client;
day_limit - client's daily limit in rubles;
balance - client's balance
}, ..]
}
Archiving advertising agency clients
For archiving ad agency clients, use the ads.clients.delete method
| Parameters | Value | Additional attributes |
|---|---|---|
| ids | List of clients' id by comma or array with id clients.
For example: “id1, id2, ..., idn“ or [id1, id2, ..., idn] |
required parameter, string |
Result:
Returns an array of responses to each request. Each answer is either 0, which means successful deletion, or an error array.
Tying a client to an advertising agency
To bind a client to an advertising agency, use the ads.clients.bind.put method
| Parameters | Value | Additional attributes |
|---|---|---|
| client email address | string from 3 to 60 characters, required parameter | |
| password | client password (from account) | string from 3 to 60 characters, required parameter |
Result:
Returns:
{
“Bind”: true
}
in case of success. Or error in case of an error.
Detaching a client from an advertising agency
To detach a client from an advertising agency, use the ads.clients.unbind.put method
| Parameters | Value | Additional attributes |
|---|---|---|
| client_id | client id | int (numeric value) |
Result:
Returns:
{
“Unbind”: true
}
in case of success. Or error in case of an error.
Customer account replenishment
To replenish the client’s account, use the ads.clients.balance.put method
| Parameters | Value | Additional attributes |
|---|---|---|
| client_id | customer id to replenish | int (numeric value), required parameter |
| sum | rubles in rubles | int (numeric value) |
| back_url | url where the recharge system forwards the client | string (string) |
| system_id | replenishment system id:
data.balance.systems.get |
int (numeric value), required parameter |
Result:
Returns the url for payment:
{
response: {
url:% url%
}
}
Creating advertisements
To create ads using the method ads.materials.put
The maximum allowable number of ads generated by a single request is 20.
| Parameters | Value | Additional attributes |
|---|---|---|
| data </td> | is a serialized JSON array of objects describing the created ads. The description of ad_specification objects is given below. | required parameter, string |
| ad_specification | ||
| campaign_id | id of the campaign in which the ad will be created | required parameter, int (numeric value) |
| title | ad title | required parameter |
| text | ad description | Required |
| link_url | link of the advertised object in the format: http: //yoursite.com | |
| link_media | previously loaded media object (jpg, gif):
data.upload.media |
|
| pause_after_moderate | pause posting moderation | |
| size | for banners only:
ads.materials.banner.sizes |
|
| categories | Stacks by category, similar to campaigns:
array [category_id => cost] |
Not required if you do not set bids from campaign categories |
Update ad data
Use the ads.materials.update
method to update ad data.
The maximum allowable number of ads generated by a single request is 20.
| Parameters | Value | Additional attributes |
|---|---|---|
| data </td> | is a serialized JSON array of objects describing the created ads. The ad_specification object description is below. | required parameter, string |
| ad_specification | ||
| material_id | ad id | required parameter, int (numeric value) |
| status | start /pause material:
0 - suspended; 1 - running |
optional parameter, int (numeric value), default 1 |
Archiving advertisements
For advertising ads using the method ads.materials.delete
The maximum number of clients edited with a single query is 50.
| Parameters | Value | Additional attributes |
|---|---|---|
| account_id | advertising account ID | required parameter, int (numeric value) |
| ids | serialized JSON array containing ad IDs | required parameter, string |
Result:
Returns an array of responses to each request. Each answer is either 0, which means successful deletion, or an error array.
Getting a list of advertisements
Use the ads.materials.get method to get the list of ads.
| Parameters | Value | Additional attributes |
|---|---|---|
| account_id | advertising account ID | required parameter, int (numeric value) |
| client_id | For advertising agencies. Client ID from which advertisements are requested. | int (numeric value) |
| archive | A flag that specifies whether to display archived ads:
0 - display only active ads; 1 - display all ads |
Flag, can be 1 or 0 |
| campaign_ids | ad campaign filter.
Serialized JSON array containing campaign id. If the parameter is null, advertisements of all campaigns will be displayed. |
string |
| material_ids | ad campaign filter.
Serialized JSON array containing ad id. If the parameter is null, all advertisements will be displayed. |
string |
| limit | limit on the number of ads returned. Used only if the ad_ids parameter is null, and the campaign_ids parameter contains the id of only one campaign. | int (numeric value) |
| offset | offset. Used in the same cases as the limit parameter | int (numeric value) |
| ad_format | ad format: ads.campaigns.formats.get | required parameter, int (numeric value) |
Result:
Returns an array of ad objects, each of which contains the following fields:
- id - ad id
- name - the name of the ad
- campaign_id - Campaign ID
- link_url
- arhive
- ad_format - ad format
- cost_type - payment type
- all_limit - total ad limit in rubles
- 0 - no limit is set
- status - ad status:
- 0 - ad stopped;
- 1 - the ad is running;
- 2 - ad deleted
- approved - ad moderation status:
- 0 - the ad is awaiting moderation;
- 10 - Ad has been approved.
- 20 - ad disapproved
Getting a list of banner sizes
For a list of banner sizes, use the ads.materials.banner.sizes.get
method
Result:
Returns an array of responses to requests in the response array:
response: {
count:% total%
items: [{
id:% banner_id%,
title: ‘% banner title%’
}, ..]
}
Getting the list of countries
To get the list of countries, use the data.geo.countries.get
method
Result:
Returns an array of responses to requests in the response array:
response: {
count:%
items: [{
id:% country_id%,
title:% country_name%
}, ..]
}
Getting a list of regions for a given filter
To get a list of regions for a given filter, use the data.geo.regions.get
method
| Parameters | Value | Additional attributes |
|---|---|---|
| country_id | country identifier obtained in the ads.geo.countries method | positive number, required parameter |
Result:
Returns an array of responses to requests in the response array:
response: {
count:%
items: [{
id:% region_id%
title:% region_name%
}, ..]
}
Get a list of available payment systems
To get a list of available payment systems, use the data.balance.systems.get
method
Result:
Returns an array of responses to requests in the response array:
response: {
count:% total%
items: [{
id:% pay_system_id%,
title: pay% pay system title% ’
}, ..]
}
Download media files
To upload media files (jpg, png, gif), use the data.upload.media.update
method
| Parameters | Value | Additional attributes |
|---|---|---|
| ad_format | ad format: /ads.formats.get | int (numeric value) |
| file | CURLFile object |
Result:
Returns an array with a reference to the target object or error in case of an error.
response: {
image: “% link%”
}
An example of sending a file using curl in php:
$ token = ‘received token’; $ ad_format = объявления ad format ’; $ app_id = ‘your app id’; $ file = '@ /full path to file';
$ finfo = finfo_open (FILEINFO_MIME_TYPE); $ finfo = finfo_file ($ finfo, $ link); $ cFile = new \ CURLFile ($ link, $ finfo, basename ($ link));
$ post = array ('file' => $ cFile, 'ad_format' => $ ad_format, 'app_id' => $ app_id);
$ ignoreParams = array ('file'); //file field is not involved in the construction of the signature
ksort ($ post);
$ result = array ();
foreach ($ post as $ key => $ value) {
if (false == in_array ($ key, $ ignoreParams)) {
$ result [] = $ key. '='. urlencode ($ value);
}
}
$ result = implode ('&', $ result);
$ signature = md5 ($ result. $ token);
$ target_url = 'http://api.kadam.net/data.upload.media?signature='. $ signature;
$ ch = curl_init (); curl_setopt ($ ch, CURLOPT_URL, $ target_url); curl_setopt ($ ch, CURLOPT_POST, true); curl_setopt ($ ch, CURLOPT_POSTFIELDS, $ post); curl_setopt ($ ch, CURLOPT_RETURNTRANSFER, 1);
$ result = curl_exec ($ ch); //server response
Get the current server time
To get the current server time in ISO 8601 format, use the server.time.get
method
Result:
Returns an array of responses to requests in the response array:
{
iso8601:% time%
}
Statistics for Webmasters
For statistics on webmasters use the method webmaster.reports.report.get
| Parameters | Value | Additional attributes |
|---|---|---|
| secret | Access key for webmasters (mandatory) | Available on demand |
| date_from | Start of Period | a string of the form "YYYY-MM-DD" is an optional parameter; if absent, the current date will be taken |
| date_to | End of Period | a string of the form "YYYY-MM-DD" is an optional parameter; if absent, the current date will be taken |
Maximum unloading period 1 month
Result:
- blockviews - Block Views
- moneyin - Earned money
Returns data as
Array ( [responce] => Array ( [2017-11-10] => Array ( [blockviews] => 300 [moneyin] => 100.00 ) ) )
Money transfer for subsidiary accounts of the agency
To transfer money, use the ads.clients.balance.update method
| Parameters | Value | Additional attributes |
|---|---|---|
| client_id | Customer ID, money will be transferred to it. | Required |
| sum | transfer amount | Required |
| type | Operation Type | Required - always type = "transfer" |
| comment | Comment | Required - null value allowed |
The operation can be performed only if there are sufficient funds on the account
Money will be withdrawn from the user specified in the app_id
Result:
The result of the operation will be the withdrawal of funds from the primary user - an output transaction. And the transfer of money to the agency account is an input transaction.
Returns data as
Array ( [status] => "success" )
In case of error - error code
