Cancel
Yandex
Search
Log in
Contents
How to get started with the API: Tutorial
API version 5. History
API version 5. Developer's guide
API version 5. Reference
API version 5. Statistics
API version 5. Examples
Migration guide
Upgrading to a unified performance campaign
Feedback
API version 5. Developer's guide
Overview of the Yandex Direct API version 5
Usage
Start developing your application
Main objects
Access and authorization
Interaction format
Restrictions, points
General method properties in the API version 5
Practical usage
Sandbox
List of terms
Main objects
Campaign
Ad group
Ad
Set of sitelinks (SitelinksSet)
vCard
Image (AdImage)
Video (AdVideo)
Creative (Creative)
Extension (AdExtension)
Turbo page (TurboPage)
Keyword
Bid and priority (KeywordBid)
Adjustments (BidModifier)
Portfolio strategy (Strategy)
Audience targets (AudienceTarget)
Retargeting list (RetargetingList)
Feed (Feed)
Filter — targeting criteria for smart banners (SmartAdTarget)
Dynamic feed ad target (DynamicFeedAdTarget)
Ad target for dynamic ads (DynamicTextAdTarget — Webpage)
Client
SharedAccount
How to get started with the API: Tutorial
Lesson 1. What is Yandex Direct API
Lesson 2. API access: how to register an app in Yandex OAuth
Lesson 3. API access: how to submit a request
Lesson 4. How to get an OAuth token
Lesson 5. How to enable Sandbox
Lesson 6. How to make an API request
Lesson 7. How to get data via the API
Lesson 8. How to make changes via the API
Lesson 9. How to get to real work
Lesson 10. How to efficiently use the API: restrictions and recommendations
API version 5. History
API version 5. Developer's guide
Overview of the Yandex Direct API version 5
Usage
Start developing your application
Main objects
Campaign
Display strategies
Campaign parameters
Ad group
Ad
Set of sitelinks (SitelinksSet)
vCard
Image (AdImage)
Video (AdVideo)
Creative (Creative)
Extension (AdExtension)
Turbo page (TurboPage)
Keyword
Bid and priority (KeywordBid)
Adjustments (BidModifier)
Portfolio strategy (Strategy)
Audience targets (AudienceTarget)
Retargeting list (RetargetingList)
Feed (Feed)
Filter — targeting criteria for smart banners (SmartAdTarget)
Dynamic feed ad target (DynamicFeedAdTarget)
Ad target for dynamic ads (DynamicTextAdTarget — Webpage)
Client
SharedAccount
Access and authorization
App registration
Access tokens
Roles and access of Yandex Direct users
Interaction format
HTTP headers
JSON
SOAP
Error handling
Restrictions, points
General method properties in the API version 5
Receiving data
Operations on object arrays
Editing separate parameters
null (nil) value
Practical usage
Running an advertising campaign
Negative keywords
Autotargeting
Tracking changes
Statistics and analysis
Display campaigns
Dynamic ads
Smart banners
Delegates
For agencies
Sandbox
Managing the Sandbox
List of terms
API version 5. Reference
AdExtensions: Operations with ad extensions
add
delete
get
AdGroups: Operations with ad groups
add
delete
get
update
AdImages: Operations with images
add
delete
get
Ads: Operations with ads
add
archive
delete
get
moderate
resume
suspend
unarchive
update
AdVideos: Operations with videos
add
get
AgencyClients: managing agency clients
add
get
update
AudienceTargets: managing audience targets
add
delete
get
resume
setBids
suspend
Bids: managing bids
get
set
setAuto
Businesses: getting business profiles
get
BidModifiers: managing bid adjustments
add
delete
get
set
toggle
Campaigns: managing campaigns
add
TextCampaign
UnifiedCampaign
SmartCampaign
DynamicTextCampaign
MobileAppCampaign
CpmBannerCampaign
archive
delete
get
TextCampaign
UnifiedCampaign
SmartCampaign
DynamicTextCampaign
MobileAppCampaign
CpmBannerCampaign
resume
suspend
unarchive
update
TextCampaign
UnifiedCampaign
SmartCampaign
DynamicTextCampaign
MobileAppCampaign
CpmBannerCampaign
Changes: checking for changes
checkDictionaries
checkCampaigns
check
Clients: managing advertiser parameters and user settings
get
update
Creatives: getting creatives
add
get
Dictionaries: getting reference lists
get
getGeoRegions
DynamicFeedAdTargets: managing dynamic feed ad targets
add
delete
get
resume
setBids
suspend
DynamicTextAdTargets: managing dynamic text ad targets
add
delete
get
resume
setBids
suspend
Feeds: Operations with feeds
add
delete
get
update
KeywordBids: managing bids
get
set
setAuto
Keywords: managing keywords and autotargetings
add
delete
get
resume
suspend
update
KeywordsResearch: preprocessing of keywords
deduplicate
hasSearchVolume
Leads: receiving form data from Turbo pages
get
NegativeKeywordSharedSets: managing sets of negative keywords
add
delete
get
update
RetargetingLists: managing retargeting lists
add
delete
get
update
Sitelinks: Operations with sitelinks
add
delete
get
SmartAdTargets: managing smart banner targeting filters
add
delete
get
resume
setBids
suspend
update
Strategies: operations with portfolio strategies
add
archive
get
unarchive
update
TurboPages: getting parameters of Turbo pages
get
VCards: Operations with vCards
add
delete
get
Errors and warnings
Reference information
Types of strategies
Campaign settings (Option parameter)
API version 5. Statistics
How to generate a report
Report period
Report type
Report fields
Monetary values
Filtering data
HTTP headers
Request: report specification
Allowed fields
Incompatible fields and dependencies
Report content
Online and offline reports
Data freshness
Response codes and error codes
Restrictions
Examples
Clicks and cost
Yandex Metrica data
API version 5. Examples
cURL
Configure time targeting
Change the strategy
Add tags to an ad URL
Stop and start ads
Setting bids
PHP
Get a token
JSON (file_get_contents)
Get campaigns
Creating ads
Process insufficient points
JSON (cURL)
Get campaigns
Creating ads
Get statistics for any dates
Get statistics for a selection of rows
SOAP
Get campaigns
Creating ads
Python
Get a token
JSON
Get campaigns
Creating ads
Process insufficient points
Get statistics for any dates
Get statistics for a selection of rows
Get statistics for agency clients
SOAP
Get campaigns
Creating ads
XML
Get statistics for any dates
Get statistics for a selection of rows
Migration guide
Major changes
Method equivalents
Parameter equivalents
Campaigns
Ads and ad groups
Keywords and bids
vCards
Statistics
Retargeting
Clients
Example: switching to the Reports service
Upgrading to a unified performance campaign
Feedback
When calling a Yandex Direct API method, an error occurs
Request for access
Restrictions when working with the Yandex Direct API
Access to register new agency clients via the API
Make a suggestion or leave a comment
Other questions about the Yandex Direct API
API version 5. Developer's guide
Main objects
Filter — targeting criteria for smart banners (SmartAdTarget)
Filter — targeting criteria for smart banners (SmartAdTarget)
Service
Restrictions