---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.2
alternate:
  - https://yandex.com/dev/direct/doc/dg-v4/en/live/Keyword_Get.md
  - https://yandex.com/dev/direct/doc/dg-v4/ru/live/Keyword_Get.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/dg-v4/en/llms.txt

# Get
Returns keyword productivity values. The keywords may be for different campaigns or ad groups.

{% note alert %}

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions Live 4 and 5, see the [Migration guide](https://yandex.com/dev/direct/doc/migration/concepts/methods.md).

{% endnote %}


## Restrictions


{% note alert %}

This method only supports campaigns with the “Text & Image Ads” type. To manage keywords in all types of campaigns, use the [Keywords](https://yandex.com/dev/direct/doc/ref-v5keywords/keywords.md) service in version 5 of the API.

{% endnote %}


## Input data

The input data structure in JSON is shown below.

```javascript
{
   "method": "Keyword",
   "param": {
      /* KeywordRequest */
      "Action": (string),
      "Login": (string),
      "KeywordIDS": [
         (long)
         ...
      ]
   }
}
```

Parameters are described below.


#|
||
**<sup >Parameter</sup>**
|
**<sup >Description</sup>**
|
**<sup >Required</sup>**
||

||
**<sub >KeywordRequest object</sub>**
||
||
`Action`
|
Action: Get.
|
Yes
||
||
`Login`
|
The username of the client to perform the operation for.

A direct advertiser can optionally specify the username of a [chief representative](https://yandex.ru/support/direct/campaigns/representatives.xml)[chief representative](https://yandex.com/support/direct/campaigns/representatives.xml).
|
For agencies
||
||
`KeywordIDS`
|
Array of keywords IDs (maximum 10,000).
|
Yes
||
|#

## Output data

The output data structure in JSON is shown below.

```javascript
{
   "data": {
      /* KeywordResponse */
      "ActionsResult": [
         {  /* KeywordActionResult */
            "KeywordID": (long),
            "QualityIndex": {
               /* QualityIndex */
               "Value": (decimal),
               "References": [
                  (int)
                  ...
               ]
            },
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ]
         }
         ...
      ]
   }
}
```

Parameters are described below.


#|
||
**<sup >Parameter</sup>**
|
**<sup >Description</sup>**
||

||
**<sub >KeywordResponse object</sub>**
||
||
`ActionsResult`
|
Array of `KeywordActionResult` objects. Each object corresponds to an item in the `KeywordIDS` input array and contains:
- Keyword ID.
- Keyword productivity.
- An array of `Errors` if data could not be obtained for the keyword.
||

||
**<sub >KeywordActionResult object</sub>**
||
||
`KeywordID`
|
Keyword ID.
||
||
`QualityIndex`
|
An object containing the keyword's productivity value and recommendations for improving it.
||
||
`Errors`
|
Array of `Error` objects with errors that occurred while performing the operation.
||

||
**<sub >QualityIndex object</sub>**
||
||
`Value`
|
Productivity value for the keyword (to the first decimal place).
||
||
`References`
|
Array of numbers of recommendations for this keyword. To get the list of recommendations, use the [Dictionaries](https://yandex.com/dev/direct/doc/ref-v5dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/ref-v5dictionaries/get.md) method for the API version 5.
||

||
**<sub >Error object</sub>**
||
||
`FaultCode`
|
Error code.
||
||
`FaultString`
|
Textual message about the error.
||
||
`FaultDetail`
|
Detailed description of the reason for the error.
||
|#

## Examples of input data

# Python

```python
{
   'Action': 'Get',
   'Login': 'agrom',
   'KeywordIDS': [199381759,199482870,200725193]
}
```

# PHP

```php
array(
   'Action' => 'Get',
   'Login' => 'agrom',
   'KeywordIDS' => array(199381759,199482870,200725193)
)
```

# Perl

```perl
{
   'Action' => 'Get',
   'Login' => 'agrom',
   'KeywordIDS' => [199381759,199482870,200725193]
}
```