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
Feedback
API version 5. Reference
AdExtensions: Operations with ad extensions
AdGroups: Operations with ad groups
AdImages: Operations with images
Ads: Operations with ads
AdVideos: Operations with videos
AgencyClients: managing agency clients
AudienceTargets: managing audience targets
Bids: managing bids
Businesses: getting business profiles
BidModifiers: managing bid adjustments
Campaigns: managing campaigns
Changes: checking for changes
Clients: managing advertiser parameters and user settings
Creatives: getting creatives
Dictionaries: getting reference lists
DynamicFeedAdTargets: managing dynamic feed ad targets
DynamicTextAdTargets: managing dynamic text ad targets
Feeds: Operations with feeds
KeywordBids: managing bids
Keywords: managing keywords and autotargetings
KeywordsResearch: preprocessing of keywords
Leads: receiving form data from Turbo pages
NegativeKeywordSharedSets: managing sets of negative keywords
RetargetingLists: managing retargeting lists
Sitelinks: Operations with sitelinks
SmartAdTargets: managing smart banner targeting filters
TurboPages: getting parameters of Turbo pages
VCards: Operations with vCards
Errors and warnings
Reference information
Feeds: Operations with feeds
add
delete
get
update
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)
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
SmartCampaign
DynamicTextCampaign
MobileAppCampaign
CpmBannerCampaign
archive
delete
get
TextCampaign
SmartCampaign
DynamicTextCampaign
MobileAppCampaign
CpmBannerCampaign
resume
suspend
unarchive
update
TextCampaign
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
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