Yandex
 
Log in
Contents
Introduction
API versions
Ways to use the API
Start developing your application
Access
Overview
Practical usage
Sandbox
Methods
Examples
Feedback
Examples
Perl
PHP
Python
Working with reports
Introduction
API versions
Version 5
Live 4 version (deprecated)
Version 4 (deprecated)
Version 3 (disabled)
Version 2 (disabled)
Version 1 (disabled)
Ways to use the API
Start developing your application
Access
App registration
JSON format
SOAP protocol
Access tokens
Example: getting a token for a web service
Accessing finance methods
Requirements for an app
Usage limitations
Overview
Client
Shared account (Account)
Campaign
Ad group
Banner
Phrase
Retargeting
Image (AdImage)
Targeting
Bids and prices
Display strategies
Bid selection
Statistics and analysis
Financial transactions
Practical usage
Conducting advertising campaigns
Groups of ads
Images in ads
Ad tags
Statistics
Working with the shared account
Sandbox
Sandbox address
Managing the Sandbox
Special Sandbox features
Methods
Budget forecasting and keyword selection
Keywords
CreateNewWordstatReport
DeleteWordstatReport
GetWordstatReport
GetWordstatReportList
GetKeywordsSuggestion
Budget forecasting
CreateNewForecast (Live)
CreateNewForecast (disabled)
DeleteForecastReport
GetForecast (Live)
GetForecast (disabled)
GetForecastList
Ad tags
GetBannersTags (Live)
GetCampaignsTags (Live)
UpdateBannersTags (Live)
UpdateCampaignsTags (Live)
Images in ads
AdImage (Live)
Upload
CheckUploadStatus
UploadRawData
Delete
Get
GetLimits
AdImageAssociation (Live)
Get
Set
Retargeting
GetRetargetingGoals (Live)
Financial transactions
CreateInvoice (Live)
CreateInvoice (disabled)
GetCreditLimits
PayCampaigns (Live)
PayCampaigns (disabled)
TransferMoney (Live)
TransferMoney (disabled)
Shared account
EnableSharedAccount (Live)
AccountManagement (Live)
Deposit
Invoice
TransferMoney
Get
Update
Points
GetClientsUnits
Other methods
GetAvailableVersions
GetEventsLog (Live)
GetRegions
GetRegions (Live)
GetRubrics
GetStatGoals
GetStatGoals (Live)
GetTimeZones
GetVersion
PingAPI
Disabled methods
Campaigns
ArchiveCampaign (disabled)
ArchiveCampaign (Live) (disabled)
CreateOrUpdateCampaign (disabled)
CreateOrUpdateCampaign (Live) (disabled)
DeleteCampaign (disabled)
DeleteCampaign (Live) (disabled)
GetCampaignParams (disabled)
GetCampaignParams (Live) (disabled)
GetCampaignsList (disabled)
GetCampaignsList (Live) (disabled)
GetCampaignsListFilter (disabled)
GetCampaignsListFilter (Live) (disabled)
GetCampaignsParams (disabled)
GetCampaignsParams (Live) (disabled)
ResumeCampaign (disabled)
ResumeCampaign (Live) (disabled)
StopCampaign (disabled)
StopCampaign (Live) (disabled)
UnArchiveCampaign (disabled)
UnArchiveCampaign (Live) (disabled)
Ads
ArchiveBanners (disabled)
ArchiveBanners (Live) (disabled)
CreateOrUpdateBanners (disabled)
CreateOrUpdateBanners (Live) (disabled)
DeleteBanners (disabled)
DeleteBanners (Live) (disabled)
GetBanners (disabled)
GetBanners (Live) (disabled)
GetBannerPhrases (disabled)
GetBannerPhrases (Live) (disabled)
GetBannerPhrasesFilter (disabled)
GetBannerPhrasesFilter (Live) (disabled)
ModerateBanners (disabled)
ModerateBanners (Live) (disabled)
ResumeBanners (disabled)
ResumeBanners (Live) (disabled)
StopBanners (disabled)
StopBanners (Live) (disabled)
UnArchiveBanners (disabled)
UnArchiveBanners (Live) (disabled)
Keywords
Keyword (Live) (disabled)
Suspend
Resume
Get
Bids
SetAutoPrice (disabled)
SetAutoPrice (Live) (disabled)
UpdatePrices (disabled)
UpdatePrices (Live) (disabled)
Statistics
GetBalance (disabled)
GetBalance (Live) (disabled)
GetBannersStat (Live) (disabled)
GetSummaryStat (disabled)
GetSummaryStat (Live) (disabled)
CreateNewReport (disabled)
CreateNewReport (Live) (disabled)
DeleteReport (disabled)
GetReportList (disabled)
CreateOfflineReport (Live) (disabled)
DeleteOfflineReport (Live) (disabled)
GetOfflineReportList (Live) (disabled)
Retargeting
RetargetingCondition (Live) (disabled)
Add
Update
Delete
Get
Retargeting (disabled)
Add
Update
Delete
Get
Clients
CreateNewSubclient (disabled)
CreateNewSubclient (Live) (disabled)
GetClientInfo (disabled)
GetClientInfo (Live) (disabled)
GetClientsList (disabled)
GetClientsList (Live) (disabled)
GetSubClients (disabled)
UpdateClientInfo (disabled)
UpdateClientInfo (Live) (disabled)
Other methods
GetChanges (disabled)
GetChanges (Live) (disabled)
Error and warning codes
Examples
Perl
JSON
PHP
SOAP (NuSOAP class)
SOAP (SOAPClient class)
JSON
Python
SOAP (Suds library)
JSON
Working with reports
Getting the report file
Sample report file
Feedback
When calling a Yandex Direct API method, an error occurs
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
Examples

Examples

Perl
  • JSON
PHP
  • SOAP (класс NuSOAP) | SOAP (класс SOAPClient) | JSON
Python
  • SOAP (Suds library) | JSON
Authorization
  • Getting an OAuth token using a web service
Reports
  • Getting the report file | Example of a campaign statistics report
Perl
  • JSON
PHP
  • SOAP (класс NuSOAP) | SOAP (класс SOAPClient) | JSON
Python
  • SOAP (Suds library) | JSON
Authorization
  • Getting an OAuth token using a web service
Reports
  • Getting the report file | Example of a campaign statistics report
Was the article useful?
Please specify why
  • didn't answer my question
  • recommendations did not help me
  • I don't like how this feature works
  • article is hard to understand
  • article content does not match its stated topic
  • other reason
Thank you for your feedback!
Please tell us what you didn't like about this article:
Previous
Error and warning codes
Next
JSON
Previous
Error and warning codes
Next
JSON
User agreement
© 2022  Yandex LLC