Отчет по индексации прайс-листа

Описание

GET /campaigns/{campaignId}/feeds/{feedId}/index-logs

Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.

Данные в отчете возвращаются в порядке убывания значений параметра generation-id.

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/feeds/{feedId}/index-logs.[format]

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

Параметр

Тип

Значение

Обязательные

campaignId

Int64

Идентификатор магазина.

feedId

Int64

Идентификатор прайс-листа.

Необязательные

limit

Int32

Количество записей в отчете по индексации прайс-листа в выходных данных.

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

Максимальное значение: 500.

Значение по умолчанию: 250.

Используется вместе с параметром offset.

Если задан limit, параметры page и pageSize игнорируются.

offset

Int32

Количество записей в отчете, которые нужно не отображать в выходных данных, начиная с последнего по времени.

Минимальное значение: 0.

Значение по умолчанию: 0.

Используется вместе с параметром limit.

Если задан offset, параметры page и pageSize игнорируются.

page

Int32

Номер страницы результатов.

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

Значение по умолчанию: 1.

Используется вместе с параметром pageSize.

page игнорируется, если задан limit и / или offset.

pageSize

Int32

Количество записей в отчете по индексации прайс-листа на странице.

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

Максимальное значение: 500.

Значение по умолчанию: 250.

Используется вместе с параметром page.

pageSize игнорируется, если задан limit и / или offset.

published_time_from

Data

Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс.Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

published_time_to

Data

Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс.Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.

Значение по умолчанию: дата и время отправки запроса.

Примечание. Если во время переключения между страницами выходных данных на Яндекс.Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.

status

Enum

Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.

  • OK — обработан без ошибок.

  • WARNING — наблюдались некритичные проблемы.

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

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

<response>
  <errors>
    <error code="{enum}" message="{string}"/>
    ...
  </errors>
  <result>
    <feed id="{int64}"/>
    <index-log-records>
      <index-log-record download-time="{date}" file-time="{date}" generation-id="{int64}" index-type="{enum}" published-time="{date}" status="{enum}">
        <error http-status-code="{int32}" type="{enum}">
          <description>{string}</description>
        </error>
        <offers rejected-count="{int32}" total-count="{int32}"/>
      </index-log-record>
      ...
    </index-log-records>
    <total>{int32}</total>
  </result>
  <status>{enum}</status>
</response>

Описание параметров:

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

response

Ответ.

Параметр выводится только для формата XML.

Параметры, вложенные в response

errorserrors

Список ошибок при выполнении запроса.

Выводится, если status="ERROR".

resultresult

Результат выполнения запроса.

Выводится, если status="OK".

statusstatusEnum

Статус выполнения запроса.

Возможные значения:

  • OK — запрос выполнен успешно.

  • ERROR — произошла ошибка.

Параметры, вложенные в errors

error

Информация об ошибке.

Параметр выводится только для формата XML.

Параметры, вложенные в error / errors

codecodeEnum

Код ошибки.

Возможные значения:

  • INVALID_FEED_ID — в path-параметре feedId передан некорректный идентификатор прайс-листа.

  • BAD_REQUEST — в параметре запроса передано некорректное значение. Например, в значении параметров published_time_from или published_time_to.

  • REQUEST_LIMIT_EXCEEDED — в параметре запроса limit или pageSize передано значение, больше максимально допустимого.

Для формата XML является атрибутом параметра error.

messagemessageString

Описание ошибки.

Для формата XML является атрибутом параметра error.

Параметры, вложенные в result

feedfeed

Информация о прайс-листе.

index-log-recordsindexLogRecords

Список отчетов по индексации прайс-листа.

totaltotalInt32

Количество отчетов на всех страницах выходных данных.

Параметры, вложенные в feed

ididInt64

Идентификатор прайс-листа.

Для формата XML является атрибутом параметра feed.

Параметры, вложенные в index-log-records

index-log-record

Отчет по индексации прайс-листа.

Параметр выводится только для формата XML.

Параметры, вложенные в index-log-record / indexLogRecords

download-timedownloadTimeDate

Дата и время загрузки прайс-листа.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Для формата XML является атрибутом параметра index-log-record.

file-timefileTimeDate

Дата и время, которые магазин указал в прайс-листе.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Для формата XML является атрибутом параметра index-log-record.

generation-idgenerationIdInt64

Идентификатор индексации.

Для формата XML является атрибутом параметра index-log-record.

index-typeindexTypeEnum

Тип обновления.

Возможные значения:

  • DIFF — частичное обновление данных на Яндекс.Маркете (например, обновление цен ранее опубликованных предложений и публикация новых).

  • FAST_PRICE — только обновление цен ранее опубликованных предложений.

  • FULL — полное обновление данных на Яндекс.Маркете.

Для формата XML является атрибутом параметра index-log-record.

published-timepublishedTimeDate

Дата и время публикации предложений из прайс-листа на Яндекс.Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Для формата XML является атрибутом параметра index-log-record.

statusstatusEnum

Статус индексации прайс-листа и проверки на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.

  • OK — обработан без ошибок.

  • WARNING — наблюдались некритичные проблемы.

Для формата XML является атрибутом параметра index-log-record.

errorerror

Информация об ошибке, произошедшей во время индексации прайс-листа.

Выводится, если во время индексации произошли ошибки (index-log-record status=ERROR).

offersoffers

Информация о предложениях прайс-листа.

Параметры, вложенные в error

http-status-codehttpStatusCodeInt32

HTTP-код ошибки индексации прайс-листа.

Выводится, если type=DOWNLOAD_HTTP_ERROR.

Для формата XML является атрибутом параметра error.

typetypeEnum

Тип ошибки индексации прайс-листа.

Возможные значения:

  • DOWNLOAD_ERROR — ошибка загрузки прайс-листа. Например, проблема с DNS-сервером или обрыв интернет-соединения.

    Проблема описана в параметре description.

  • DOWNLOAD_HTTP_ERROR — Яндекс.Маркет передал запрос на получение прайс-листа и получил в ответ HTTP-код, отличный от 2xx.

    HTTP-код выведен в параметре http-status-code.

  • PARSE_ERROR — ошибка при проверке прайс-листа, не связанная с форматом YML. Например, прайс-лист пустой или его не удалось разархивировать.

  • PARSE_XML_ERROR — несоответствие техническим требованиям формата YML. Например, элементы и их значения описаны некорректно.

  • TOO_MANY_REJECTED_OFFERS — более чем в половине предложений из прайс-листа найдены ошибки. Все предложения из прайс-листа не будут опубликованы на Яндекс.Маркете.

Для формата XML является атрибутом параметра error.

descriptiondescriptionString

Описание ошибки.

Выводится, если type=DOWNLOAD_ERROR.

Параметры, вложенные в offers

rejected-countrejectedCountInt32

Количество предложений, которые не опубликованы на Яндекс.Маркете из-за найденных ошибок.

Для формата XML является атрибутом параметра offers.

total-counttotalCountInt32

Количество предложений в прайс-листе.

Для формата XML является атрибутом параметра offers.

Описание ошибок

В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.

Примеры

Пример запроса:

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10001/feeds/12345/index-logs.xml?limit=2'

Пример ответа:

HTTP/1.1 200 OK
Date: Wed, 22 Nov 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <result>
    <feed id="12345"/>
    <index-log-records>
      <index-log-record download-time="2017-11-21T00:42:42+03:00" file-time="2017-11-20T00:42:42+03:00" generation-id="20321" index-type="FULL" published-time="2017-11-21T01:42:42+03:00" status="WARNING">
        <offers rejected-count="99" total-count="10231"/>
      </index-log-record>
      <index-log-record download-time="2017-11-21T15:42:42+03:00" file-time="2017-11-20T15:42:42+03:00" generation-id="20320" index-type="FAST_PRICE" published-time="2017-11-21T15:42:42+03:00" status="ERROR">
        <error type="DOWNLOAD_ERROR">
          <description>server status is no status code; ERR: errcode: 6, msg: Could not resolve host: nif-nif.yandex.ru</description>
        </error>
      </index-log-record>
    </index-log-records>
    <total>1229</total>
  </result>
  <status>OK</status>
</response>