---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://yandex.ru/dev/direct/doc/en/concepts/json.md
  - https://yandex.ru/dev/direct/doc/ru/concepts/json.md
sourcePath: en/dg/concepts/json.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/direct/doc/en/llms.txt

# JSON format

Many programming languages have modules and libraries for working with JSON. The recommended modules and libraries for popular languages are listed below.

- **Perl**: the [JSON](http://search.cpan.org/~makamaka/JSON-2.90/lib/JSON.pm) module.
- **PHP**: built-in JSON support starting from version 5.2.0.
- **Python**: the [json](https://docs.python.org/library/json.html) module.

## JSON requests{#json-request}

The address for requests is given in the documentation for each service.

The request always contains the `method` key with the name of the invoked method, and in most cases, it also includes the `params` key (see the example below). Some methods do not have any input parameters, so the `params` key is not required for them.

## Request example

Calling the `Ads.add` method to create ads for the advertiser `agrom`. Performed in the name of an advertising agency.

```javascript
POST /json/v5/ads/ HTTP/1.1
Host: api.direct.yandex.com
Authorization: Bearer 0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f
Accept-Language: ru
Client-Login: agrom
Content-Type: application/json; charset=utf-8

{
"method": "add",
"params": {
    "Ads": [{
    "AdGroupId": 1234567,
    "TextAd": {
        "Text": "All breeds of elephants. Certified breeder",
        "Title": "Buy an elephant!",
        "Href": "http://exotic-farm.com/elefants",
        "Mobile": "NO"
    }
    },
    {
    "AdGroupId": 1234567,
    "TextAd": {
        "Text": "Rhino delivery. Spring sale.",
        "Title": "Buy a rhinoceros!",
        "Mobile": "NO"
    }
    }]
}
}
```

## Response example

```javascript
HTTP/1.1 200 OK
Connection:close
Content-Type:application/json; charset=utf-8
Date:Fri, 28 Nov 2014 17:07:02 GMT
RequestId:1010101010101010101
Units:10/20828/64000
Units-Used-Login:agrom
Server:nginx
Transfer-Encoding:chunked

{
"result": {
    "AddResults": [{
    "Id": 7654321
    }, /* Ad created and its ID returned */
    {
    "Errors": [{
        "Code": 6000,
        "Message": "Inconsistent object state",
        "Details": "The ad must specify the vCard or the main link"
    }] /* Error creating ad */
    }]
}
}
```

## Error example

If the request could not be processed, an error message is returned.

```javascript
HTTP/1.1 200 OK
Connection:close
Content-Type:application/json; charset=utf-8
Date:Fri, 28 Nov 2014 17:07:02 GMT
RequestId:1010101010101010101
Units:10/20828/64000
Units-Used-Login:agrom
Server:nginx
Transfer-Encoding:chunked

{
"error" : {
    "request_id": "1010101010101010101",
    "error_code": 8000,
    "error_string": "Invalid request",
    "error_detail": "TextAd is missing the required Text field"
}
}
```

For more information about errors, see the Errors section.

## Learn more

- [Description of the JSON format](http://www.json.org/json-ru.html)