Change history

Version 2.5.0 of October 6, 2023

Added the validation of the value for a third-party token.

Version 2.4.0 of July 07, 2023

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

Version 2.3.0 of July 05, 2023

Added the ability to specify a third-party token when adding of editing a banner.

Version 2.2.0 of November 24, 2022

Added API methods to work with ad register. You can:

  • Create, edit, get a list of, or delete contractors.

  • Create, edit, get a list of, or delete contracts.

  • Create or get a list of websites (added parameters for ad register).

  • Get a list of templates (added parameters for ad register).

  • Create, edit, or get a list of campaigns (added parameters for ad register).

  • Create, edit, or get a list of banners (added parameters for ad register).

Version 2.1.0 of April 15, 2022

What's new:

  • Added the ability to target by URL at the campaign, site, section, placement, and banner level.

Version 2.0.0 of February 2, 2022

What's new:

  • Adfox.nets support has been discontinued. Requests for ad networks with adNetwork and adNetworkWebsite objects are no longer supported.

Version 1.9.0 of December 10, 2021

What's new:

  • Deprecated methods of targeting by geography (targetingGeo) have been hidden. We recommend using the targetingGeobase method.

  • Deleted the mention of passing account and password in the request parameters after switching to authorization via the OAuth token and user registration via Yandex ID. Passing password is no longer required when creating a new user or changing an existing one.

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

  • When adding a banner, if the banner template ID isn't specified, 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.

Version 1.8.0 of November 23, 2017

Added:

Version 1.7.0 of September 14, 2017

Whats' new:

  • Added logical targeting for banners, campaigns, campaign placement on sites, site sections, and placements.

  • In targeting banners and campaigns by age, the values 6 (ages 45 to 54) and 7 (over 55) have been added for the ageValue parameter.

  • The value 5 (older than 45) is deprecated. When it's used, the values 6 and 7 are automatically enabled.

Version 1.6.0 of August 15, 2017

Added:

  • The ability to set and edit the “code type” (pct) and “impression frequency limit” (plp, pli, pop) parameters for a placement.

Version 1.5.0 of May 22, 2017

Added:

Version 1.4.0 of April 12, 2017

What's new:

Version 1.3.0 of December 24, 2016

What's new:

  • The code method isn't supported. Use the [placement](../placement/placement.md) method to get the ad tag.

Version 1.2.0 of August 5, 2016

Added:

  • The showMode parameter for [account-list-campaign-show=targetingUser](../account/account-list-campaign.md). You can use it to display a list of allowed and/or prohibited values of a user characteristic.

Version 1.1.0 of July 18, 2016

Added:

  • The resetProfile parameter for enabling the “read only” mode in targeting by geography for [campaign](../campaign/campaign-target-targetingGeobase.md) and [banner](../banner/banner-target-targetingGeobase.md).

Version 1.0.5 pf June 1, 2016

Corrected in the documentation:

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

Version 1.0.4 of May 26, 2016

Added:

Version 1.0.3 of May 25, 2016

Added:

  • Getting the geography reference book NEW.

  • Setting up targeting by geography NEW at the [campaign](../campaign/campaign-target-targetingGeobase.md) and [banner](../banner/banner-target-targetingGeobase.md) levels.

  • Getting summary information on objects targeted by geography NEW.

  • Getting summary targeting information for a specific campaign.

Version 1.0.2 of October 26, 2015

Added:

  • The ability to view the targeting settings for targetingGender, targetingAge, and targetingRevenue at the campaign level.

Version 1.0.1 of March 28, 2015

Added targeting at the campaign level:

Added targeting at the banner level:

Corrected in the documentation:

  • The note about the date and time format.

  • The section about passing parameters in an XML file.

Version 0.0.13.3 and Version 1.0.0 of March 27, 2015

A new 1.0.0 version has been developed with the request host https://api.adfox.ru/v1/API.php?.

Added the new pagination feature in version 1.0.0.

Version 0.0.13.3 of June 21, 2014

Added:

Version 0.0.13.2 of June 19, 2014

Because of the increased password security requirements, Adfox is changing the authorization procedure via the API. Passwords in plain text can be passed until 14:00 June 24, 2014. After that, all API requests will be authorized correctly only if the password is passed in encrypted form using the sha256 hash function from the password.

Version 0.0.13.1 of April 28, 2014

Added targeting at the banner level:

Version 0.0.13 of April 22, 2014

Added targeting by gender and age at the campaign level.

Version 0.0.12 of March 25, 2014

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

  • Added the short value for the show parameter (viewing the list of campaigns, super campaigns, and banners).

Version 0.0.11 of March 11, 2014

Added increased password complexity when creating users and changing passwords.

Version 0.0.10 of December 20, 2013

  • Additional targeting is now available at the banner level.

  • Added the ability to turn on and off the "referer" template by URL in ad networks.

  • Added the ability to target by geography at the banner level.

Version 0.0.9.5 of October 1, 2013

  • Disabled the PopUp and PopUnder banner types.

  • Access to the Adfox API is allowed only over the HTTPS protocol. For requests via HTTP, error -999 is returned.

Version 0.0.9.4 of April 29, 2013

Added the ability to specify a link to the tracking pixel.

Version 0.0.9.3 of March 15, 2013

Added redefinition of the rotation method at the placement level.

Version 0.0.9.2 of February 20, 2013

Added targeting by keywords/phrases.

Version 0.0.9.1 of January 31, 2013

The priority parameter is optional when you edit (modify) a campaign/flight.

Version 0.0.9 of January 16, 2013

  • Getting the geobase for working with the API.

  • Specifying the rotation method (by priority (level, priority), by % of traffic (% of traffic)) for a campaign/flight. The priority parameter is required when you edit (modify) a campaign/flight.

  • Custom targeting.

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

Version 0.0.8 of December 28, 2012

Adding/editing an industry for a campaign/flight.

Version 0.0.7 of August 14, 2012

Added a description of the impressionsMethodID field (Impression count method) for the account-add-campaign and account-add-supercampaign calls.

Version 0.0.6 of April 23, 2012

  • Added the account-list-bannerPlaceReport call — uploading daily data on campaigns/banners/placements.

  • Information on setting custom targeting for a campaign.

  • Added the encoding parameter.

  • Added calls for adding assistants and advertisers.

  • Added the advertiser-availableReports call, the availableReports field to the account-list-advertiser call, and automatic renewal for the impressionsSmoothTypeID and clicksSmoothTypeID fields.

  • Fixed a bug in pricingModel.

  • Added the pricingModel, itemCost, and ItemQty fields to super campaigns, flights, and campaigns.

  • Added calls:

    • account-add-superCampaign.
    • account-list-superCampaign.
    • account-delete-superCampaign.
    • superCampaign-modify.
    • account-delete-superCampaign.
    • account-list-activeBanners.
    • account-list-tracingPoint2 Modified calls:
    • account-add-campaign.
    • account-list-campaign.
    • account-user-userCriterias.
    • campaign-info-placement2.
    • campaign-modify.
    • campaign-placing-place.
    • campaign-placing-website.
    • campaign-placing-zone.
    • campaign-target-targetingTime.
    • userCriteria-modify.

  • Added custom targeting calls.

  • Added output of targeting settings. Corrected editing geo-targeting settings and output of campaign and banner settings.

  • Added a description of the keyword targeting call. Clarified the description of the calls for working with categories.

Version 0.0.5 of May 27, 2011

  • Added the description for targeting by time, frequency, behavior, and geography.

  • Added the impressionsSmoothTypeID and clicksSmoothTypeID fields for campaigns.

  • Added the campaignID parameter for the account-list-tracingPoint command.

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

  • Backup ad for placements.

  • Daily impression/click report on active campaigns for a given period.

  • List of site sections data sheet with filtering by site.

Version 0.0.4 of July 26, 2010

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

  • Changing page templates for sections.

  • Updated information about the imageURL and getURL fields in adding banners.

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

  • Ad network site report: hourly for 24 hours.

  • 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.

Version 0.0.3 of January 29, 2010

  • Added getting ad tags.

  • Added getting reports.

  • Report on placements: by day.

Previous
Error handling
Next
Feedback