Содержание

PUT user-language

GET statistics

POST textshift

PUT textshift

Описание методов API

user-language

Формат:

PUT /api/rest/webmaster/xml/user-language

Описание:

Входной PUT-запрос в формате XML:

• <setUserLanguageRequestData>
  • <lang>
    en|br|ru|
    </lang>
  </setUserLanguageRequestData>

Ответ:

• <setUserLanguageResponseData>
  • <status>int</status>
  • <error>string</error>
  • <request_id>int</request_id>
  • <data>boolean</data>
  </setUserLanguageResponseData>

Пример:

http://cityads.com/api/rest/webmaster/xml/user-language?remote_auth=6420072d37bf14f1df182d0fe0efa2d9

statistics

Формат:

GET /api/rest/webmaster/xml/statistics/{group_field}/{date_from}/{date_to}?sub_group=<enum>&date_type=<enum>&start=<int>&limit=<int>&q=<string>&request_id=<int>

Описание:

Входные параметры:

Тип:	Имя:	Описание:	Допустимые значения:	Обязательное:
enum	group_field	Офферы action_id Типы офферов type_offers Вертикали category_lvl_1 Категории category_lvl_2 Подкатегории category_lvl_3 Офферы segment_offer Типы конверсий type_actions Методы оплаты payment_method_id Часы event_time_hour Дни event_time_day Недели event_time_week Месяцы event_time_month Кварталы event_time_quarter Годы event_time_year Сезоны seasons Время суток daytime Выходные и будни weekends Дни недели weekdays Типы tools2 Категория промо promo_category Формат кода code_type Тип ссылки link_type Тип размера баннера size_type Размер баннера promo_size Типы points_types Лэндинги points_landings Целевые страницы target_pages Товары points_products Промо акции points_promo_events Типы typesources Реферреры referrers Субаккаунты subaccount Ключевые слова keyword_se Язык language Страны country Регионы area Города city Часовые пояса timezones Новые и вернувшиеся new_user Браузер browser_type Версия браузера browser_version Операционная система os_type Версия операционнай системы os_version Разрешение экрана resolution Цвета экрана color Типы устройств device_type_id Модели устройств device_id	action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, segment_offer, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, points_products, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, timezones, new_user, browser_type, browser_version, os_type, os_version, resolution, color, device_type_id, device_id
date	date_from	дата начала периода просмотра отчета
date	date_to	дата окончания периода просмотра отчета
enum	sub_group	дополнительный параметр, по которому необходимо сделать группировку	action_id, type_offers, category_lvl_1, category_lvl_2, category_lvl_3, type_actions, payment_method_id, tools2, promo_category, code_type, link_type, size_type, promo_size, points_types, points_landings, target_pages, points_products, points_promo_events, typesources, referrers, subaccount, subaccount2, subaccount3, subaccount4, subaccount5, keyword_se, language, country, area, city, timezones, new_user, browser_type, browser_version, os_type, os_version, resolution, color, device_type_id, device_id
enum	date_type	Дата совершения конверсии conversion Дата прогрузки данных order_upload	conversion, order_upload
int	start	номер первого элемента. По умолчанию 0
int	limit	количество элементов на странице. По умолчанию 50, но не более 1000
string	q	строка поиска по ключевому слову в основном параметре
int	request_id	номер запроса

Ответ:

• <getStatisticsResponseData>
  • <status>
    200|204|400|403|500|
    </status>
  • <error>string</error>
  • <request_id>int</request_id>
  • <data>
    • <total>int</total>
    • <time_zone_api_stat>string</time_zone_api_stat>
    • <items>
      • <item>
        • <actionID>string <!--id оффера--></actionID>
        • <actionName>string <!--название оффера--></actionName>
        • <typeOffers>string <!--offer type--></typeOffers>
        • <categoryLvl1>string <!--категория 1 уровня--></categoryLvl1>
        • <categoryLvl2>string <!--категория 2 уровня--></categoryLvl2>
        • <categoryLvl3>string <!--категория 3 уровня--></categoryLvl3>
        • <categoryId>string <!--категория--></categoryId>
        • <isSale>string <!--тип действия (действие или продажа)--></isSale>
        • <paymentMethod>string <!--способ оплаты--></paymentMethod>
        • <language>string <!--язык пользователя--></language>
        • <timezone>string <!--часовой пояс пользователя--></timezone>
        • <commonwealth>string <!--содружество пользователя--></commonwealth>
        • <country>string <!--страна пользователя--></country>
        • <area>string <!--регион пользователя--></area>
        • <city>string <!--город пользователя--></city>
        • <newUser>string <!--тип посетителя--></newUser>
        • <browser>string <!--броузер пользователя--></browser>
        • <os>string <!--операционная система пользователя--></os>
        • <keyword>string <!--ключевое слово--></keyword>
        • <deviceTypeName>string <!--тип устройства--></deviceTypeName>
        • <deviceName>string <!--устройство--></deviceName>
        • <promoEngineName>string <!--название инструмента--></promoEngineName>
        • <promoEngineId>int <!--id инструмента--></promoEngineId>
        • <feedName>string <!--instrument name--></feedName>
        • <promoName>string <!--banner name--></promoName>
        • <linkName>string <!--link name--></linkName>
        • <promoTypeId>string <!--промо категория--></promoTypeId>
        • <promoSizeTypeName>string</promoSizeTypeName>
        • <linkTypeName>string</linkTypeName>
        • <promoSize>string</promoSize>
        • <loadTypeName>string</loadTypeName>
        • <trafficTypeId>string</trafficTypeId>
        • <subaccount>string</subaccount>
        • <subaccount2>string</subaccount2>
        • <subaccount3>string</subaccount3>
        • <subaccount4>string</subaccount4>
        • <subaccount5>string</subaccount5>
        • <site>string <!--сайт с которого пришел пользователь или был совершен просмотр--></site>
        • <productId>string <!--ID заказа--></productId>
        • <browserType>string</browserType>
        • <resolution>string</resolution>
        • <color>string</color>
        • <osType>string</osType>
        • <showCount>int <!--количество показов рекламного материала уникальному пользователю--></showCount>
        • <clickCount>int <!--неуникальный переход по рекламному материалу--></clickCount>
        • <clickUniqCount>int <!--уникальный переход по рекламному материалу--></clickUniqCount>
        • <backUrlRedirectCount>int <!--количество перенаправлений. backurl--></backUrlRedirectCount>
        • <leadsOpen>int <!--количество открытых действий--></leadsOpen>
        • <leadsCancelled>int <!--количество отклоненных действий--></leadsCancelled>
        • <leadsApproved>int <!--количество подтвержденных действий--></leadsApproved>
        • <saleOpen>int <!--количество открытых продаж--></saleOpen>
        • <saleCancelled>int <!--количество отклоненных продаж--></saleCancelled>
        • <saleApproved>int <!--количество подтвержденных продаж--></saleApproved>
        • <commissionOpen>string <!--открытая комиссия--></commissionOpen>
        • <commissionCancelled>string <!--отклоненная комиссия--></commissionCancelled>
        • <commissionApproved>string <!--подтвержденная комиссия--></commissionApproved>
        • <crLeads>string <!--отношение количества действий к общему количеству кликов--></crLeads>
        • <crSales>string <!--отношение количества продаж к общему количеству кликов--></crSales>
        • <crTotal>string <!--отношение общего количества действий и продаж к общему количеству кликов--></crTotal>
        • <arLeads>string <!--отношение количества одобренных действий к общему количеству действий--></arLeads>
        • <arSales>string <!--отношение количества одобренных продаж к общему количеству продаж--></arSales>
        • <arTotal>string <!--отношение общего количества одобренных продаж и действий к общему количеству продаж и действий--></arTotal>
        • <arCommission>string <!--отношение одобренной комиссии к осумме открытой, одобренной и отклоненной комиссий--></arCommission>
        • <ctr>string <!--коэффициент кликабельности (процент совершенных кликов с одного показа)--></ctr>
        • <ecpc>string <!--средняя стоимость клика--></ecpc>
        • <ecpm>string <!--доход с тысячи показов рекламного материала--></ecpm>
        </item>
      </items>
    • <request_status_in_queue>string</request_status_in_queue>
    </data>
  </getStatisticsResponseData>

Пример:

http://cityads.com/api/rest/webmaster/xml/statistics/action_id/2014-06-15/2014-06-20?remote_auth=6420072d37bf14f1df182d0fe0efa2d9

textshift

Формат:

POST /api/rest/webmaster/xml/textshift

Описание:

Входной POST-запрос в формате XML:

• <createTextShiftRequestData>
  • <name>string <!--Название ротатора--></name>
  • <subaccount>string <!--Название субаккаунта--></subaccount>
  • <subaccount1>string</subaccount1>
  • <subaccount2>string</subaccount2>
  • <subaccount3>string</subaccount3>
  • <subaccount4>string</subaccount4>
  • <subaccount5>string</subaccount5>
  • <links>
    on|
    </links>
  • <links_timeout>int</links_timeout>
  • <links_excluded_sites>string</links_excluded_sites>
  • <text>
    on|
    </text>
  • <text_target>
    current|blank|
    </text_target>
  • <text_excluded_sites>string</text_excluded_sites>
  • <clickunder>
    on|
    </clickunder>
  • <clickunder_timeout>int</clickunder_timeout>
  • <clickunder_excluded_sites>string</clickunder_excluded_sites>
  • <clickunder_scheme_first>
    0|1|2|3|4|5|6|7|8|9|10|
    </clickunder_scheme_first>
  • <clickunder_scheme_second>
    0|2|3|4|5|6|7|8|9|10|
    </clickunder_scheme_second>
  • <clickunder_scheme_third>
    0|3|4|5|6|7|8|9|10|
    </clickunder_scheme_third>
  • <clickunder_target>
    2|3|
    </clickunder_target>
  </createTextShiftRequestData>

Ответ:

• <createTextShiftResponseData>
  • <status>
    200|204|400|403|500|
    </status>
  • <error>string</error>
  • <request_id>int</request_id>
  • <data>
    • <id>int</id>
    </data>
  </createTextShiftResponseData>

Пример:

http://cityads.com/api/rest/webmaster/xml/textshift?remote_auth=6420072d37bf14f1df182d0fe0efa2d9

textshift

Формат:

PUT /api/rest/webmaster/xml/textshift

Описание:

Входной PUT-запрос в формате XML:

• <setTextShiftRequestData>
  • <id>int</id>
  • <name>string <!--Название ротатора--></name>
  • <subaccount>string <!--Название субаккаунта--></subaccount>
  • <subaccount1>string</subaccount1>
  • <subaccount2>string</subaccount2>
  • <subaccount3>string</subaccount3>
  • <subaccount4>string</subaccount4>
  • <subaccount5>string</subaccount5>
  • <links>
    on|
    </links>
  • <links_timeout>int</links_timeout>
  • <links_excluded_sites>string</links_excluded_sites>
  • <text>
    on|
    </text>
  • <text_target>
    current|blank|
    </text_target>
  • <text_excluded_sites>string</text_excluded_sites>
  • <clickunder>
    on|
    </clickunder>
  • <clickunder_timeout>int</clickunder_timeout>
  • <clickunder_excluded_sites>string</clickunder_excluded_sites>
  • <clickunder_scheme_first>
    0|1|2|3|4|5|6|7|8|9|10|
    </clickunder_scheme_first>
  • <clickunder_scheme_second>
    0|2|3|4|5|6|7|8|9|10|
    </clickunder_scheme_second>
  • <clickunder_scheme_third>
    0|3|4|5|6|7|8|9|10|
    </clickunder_scheme_third>
  • <clickunder_target>
    2|3|
    </clickunder_target>
  </setTextShiftRequestData>

Ответ:

• <setTextShiftResponseData>
  • <status>
    200|204|400|403|500|
    </status>
  • <error>string</error>
  • <request_id>int</request_id>
  • <data>boolean</data>
  </setTextShiftResponseData>

Пример:

http://cityads.com/api/rest/webmaster/xml/textshift?remote_auth=6420072d37bf14f1df182d0fe0efa2d9