Documentation

About this reference guide

This reference describes the services of the Yandex.Direct API version 5. The document is intended for developers who are creating applications for managing contextual advertising in Yandex.Direct.

The API services and methods are listed below:

CampaignsGroups of adsAdsKeywords and autotargetings
Service: Campaigns
[no-highlight[

Use this service for performing operations with campaigns.

More Campaigns

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates campaigns.

    More add

    ]no-highlight]
  • archive
    [no-highlight[

    Archives campaigns.

    More archive

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes campaigns.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns the parameters of campaigns that match the specified criteria.

    More get

    ]no-highlight]
  • resume
    [no-highlight[

    Resumes displays on the campaign level.

    More resume

    ]no-highlight]
  • suspend
    [no-highlight[

    Stops displays on the campaign level.

    More suspend

    ]no-highlight]
  • unarchive
    [no-highlight[

    Unarchives campaigns.

    More unarchive

    ]no-highlight]
  • update
    [no-highlight[

    Changes campaign parameters.

    More update

    ]no-highlight]
Service: AdGroups
[no-highlight[

Use this service for performing operations with groups of ads.

More AdGroups

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates ad groups.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes ad groups.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns parameters of groups that match the specified criteria.

    More get

    ]no-highlight]
  • update
    [no-highlight[

    Changes the parameters of ad groups.

    More update

    ]no-highlight]
Service: Ads
[no-highlight[

Use this service for performing operations with ads.

More Ads

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates ads.

    More add

    ]no-highlight]
  • archive
    [no-highlight[

    Archives ads.

    More archive

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes ads.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns parameters of ads that match the specified criteria.

    More get

    ]no-highlight]
  • moderate
    [no-highlight[

    Submits ads for review.

    More moderate

    ]no-highlight]
  • resume
    [no-highlight[

    Resumes ad displays that were previously stopped by the owner.

    More resume

    ]no-highlight]
  • suspend
    [no-highlight[

    Stops ad displays.

    More suspend

    ]no-highlight]
  • unarchive
    [no-highlight[

    Unarchives ads.

    More unarchive

    ]no-highlight]
  • update
    [no-highlight[

    Changes ad parameters.

    More update

    ]no-highlight]
Service: Keywords
[no-highlight[

Use this service for performing operations with keywords and autotargetings.

More Keywords

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates keywords and autotargetings.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes keywords and autotargetings.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns parameters of keywords or autotargetings that match the set criteria: the values of substitution variables, status and state, productivity, statistics for impressions and clicks, and bids and priorities.

    More get

    ]no-highlight]
  • resume
    [no-highlight[

    Resumes displays for keywords and autotargetings that were suspended earlier.

    More resume

    ]no-highlight]
  • suspend
    [no-highlight[

    Stops displays for keywords and autotargetings.

    More suspend

    ]no-highlight]
  • update
    [no-highlight[

    Changes the parameters of keywords and autotargetings.

    More update

    ]no-highlight]
BidsBid adjustmentsAudience targetsRetargeting lists
Service: Bids
[no-highlight[

Use this service for setting bids (if a manual bid management strategy is set up in the campaign) and priorities (if an automatic strategy is set up) for keywords and autotargetings.

More Bids

]no-highlight]

Methods:

  • get
    [no-highlight[

    Returns bids and priorities for keywords and autotargetings that match the specified criteria, along with data that is useful for bid selection: auction data on the search display positions and bids for various percents of audience coverage in ad networks.

    More get

    ]no-highlight]
  • set
    [no-highlight[

    Sets fixed bids and priorities for keywords and autotargetings.

    More set

    ]no-highlight]
  • setAuto
    [no-highlight[

    The automatic bid constructor calculates bids for keywords based on the selected algorithm.

    More setAuto

    ]no-highlight]
Service: BidModifiers
[no-highlight[

This service is for managing bid adjustments.

More BidModifiers

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates bid adjustments.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes bid adjustments.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns parameters of adjustments that match the specified criteria.

    More get

    ]no-highlight]
  • set
    [no-highlight[

    Changes the coefficient values in bid adjustments.

    More set

    ]no-highlight]
  • toggle
    [no-highlight[

    Enables or disables a set of adjustments.

    More toggle

    ]no-highlight]
Service: AudienceTargets
[no-highlight[

This service is for performing operations with audience targets.

More AudienceTargets

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates audience targets and sets bids and priorities for the created targets.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes audience targets.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns the parameters of audience targets.

    More get

    ]no-highlight]
  • resume
    [no-highlight[

    Resumes displays for previously paused audience targets.

    More resume

    ]no-highlight]
  • setBids
    [no-highlight[

    Sets bids and priorities for audience targets.

    More setBids

    ]no-highlight]
  • suspend
    [no-highlight[

    Pauses displays for audience targets.

    More suspend

    ]no-highlight]
Service: RetargetingLists
[no-highlight[

This service is for performing operations with retargeting lists.

More RetargetingLists

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates retargeting lists.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes retargeting lists.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns retargeting lists.

    More get

    ]no-highlight]
  • update
    [no-highlight[

    Changes the parameters of retargeting lists.

    More update

    ]no-highlight]
vCardsSitelinksImagesExtensions
Service: VCards
[no-highlight[

This service performs operations with virtual business cards.

More VCards

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates virtual business cards.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes virtual business cards.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns the vCards that match the specified criteria.

    More get

    ]no-highlight]
Service: Sitelinks
[no-highlight[

Use this service for performing operations with sets of sitelinks.

More Sitelinks

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates sets of sitelinks.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes sets of sitelinks.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns sets of sitelinks that match the specified criteria.

    More get

    ]no-highlight]
Service: AdImages
[no-highlight[

Use this service for performing operations with images.

More AdImages

]no-highlight]

Methods:

  • add
    [no-highlight[

    Synchronously uploads images as binary data.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes images.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns images that meet the specified criteria.

    More get

    ]no-highlight]
Service: AdExtensions
[no-highlight[

Use this service for performing operations with ad extensions. Only one type of extension, the callout, is available at this time.

More AdExtensions

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates extensions.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes extensions.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns extensions that meet the specified criteria.

    More get

    ]no-highlight]
Dynamic text ad targetsChangesReference listsClients
Service: DynamicTextAdTargets
[no-highlight[

This service is for performing operations with targeting conditions for dynamic ads.

More DynamicTextAdTargets

]no-highlight]

Methods:

  • add
    [no-highlight[

    Creates targeting conditions for dynamic ads and sets bids or priorities for the created conditions.

    More add

    ]no-highlight]
  • delete
    [no-highlight[

    Deletes targeting conditions for dynamic ads.

    More delete

    ]no-highlight]
  • get
    [no-highlight[

    Returns parameters of targeting conditions for dynamic ads.

    More get

    ]no-highlight]
  • resume
    [no-highlight[

    Resumes displays of previously stopped targeting conditions for dynamic ads.

    More resume

    ]no-highlight]
  • setBids
    [no-highlight[

    Sets bids and priorities for targeting conditions for dynamic ads.

    More setBids

    ]no-highlight]
  • suspend
    [no-highlight[

    Stops displays using targeting conditions for dynamic ads.

    More suspend

    ]no-highlight]
Service: Changes
[no-highlight[

Use this service to check for changes.

More Changes

]no-highlight]

Methods:

  • check
    [no-highlight[

    Informs you of changes in the client‘s campaigns, groups, and ads, starting from the specified date.

    More check

    ]no-highlight]
  • checkCampaigns
    [no-highlight[

    Informs you of changes in the client‘s campaigns starting from the specified date.

    More checkCampaigns

    ]no-highlight]
  • checkDictionaries
    [no-highlight[

    Shows whether there are any changes in the reference lists of regions, time zones, and mobile app categories. You can also use it to get the current time on the server.

    More checkDictionaries

    ]no-highlight]
Service: Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
Method: get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
Service: Clients
[no-highlight[

This service is for managing advertiser parameters and user settings for the advertiser‘s representative.

More Clients

]no-highlight]

Methods:

  • get
    [no-highlight[

    Returns the advertiser parameters and the settings for the user representing the advertiser.

    More get

    ]no-highlight]
  • update
    [no-highlight[

    Changes the advertiser parameters and the user settings for the advertiser‘s representative.

    More update

    ]no-highlight]
Service: AgencyClients
[no-highlight[

This service allows advertising agencies to manage their clients.

More AgencyClients

]no-highlight]

Methods:

  • add
    [no-highlight[

    Registers new advertisers who are agency clients and users who are chief representatives of advertisers.

    More add

    ]no-highlight]
  • get
    [no-highlight[

    Returns a list of advertisers who are agency clients, their parameters, and settings for each advertiser‘s chief representative.

    More get

    ]no-highlight]
  • update
    [no-highlight[

    Changes the parameters of advertisers who are agency clients, and user settings for chief representatives of advertisers.

    More update

    ]no-highlight]
Forecast of impressions
Service: KeywordsResearch
[no-highlight[

Use this service to get a forecast of impressions for keywords.

More KeywordsResearch

]no-highlight]
Method: hasSearchVolume
[no-highlight[

Generates an approximate forecast of impressions for the specified keywords and regions, broken down by device type. Used when selecting keywords.

More hasSearchVolume

]no-highlight]
Note. 

Methods for managing shared accounts, for getting budget forecasts and keyword selections, and for performing financial transactions are all available in version 4 (Live 4) of the API. See the section Methods in the documentation for the API version 4 (Live 4).

Direct
API
Yandex.Direct