Change history

July 1, 2026

  • Added the new place.deleteBlock method, which removes an ad unit from its placement and archives it in the Yandex Advertising Network.

  • The account.list.place method response now includes more fields:

    • rsyaEnabled: Status of the YAN ad unit linked to the placement.
    • rsyaBlockID: ID of the YAN ad unit.

June 15, 2026

Added three new methods:

  • createBlock: Create a YAN unit and link it to a placement.
  • bindBlock: Link an existing YAN unit to a placement.
  • rsyaEnabled: Enable or disable a YAN unit.

June 10, 2026

New parameters for controlling impression frequency in the Adfox API

The Adfox API introduces new parameters for configuring and retrieving data on ad impression frequency:

  • minUniqueImpressions: Minimum number of impressions per campaign.
  • avgUniqueImpressions: Target average number of impressions per campaign.
  • minImpressionsPerPeriod: Minimum number of impressions for the selected period.
  • avgImpressionsPerPeriod: Target average number of impressions for the selected period.

These parameters have been added to methods handling campaigns, targeting, and targeting profiles. The documentation for the corresponding API requests and responses has also been updated.

May 5, 2026

Fixed the isOn parameter description for the addValue operation of the userCriteria method: if its value is set to 0, newly added characteristic values are disabled rather than enabled.

January 21, 2026

Updated the documentation for adding and editing campaigns to cover new parameters and their possible values:

  • Added the minCtr parameter, which can be used to set a minimum allowed CTR value as a percentage (from 0 to 100). The default value is 0.

  • Added the optimizationMode parameter, which controls optimization of banner display within a campaign. Available values: none and ctr. The default value is none.

January 16, 2026

  • Added a note clarifying that the platformName and platformType parameters are required when sendToErir=1.

  • Expanded and updated the lists of allowed values for the placement type, including Smart TV and HbbTV. Previously used values have been marked as deprecated.

January 15, 2026

  • Updated the mediaData[] parameter description for cases where files are passed in the field.

  • Updated the list of labeling parameters when adding a contract for ad labeling, editing contract parameters, and getting a list of contracts:

    • Removed the obsolete isVat and isFinalAgreement parameters.
    • Added the following labeling parameters: socialType, contractRole, agentActingForPublisher, and chargePaidByAgent.
    • Updated descriptions of the following parameters: number, customerID, executorID, type, actionType, and subjectType.

  • Added new error codes with keys.

November 11, 2025

  • Added a new value (4) for the impressionsSmoothTypeID parameter (impression delivery rate) to ensure a maximum rate at the start of campaign delivery. Set this value to allocate more impressions to the first days of placement and gradually decrease them toward the end of the campaign.

  • The clicksSmoothTypeID parameter (click delivery rate) has been removed and is no longer used.

October 1, 2025

The option to evenly distribute clicks has been removed from the interface. The Deliver clicks (clicksSmoothTypeID) parameter is now obsolete and was removed from the interface.

June 20, 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

March 3, 2025

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

February 10, 2025

January 23, 2025

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

    • sendToErirContentType<ParameterN>
    • sendToErirDescription<ParameterN>

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

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

December 20, 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.

December 4, 2024

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

November 22, 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.

November 21, 2024

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

October 1, 2024

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

September 27, 2024

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

October 6, 2023

Added value validation for third-party tokens.

July 7, 2023

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

July 5, 2023

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

June 8, 2023

Removed the following deprecated parameters:

November 24, 2022

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

Added labeling parameters to the following methods:

April 15, 2022

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

February 2, 2022

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

December 10, 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.

November 23, 2017

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

September 14, 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.

August 15, 2017

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

May 22, 2017

Added:

April 12, 2017

December 24, 2016

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

August 5, 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.

July 18, 2016

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

June 1, 2016

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

May 26, 2016

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

May 25, 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.

October 26, 2015

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

March 28, 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.

March 27, 2015

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

  • Added a new pagination feature.

June 21, 2014

Added:

June 19, 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.

April 28, 2014

Added banner-level targeting by:

April 22, 2014

Added targeting by gender and age at the campaign level.

March 25, 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.

March 13, 2014

Added increased password complexity when creating users and changing passwords.

December 20, 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.

October 1, 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.

April 29, 2013

You can now specify a link to the tracking pixel.

March 13, 2013

Added redefinition of the rotation method at the placement level.

February 20, 2013

Added targeting by keywords.

January 31, 2013

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

January 16, 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).

December 28, 2012

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

August 14, 2012

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

April 23, 2012

Added:

May 27, 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.

July 26, 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.

January 29, 2010

Added:

  • Getting ad tags.

  • Getting reports. Changed:

  • Report on placements for different dates.

Previous
Error handling
Next
Feedback