CreateOfflineReport (Live)

Запускает на сервере формирование отчета о динамических текстовых объявлениях.

Внимание. Метод отключен. Используйте API версии 5.

Последовательность шагов для получения отчета:

  1. Чтобы сформировать отчет, вызовите метод CreateOfflineReport (Live).

    Метод возвращает идентификатор будущего отчета.

    Для одного пользователя на сервере хранится не более пяти отчетов. При попытке сформировать шестой отчет возвращается сообщение об ошибке. Отчеты хранятся в течение трех месяцев, а затем автоматически удаляются. С помощью метода DeleteOfflineReport (Live) можно удалить отчет вручную.

  2. Периодически вызывайте метод GetOfflineReportList (Live) и проверяйте готовность отчета по его идентификатору.
  3. Когда отчет готов, cкачайте файл отчета по ссылке, которую вернул метод GetOfflineReportList (Live).

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

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

{
   "method": "CreateOfflineReport",
   "param": {
      /* CreateOfflineReportRequest */
      "Type": (string),
      "CampaignIds": [
         (int)
         ...
      ],
      "StartDate": (date),
      "EndDate": (date),
      "ImpressionsThreshold": (int),
      "ClicksThreshold": (int),
      "GroupByDate": (string),
      "FieldNames": [
         (string)
         ...
      ]
   }
}

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

Параметр Описание Требуется
Объект CreateOfflineReportRequest
Type

Тип кампаний, для которых формируется отчет.

Допускается только значение dynamic_text_ad.

 Да
CampaignIds

Массив идентификаторов кампаний, для которых формируется отчет (не более 2).

Допускается указывать только кампании с типом «Динамические текстовые объявления», в противном случае возвращается ошибка.

 Да
StartDate Начальная дата отчетного периода, YYYY-MM-DD. Отчетный период не должен начинаться более чем за 3 месяца от текущей даты. Да
EndDate Конечная дата отчетного периода, YYYY-MM-DD. Да
ImpressionsThreshold

Порог по количеству показов: в отчете будут присутствовать только строки с количеством показов не менее указанного порога.

Минимальное значение — 10.

 Нет
ClicksThreshold

Порог по количеству кликов: в отчете будут присутствовать только строки с количеством кликов не менее указанного порога.

Минимальное значение — 1.

Примечание. Если указаны одновременно оба параметра ClicksThreshold и ImpressionsThreshold, то в отчете будут присутствовать сроки, в которых достигнут хотя бы один из порогов.
Нет
GroupByDate

Рассчитывать суммарную статистику по периодам времени:

  • day — по дням (значение по умолчанию);
  • week — по неделям;
  • month — по месяцам.
 Нет
FieldNames Названия столбцов, которые требуется выводить в отчете. Список столбцов см. в подразделе Пример отчета описания метода GetOfflineReportList (Live). Да
Параметр Описание Требуется
Объект CreateOfflineReportRequest
Type

Тип кампаний, для которых формируется отчет.

Допускается только значение dynamic_text_ad.

 Да
CampaignIds

Массив идентификаторов кампаний, для которых формируется отчет (не более 2).

Допускается указывать только кампании с типом «Динамические текстовые объявления», в противном случае возвращается ошибка.

 Да
StartDate Начальная дата отчетного периода, YYYY-MM-DD. Отчетный период не должен начинаться более чем за 3 месяца от текущей даты. Да
EndDate Конечная дата отчетного периода, YYYY-MM-DD. Да
ImpressionsThreshold

Порог по количеству показов: в отчете будут присутствовать только строки с количеством показов не менее указанного порога.

Минимальное значение — 10.

 Нет
ClicksThreshold

Порог по количеству кликов: в отчете будут присутствовать только строки с количеством кликов не менее указанного порога.

Минимальное значение — 1.

Примечание. Если указаны одновременно оба параметра ClicksThreshold и ImpressionsThreshold, то в отчете будут присутствовать сроки, в которых достигнут хотя бы один из порогов.
Нет
GroupByDate

Рассчитывать суммарную статистику по периодам времени:

  • day — по дням (значение по умолчанию);
  • week — по неделям;
  • month — по месяцам.
 Нет
FieldNames Названия столбцов, которые требуется выводить в отчете. Список столбцов см. в подразделе Пример отчета описания метода GetOfflineReportList (Live). Да

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

Метод возвращает идентификатор формируемого отчета, как показано в следующем примере.

{
   "data": 1234567
}

Описание данных, выводимых в отчете, см. в подразделе Пример отчета описания метода GetOfflineReportList (Live).