rotators
Format:
GET /api/rest/webmaster/xml/rotators?start=<int>&limit=<int>
Descritption:
Returns info about banner's rotators
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | start | | | |
int | limit | | | |
Response:
- <getRotatorsResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <items>
- <item>
- <id>int</id>
- <name>string</name>
- <subaccount>string</subaccount>
- <added_at>dateTime</added_at>
- <type></type>
- <offers_included>
- <item>
- <id>int</id>
- <name>string</name>
</item>
</offers_included> - <offers_excluded>
- <item>
- <id>int</id>
- <name>string</name>
</item>
</offers_excluded> - <add_new_offers></add_new_offers>
- <banner_sizes>
</banner_sizes>
<category_included>- <item>
- <id>int</id>
- <name>string</name>
</item></category_included>
<category_excluded>- <item>
- <id>int</id>
- <name>string</name>
</item></category_excluded>
<banners_included>- <item>
- <id>int</id>
- <name>string</name>
</item></banners_included>
<banners_excluded>- <item>
- <id>int</id>
- <name>string</name>
</item></banners_excluded>
<enable_optimization></enable_optimization><code>- <item>
- <value>string</value>
- <type>
JS_CODE|JS_CODE_ASYNC|XML_FEED|
</type>
</item></code></item></items></data></getRotatorsResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/rotators?remote_auth=6420072d37bf14f1df182d0fe0efa2d9rotator
Format:
GET /api/rest/webmaster/xml/rotator/{id}
Descritption:
Returns info about banner's rotator
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | id | | | |
Response:
- <getRotatorResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <id>int</id>
- <name>string</name>
- <subaccount>string</subaccount>
- <added_at>dateTime</added_at>
- <type></type>
- <offers_included>
- <item>
- <id>int</id>
- <name>string</name>
</item>
</offers_included> - <offers_excluded>
- <item>
- <id>int</id>
- <name>string</name>
</item>
</offers_excluded>
<add_new_offers></add_new_offers><banner_sizes></banner_sizes>
<category_included>- <item>
- <id>int</id>
- <name>string</name>
</item></category_included>
<category_excluded>- <item>
- <id>int</id>
- <name>string</name>
</item></category_excluded>
<banners_included>- <item>
- <id>int</id>
- <name>string</name>
</item></banners_included>
<banners_excluded>- <item>
- <id>int</id>
- <name>string</name>
</item></banners_excluded>
<enable_optimization></enable_optimization><code>- <item>
- <value>string</value>
- <type>
JS_CODE|JS_CODE_ASYNC|XML_FEED|
</type>
</item></code></data></getRotatorResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/rotator?remote_auth=6420072d37bf14f1df182d0fe0efa2d9rotator
Format:
PUT /api/rest/webmaster/xml/rotator
Descritption:
Change properties of banner rotator
XML PUT-request:
- <setRotatorRequestData>
- <id>int</id>
- <name>string</name>
- <subaccount>string</subaccount>
- <type></type>
- <offers_included>
</offers_included> - <offers_excluded>
</offers_excluded>
<add_new_offers></add_new_offers><banner_sizes></banner_sizes>
<category_included></category_included>
<category_excluded></category_excluded>
<banners_included></banners_included>
<banners_excluded></banners_excluded>
<enable_optimization></enable_optimization></setRotatorRequestData>
Response:
- <setRotatorResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
</setRotatorResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/rotator?remote_auth=6420072d37bf14f1df182d0fe0efa2d9rotator
Format:
POST /api/rest/webmaster/xml/rotator
Descritption:
Create banner rotator
XML POST-request:
- <createRotatorRequestData>
- <name>string</name>
- <subaccount>string</subaccount>
- <type></type>
- <offers_included>
</offers_included> - <offers_excluded>
</offers_excluded>
<add_new_offers></add_new_offers><banner_sizes></banner_sizes>
<category_included></category_included>
<category_excluded></category_excluded>
<banners_included></banners_included>
<banners_excluded></banners_excluded>
<enable_optimization></enable_optimization></createRotatorRequestData>
Response:
- <createRotatorResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
</data>
</createRotatorResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/rotator?remote_auth=6420072d37bf14f1df182d0fe0efa2d9postback-list
Format:
GET /api/rest/webmaster/xml/postback-list?start=<int>&limit=<int>&term=<string>
Descritption:
Returns list of conversion postback
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | start | | | |
int | limit | | | |
string | term | | | |
Response:
- <getPostbacksResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <item>
- <id>int</id>
- <name>string</name>
- <url>string</url>
- <action_type></action_type>
- <request_type>
post|get|google_upload_offline_conversion|microsoft|facebook|
</request_type> - <status></status>
- <comment>string</comment>
- <query_params>
- <item>
- <name>string</name>
- <value>string</value>
</item>
</query_params> - <offers_included>
</offers_included>
</item>
</data>
</getPostbacksResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/postback-list?remote_auth=6420072d37bf14f1df182d0fe0efa2d9postback
Format:
GET /api/rest/webmaster/xml/postback?id=<int>
Descritption:
Returns list of conversion postback
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | id | | | |
Response:
- <getPostbackResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <id>int</id>
- <name>string</name>
- <url>string</url>
- <action_type></action_type>
- <request_type>
post|get|google_upload_offline_conversion|microsoft|facebook|
</request_type> - <status></status>
- <comment>string</comment>
- <query_params>
- <item>
- <name>string</name>
- <value>string</value>
</item>
</query_params> - <offers_included>
</offers_included>
</data>
</getPostbackResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/postback?remote_auth=6420072d37bf14f1df182d0fe0efa2d9postback
Format:
PUT /api/rest/webmaster/xml/postback
Descritption:
Change conversion postback
XML PUT-request:
- <setPostbackRequestData>
- <id>int</id>
- <name>string <!--Postback title--></name>
- <url>string <!--Postback URL--></url>
- <action_type></action_type>
- <request_type>
post|get|google_upload_offline_conversion|microsoft|facebook|
</request_type> - <query_params> <!--Allowed string that match by regexp /^[a-z0-9_]+$/i-->
- <offer_id>string</offer_id>
- <offer_name>string</offer_name>
- <wp_id>string</wp_id>
- <wp_name>string</wp_name>
- <site>string</site>
- <subaccount>string</subaccount>
- <action_type>string</action_type>
- <target_id>string</target_id>
- <target_name>string</target_name>
- <payout_id>string</payout_id>
- <payout>string</payout>
- <payout_currency>string</payout_currency>
- <click_id>string</click_id>
- <click_time>string</click_time>
- <event_time>string</event_time>
- <conversion_time>string</conversion_time>
- <ip>string</ip>
- <country>string</country>
- <city>string</city>
- <ua>string</ua>
- <user_browser>string</user_browser>
- <user_os>string</user_os>
- <user_device>string</user_device>
- <cpl_id>string</cpl_id>
- <open_commission>string</open_commission>
- <order_amount>string</order_amount>
- <status>string</status>
</query_params> - <offers_included> <!--List of included offers (if you put empty list then current included offers will be removed from this postback. If array contains 0 then all available offers will included-->
</offers_included></setPostbackRequestData>
Response:
- <setPostbackResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
</setPostbackResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/postback?remote_auth=6420072d37bf14f1df182d0fe0efa2d9postback
Format:
POST /api/rest/webmaster/xml/postback
Descritption:
Create conversion postback
XML POST-request:
- <createPostbackRequestData>
- <name>string <!--Postback title--></name>
- <url>string <!--Postback URL--></url>
- <action_type></action_type>
- <request_type>
post|get|google_upload_offline_conversion|microsoft|facebook|
</request_type> - <query_params> <!--Allowed string that match by regexp /^[a-z0-9_]+$/i-->
- <offer_id>string</offer_id>
- <offer_name>string</offer_name>
- <wp_id>string</wp_id>
- <wp_name>string</wp_name>
- <site>string</site>
- <subaccount>string</subaccount>
- <action_type>string</action_type>
- <target_id>string</target_id>
- <target_name>string</target_name>
- <payout_id>string</payout_id>
- <payout>string</payout>
- <payout_currency>string</payout_currency>
- <click_id>string</click_id>
- <click_time>string</click_time>
- <event_time>string</event_time>
- <conversion_time>string</conversion_time>
- <ip>string</ip>
- <country>string</country>
- <city>string</city>
- <ua>string</ua>
- <user_browser>string</user_browser>
- <user_os>string</user_os>
- <user_device>string</user_device>
- <cpl_id>string</cpl_id>
- <open_commission>string</open_commission>
- <order_amount>string</order_amount>
- <status>string</status>
</query_params> - <offers_included> <!--List of included offers (if you put empty list then current included offers will be removed from this postback. If array contains 0 then all available offers will included-->
</offers_included></createPostbackRequestData>
Response:
- <createPostbackResponseData>
- <status></status>
- <error>string</error>
- <request_id>int</request_id>
</data>
</createPostbackResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/postback?remote_auth=6420072d37bf14f1df182d0fe0efa2d9