# Настройка live-задач «Эффективность ключевых слов Bing»

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/keywords_data/bing/keyword_performance/live`

**Tags:** DataForSEO

Как список `keywords` работает в Bing Ads при заданных `device` и типе `match`. ⚠️ **`language_name` обязателен, и его отсутствие сообщается как `Invalid Field: 'language_name'` внутри HTTP 200** — сообщение означает и отсутствие, и неверное значение. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200. Допустимые пары — в `get_dataforseo_keywords_bing_kw_performance_locales`. Парные эндпоинты submit и fetch выполняют ту же работу асинхронно и по той же цене — для пакетов, которые слишком велики, чтобы дожидаться их завершения.

### Справочная информация о ценах

- Тарификация: заявленная стоимость ответа.
- Справочная оценка запроса: USD 0.09.
- Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.

Только справочные метаданные, а не котировка для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "<em>ключевые слова</em><br><strong>обязательное поле</strong><br>максимальное количество ключевых слов: 1000<br>максимальное количество символов в каждом ключевом слове: 80<br>максимальное количество слов в каждой ключевой фразе: 10<br>указанные ключевые слова приводятся к нижнему регистру, данные предоставляются в отдельном массиве<p>Подробнее о правилах и ограничениях полей <code>keyword</code> и <code>keywords</code> в API DataForSEO читайте в <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">статье Help Center</a>"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>тип устройства</em><br>необязательное поле<br>укажите это поле, чтобы получить данные для определённого типа устройства. Возможные значения: <code>desktop</code>, <code>mobile</code>, <code>tablet</code>, <code>all</code><br>значение по умолчанию: <code>all</code>"
          },
          "match": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>тип соответствия ключевых слов</em><br>необязательное поле<br>может принимать следующие значения:<br><code>aggregate</code> возвращает данные по всем типам соответствия;<br><code>broad</code> возвращает данные по всем пользовательским запросам, содержащим указанное ключевое слово с любым порядком слов;<br><code>phrase</code> возвращает данные по всем пользовательским запросам, содержащим указанное ключевое слово с тем же порядком слов;<br><code>exact</code> возвращает данные по пользовательскому запросу, соответствующему указанному ключевому слову;<strong>Примечание:</strong> по умолчанию применяется тип соответствия <code>aggregate</code>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>полное название местоположения поисковой системы</em><br><strong>обязательное поле, если не указаны</strong> <code>location_code</code> или <code>location_coordinate</code><br><strong>если используете это поле, <code>location_code</code> или <code>location_coordinate</code> указывать не нужно</strong><br>список доступных местоположений и языков можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>пример:<br><code>\"United States\"</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>код местоположения поисковой системы</em><br><strong>обязательное поле, если не указаны</strong> <code>location_name</code> или <code>location_coordinate</code><br><strong>если используете это поле, <code>location_name</code> или <code>location_coordinate</code> указывать не нужно</strong><br>список доступных местоположений и языков можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>пример:<br><code>2840</code>"
          },
          "location_coordinate": {
            "type": "string",
            "description": "<em>GPS-координаты местоположения</em><br><strong>обязательное поле, если не указаны</strong> <code>location_name</code> или <code>location_code</code><br><strong>если используете это поле, <code>location_name</code> или <code>location_code</code> указывать не нужно</strong><br>параметр <code>location_coordinate</code> указывается в формате <em>\"широта,долгота\"</em><br><strong>данные будут предоставлены для страны, к которой относятся указанные координаты</strong><br>пример:<br><code class=\"long-string\">52.6178549,-155.352142</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>полное название языка поисковой системы</em><br><strong>обязательное поле, если не указан</strong> <code>language_code</code><br><strong>если используете это поле, <code>language_code</code> указывать не нужно</strong><br>список доступных местоположений и языков можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>пример:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": "string",
            "description": "<em>код языка поисковой системы</em><br><strong>обязательное поле, если не указан</strong> <code>language_name</code><br>список доступных местоположений и языков можно получить отдельным запросом к <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>пример:<br><code>\"en\"</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          }
        },
        "example": [
          {
            "location_code": 2840,
            "language_code": "en",
            "keywords": [
              "dataforseo",
              "seo",
              "ranking"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "location_code": 2840,
      "language_code": "en",
      "keywords": [
        "dataforseo",
        "seo",
        "ranking"
      ]
    }
  ]
}
```

## Responses

### 200 — Успешная операция

Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResponseInfo"
    }
  ]
}
```

### 400 — Запрос не удалось обработать. Проверьте параметры запроса.

### 401 — Требуется действительный API-ключ Felo.

### 402 — Запрос не может быть выполнен: не выполнено требование биллинга.

### 403 — Аккаунту не разрешено выполнять эту операцию.

### 429 — Достигнут лимит запросов или расходов.

### 502 — Сервис не смог выполнить запрос.

### 503 — API или сервис биллинга временно недоступны.

### 504 — Истекло время ожидания обработки запроса.

### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "текущая версия API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "общий код состояния.\nПолный список кодов ответа можно найти здесь."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "общее информационное сообщение.\nПолный список общих информационных сообщений можно найти здесь."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "общее время выполнения, секунды"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "общая стоимость задач, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число задач в массиве tasks",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число задач в массиве tasks, возвращённых с ошибкой",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "идентификатор задачи\nуникальный идентификатор задачи в нашей системе в формате UUID"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "код состояния задачи\nформируется DataForSEO, может находиться в диапазоне 10000-60000\nПолный список кодов ответа можно найти здесь."
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "информационное сообщение задачи\nПолный список общих информационных сообщений можно найти здесь."
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "время выполнения, секунды"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "общая стоимость задач, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "число элементов в массиве result",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "путь URL"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "содержит те же параметры, что вы указали в POST-запросе"
    }
  }
}
```

### Response36Afe1097B20_KeywordKpi

`#/components/schemas/Response36Afe1097B20_KeywordKpi`

```json
{
  "type": "object",
  "properties": {
    "desktop": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_KeywordKpiItemInfo"
          }
        ]
      },
      "description": "<em>данные ключевого слова, агрегированные для настольных устройств</em><br>если данных нет, значение —_<code>null</code>n"
    },
    "mobile": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_KeywordKpiItemInfo"
          }
        ]
      },
      "description": "<em>данные ключевого слова, агрегированные для мобильных устройств</em><br>если данных нет, значение —_<code>null</code>n"
    },
    "tablet": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_KeywordKpiItemInfo"
          }
        ]
      },
      "description": "<em>данные ключевого слова, агрегированные для планшетов</em><br>если данных нет, значение —_<code>null</code>n"
    }
  }
}
```

### Response36Afe1097B20_KeywordKpiItemInfo

`#/components/schemas/Response36Afe1097B20_KeywordKpiItemInfo`

```json
{
  "type": "object",
  "properties": {
    "ad_position": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>позиция соответствующего объявления в SERP</em><br>может принимать следующие значения:<br><code>FirstPage1</code>: первое объявление, отображаемое справа на первой странице результатов поиска<br><code>FirstPage2</code>: второе объявление, отображаемое справа на первой странице результатов поиска<br><code>FirstPage3</code>: третье объявление, отображаемое справа на первой странице результатов поиска<br><code>FirstPage4</code>: четвёртое объявление, отображаемое справа на первой странице результатов поиска<br><code>FirstPage5</code>: пятое объявление, отображаемое справа на первой странице результатов поиска<br><code>FirstPage6</code>: шестое объявление, отображаемое справа на первой странице результатов поиска<br><code>FirstPage7</code>: седьмое объявление, отображаемое справа на первой странице результатов поиска<br><code>FirstPage8</code>: восьмое объявление, отображаемое справа на первой странице результатов поиска<br><code>FirstPage9</code>: девятое объявление, отображаемое справа на первой странице результатов поиска<br><code>FirstPage10</code>: десятое объявление, отображаемое справа на первой странице результатов поиска<br><code>MainLine1</code>: первое объявление, отображаемое в верхней части страницы результатов поиска<br><code>MainLine2</code>: второе объявление, отображаемое в верхней части страницы результатов поиска<br><code>MainLine3</code>: третье объявление, отображаемое в верхней части страницы результатов поиска<br><code>MainLine4</code>: четвёртое объявление, отображаемое в верхней части страницы результатов поиска"
    },
    "clicks": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>клики по объявлению</em><br>количество кликов, которое ключевое слово и тип соответствия сгенерировали за последний месяц"
    },
    "impressions": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>показы объявления</em><br>количество показов, которое ключевое слово и тип соответствия сгенерировали за последний месяц"
    },
    "average_cpc": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>средняя цена за клик, USD</em><br>рассчитывается делением стоимости всех кликов на количество кликов",
      "format": "double"
    },
    "ctr": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>кликабельность в процентах</em><br>рассчитывается делением количества кликов на количество показов и умножением результата на 100",
      "format": "double"
    },
    "total_cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>общая стоимость объявления, USD</em><br>стоимость использования указанного ключевого слова и типа соответствия за последний месяц",
      "format": "int64"
    },
    "average_bid": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>средняя ставка по ключевому слову</em>",
      "format": "double"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveTaskInfo"
              }
            ]
          },
          "description": "<em>массив задач</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResultInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ключевое слово в массиве POST</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>код местоположения в массиве POST</em><br>если данных нет, значение — <code>null</code>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>код языка в массиве POST</em><br>если данных нет, значение — <code>null</code>"
    },
    "year": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>год, за который предоставлены данные</em><br>пример:<br><code>2020</code>"
    },
    "month": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>месяц, за который предоставлены данные</em><br>пример:<br><code>10</code>"
    },
    "keyword_kpi": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_KeywordKpi"
        }
      ],
      "description": "<em>объект с метриками ключевого слова</em><br>если данных нет, значение —_<code>null</code>n"
    }
  }
}
```

### Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResultInfo"
              }
            ]
          },
          "description": "<em>массив результатов</em>"
        }
      }
    }
  ]
}
```