Change history

20.06.2025

When getting a campaign list:

  • Added these response parameters:

    • kind_id
    • sectorID
    • rotationMethodID
    • trafficPercents
    • logicType
    • cpm
    • cpc

  • Starting June 23, 2025, the following parameters will be passed as 0 (empty for okveds). Starting July 1, 2025, they will no longer be included in responses:

    • type
    • tracingPointsType
    • outerMarkID
    • bannerSequence
    • sequence
    • scenarioPeriodID
    • mainPointID
    • okveds
    • pricingModelID
    • pricingTypeID
    • paymentMethodID
    • pricingModel
    • itemCost
    • itemQty

03.03.2025

Removed the deprecated request parameters impressionsPerNPerHour and impressionsPerN that were previously used in time targeting for:

10.02.2025

23.01.2025

  • You can now use more request parameters when creating or editing banners:

    • sendToErirContentType<ParameterN>
    • sendToErirDescription<ParameterN>

  • More values are now available for the creativeContentType parameter when creating or editing banners.

  • The okveds[] request parameter previously used when creating or editing banners is no longer available.

20.12.2024

  • Removed the parameters for creating, editing, and listing supercampaigns:

    • level
    • priority
    • maxUniqueClicks
    • datePeriod
    • frequencyTypeClicks
    • uniquePeriodClicks
    • clicksPerPeriod
    • minimalPeriodClicks
    • maxActiveEvents
    • maxActiveEventsPerDay
    • maxActiveEventsPerHour

  • Removed the parameters for creating, editing, and listing supercampaigns:

    • sendToErir
    • contractID
    • publisherContractID
    • costType

  • Added the publisherContractID parameter and updated the contractID parameter for creating, editing, and listing campaigns.

  • Added the cpc parameter for creating campaigns.

04.12.2024

Added the videoDuration parameter for adding, editing, and listing banners.

22.11.2024

Removed:

  • The deprecated isClientTime request parameter for campaign and banner targeting by time.

  • The okved parameter: starting with the API version v5, you no longer need to pass the OKVED code when adding campaigns and banners or editing their parameters.

Added:

  • The maxClicksPerHour parameter used when adding or editing campaign parameters.

21.11.2024

Added the videoResolution request parameter used when creating or editing banners.

01.10.2024

Removed the deprecated request parameters tracingTypeID and isSimplifiedBanners, which were previously used when adding or editing campaign parameters.

27.09.2024

Removed the deprecated response parameters outerMarkID and sequence, which were previously used when adding or editing parameters and retrieving campaign lists.

06.10.2023

Added value validation for third-party tokens.

07.07.2023

Changed the authorization method: you can now log in to the Adfox API using a Yandex OAuth token.

05.07.2023

You can now specify a third-party token when creating or editing banners.

08.06.2023

Removed the following deprecated parameters:

24.11.2022

Added API methods for ad labeling (submitting data to the state register (ERIR)):

Added labeling parameters to the following methods:

15.04.2022

You can now use URL targeting at the campaign, site, section, placement, and banner levels.

02.02.2022

Discontinued support for Adfox.nets. Requests for ad networks with adNetwork and adNetworkWebsite objects are no longer supported.

10.12.2021

  • Hid deprecated targetingGeo methods used for geography targeting. We recommend using the targetingGeobase method instead.

  • Removed the mention of passing account and password in the request parameters after switching to authorization via an OAuth token and user registration via Yandex ID. In addition, you no longer need to pass password to create a new user or change an existing one.

  • When adding a banner type, the presentationTypeID parameter is now required and no longer accepts the value 0 (standard banner type) in the input.

  • If you're adding a banner without specifying the banner template ID, only the xml value can be passed in the contentType parameter. Other values (graphics — image banner, flash — Flash banner, HTML — HTML banner, floatingJS — JavaScript code (Nondimensional), floatingHTML — HTML code (Nondimensional), floatingFlash2 — Flash without a placeholder, FloatingImage — image) aren't supported.

23.11.2017

Added a new user type: API assistants with different rights of access to API methods.

14.09.2017

Added:

  • Logical targeting for banners, campaigns, campaign placement on sites, sections, and placements.

  • The age values 6 (45–54) and 7 (55+) for the ageValue parameter used to target banners and campaigns by age. The value 5 (45+) has been deprecated, and using it will automatically enable the values 6 and 7.

15.08.2017

You can now set and edit the code type (pct) and impression frequency capping (plp, pli, pop) parameters for a placement.

22.05.2017

Added:

12.04.2017

24.12.2016

Discontinued support for the code method. You can get the ad tag by using the placement method.

05.08.2016

Added additional parameter showMode for the show parameter with the value targetingUser when retrieving the list of campaigns. You can use it to output a list of allowed and prohibited values for a user characteristic.

18.07.2016

Added the resetProfile parameter for enabling read-only mode in targeting by geography for campaigns and banners.

01.06.2016

Updated the documentation: to configure targetingUser: v{characteristic value ID}, where the ID is specified without curly brackets. For example, v534.

26.05.2016

You can now get summary information for campaigns using geography targeting.

25.05.2016

Added:

  • Getting the geography reference book NEW.

  • Setting up targeting by geography NEW at the campaign and banner levels.

  • Getting summary information on objects targeted by geography NEW.

  • Getting summary targeting information for a specific ad campaign.

26.10.2015

You can now view targeting settings at the campaign level by targetingGender, targetingAge, and targetingRevenue.

28.03.2015

Added campaign-level targeting by:

Added banner-level targeting by:

Corrected in the documentation:

  • The note about the date and time format.

  • The section on passing parameters in an XML file.

27.03.2015

  • Developed a new version with the request host https://api.adfox.ru/v1/API.php?.

  • Added a new pagination feature.

21.06.2014

Added:

19.06.2014

Because of the increased password security requirements, Adfox is changing the authorization procedure via the API. Starting June 24, 2014, 14:00, you will no longer be able to pass passwords in plain text. All API requests will be authorized correctly only if the password is passed in encrypted form using the SHA256 hash function from the password.

28.04.2014

Added banner-level targeting by:

22.04.2014

Added targeting by gender and age at the campaign level.

25.03.2014

Added:

  • Ability to view summary targeting information at the campaign and banner levels.

  • The short value for the show parameter when viewing the list of supercampaigns, campaigns, and banners.

11.03.2014

Added increased password complexity when creating users and changing passwords.

20.12.2013

Added:

  • Additional targeting at the banner level.

  • Ability to toggle the referer template by URL in ad networks.

  • Geography targeting at the banner level.

01.10.2013

  • Disabled the PopUp and PopUnder banner types.

  • Access to the Adfox API is allowed only over the HTTPS protocol. HTTP requests will return the 999 error.

29.04.2013

You can now specify a link to the tracking pixel.

15.03.2013

Added redefinition of the rotation method at the placement level.

20.02.2013

Added targeting by keywords.

31.01.2013

The priority parameter is no longer required for editing campaign parameters.

16.01.2013

Changed:

  • Getting the geobase for working with the API.

  • Specifying the rotation method by priority (level, priority) and the percentage of traffic (% of traffic) for a campaign.

  • The priority parameter is now required when editing campaign parameters.

  • Custom targeting.

  • Redefining targeting at the placement level (site, section, placement).

28.12.2012

You can now add and edit industries for supercampaigns and campaigns.

14.08.2012

Added a description of the impressionsMethodID parameter (impression count method) when adding supercampaigns and campaigns.

23.04.2012

Added:

Changed:

27.05.2011

Added:

  • Description of the methods for targeting by time, frequency, behavior, and geography.

  • The impressionsSmoothTypeID and clicksSmoothTypeID campaign parameters.

  • The campaignID parameter for the tracingPoint method.

Changed:

  • List of available templates for the banner type and the action point.

  • Backup ad for placements.

  • Impression and click report on active campaigns for different dates over a certain period.

  • List of site sections with filtering by site.

26.07.2010

Changed:

  • Getting a daily report: all banners on all placements.

  • Changing page templates for sections.

  • Information about the imageURL and getURL parameters when creating a banner.

  • Getting a list of system placements for banner types from ad network sites.

  • Hourly ad network site report for a 24-hour period.

  • Hourly campaign report for a specified date.

  • Getting the ad tag with the code type.

  • Deleting placements.

  • Request template.

  • Report on impressions and clicks on all placements.

29.01.2010

Added:

  • Getting ad tags.

  • Getting reports.

Changed:

  • Report on placements for different dates.
Previous
Error handling
Next
Feedback