Overview of the Yandex.Direct API version 5
The Yandex.Direct programming interface (API) automates management of advertising campaigns. External applications use the API to add and edit campaigns, ads and keywords, set bids, and get statistics on impressions and clicks.
Structure of the API
The Yandex.Direct API consists of web services. Each service has its own URL.
Each service is intended for use with a particular class of objects: for example, the AdGroups service is used for managing ad groups, the Ads service is for advertisements, and so on.
A service provides a set of methods for performing various operations with objects. A service typically includes the following methods:
- add — Adding objects.
- update — Changing object parameters.
- delete — Deleting objects.
- get — Getting object parameters.
Services can also include other object-specific methods. For example, the moderate method in the Ads service is for submitting ads for review.
Access to the API
Both connection to the Yandex.Direct API and usage are free of charge.
API requests are made by an app on behalf of Yandex.Direct users — advertisers and advertising agencies. The API uses the OAuth 2.0 protocol for authentication. The access token must be included in requests.
The developer of an app that makes API requests must register the app beforehand.
API requests are made over the HTTPS protocol using the POST method. The access token and other special parameters are passed in the HTTP header. Input and output data structures are passed in the body of the request and response.
The Yandex.Direct API supports two formats: JSON and SOAP/XML.