---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
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
  - href: ru/live/Keyword_Get.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/dg-v4/ru/llms.txt

# Get
Возвращает значения продуктивности фраз. Фразы могут относиться к разным кампаниям или группам объявлений.



## Ограничения

<!-- source: ru/_includes/live/Keyword_Suspend/id-Keyword_Suspend/keyword-types.md -->
{% note alert %}

Метод поддерживает только кампании с типом “Текстово-графические объявления”“Text & Image Ads”. Для управления фразами в кампаниях всех типов используйте сервис [Keywords](https://yandex.ru/dev/direct/doc/ru/keywords/keywords) API версии 5.

{% endnote %}
<!-- endsource: ru/_includes/live/Keyword_Suspend/id-Keyword_Suspend/keyword-types.md -->


## Входные данные

Ниже показана структура входных данных в формате JSON.

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

Ниже приведено описание параметров.


#|
||
**Параметр**
|
**Описание**
|
**Требуется**
||

||
**Объект KeywordRequest**
||
||
`Action`
|
Выполняемая операция: Get.
|
Да
||
||
`Login`
|
Логин клиента, для которого нужно выполнить операцию.

Прямой рекламодатель может опционально указать логин своего [главного представителя](https://yandex.ru/support/direct/campaigns/representatives.xml)[главного представителя](https://yandex.com/support/direct/campaigns/representatives.xml).
|
Для агентств
||
||
`KeywordIDS`
|
Массив идентификаторов фраз (не более 10 000).
|
Да
||
|#

## Результирующие данные

Ниже показана структура результирующих данных в формате JSON.

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

Ниже приведено описание параметров.


#|
||
**Параметр**
|
**Описание**
||

||
**Объект KeywordResponse**
||
||
`ActionsResult`
|
Массив объектов `KeywordActionResult`. Каждый объект соответствует элементу входного массива `KeywordIDS` и содержит:
- идентификатор ключевой фразы;
- значение продуктивности фразы;
- массив ошибок `Errors`, в случае если получить данные для фразы не удалось.
||

||
**Объект KeywordActionResult**
||
||
`KeywordID`
|
Идентификатор ключевой фразы.
||
||
`QualityIndex`
|
Объект, содержащий значение продуктивности фразы и рекомендации по его повышению.
||
||
`Errors`
|
Массив объектов `Error` — ошибок, возникших при выполнении операции.
||

||
**Объект QualityIndex**
||
||
`Value`
|
Значение продуктивности фразы (до 1 знака после запятой).
||
||
`References`
|
Массив номеров рекомендаций для данной фразы. Справочник рекомендаций можно получить с помощью метода [Dictionaries](https://yandex.ru/dev/direct/doc/ru/dictionaries/dictionaries).[get](https://yandex.ru/dev/direct/doc/ru/dictionaries/get) API версии 5.
||

||
**Объект Error**
||
||
`FaultCode`
|
Код ошибки.
||
||
`FaultString`
|
Текст сообщения об ошибке.
||
||
`FaultDetail`
|
Подробное описание причины ошибки.
||
|#

## Примеры входных данных

# 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]
}
```