Список опубликованных ресурсов

API возвращает список опубликованных ресурсов на Диске пользователя. Ресурсы в списке отсортированы от опубликованных позже к опубликованным раньше.

Список можно фильтровать по типу ресурса — получать только файлы или только папки.

Формат запросаФормат запроса

Запрос опубликованных ресурсов следует отправлять с помощью метода GET.

https://cloud-api.yandex.net/v1/disk/resources/public
 ? [limit=<количество файлов в списке>]
 & [offset=<смещение относительно начала списка>]
 & [type=<тип запрашиваемых файлов>]
 & [fields=<свойства, которые нужно включить в ответ>]
 & [preview_size=<размер превью>]

limit

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

Значение по умолчанию — 20.

offset

Количество ресурсов с начала списка, которые следует опустить в ответе (например, для постраничного вывода).

Допустим, на Диске три опубликованных файла. Если запросить их список с параметром offset=1, API Диска вернет только описания второго и третьего файлов.

type

Тип ресурса. Допустимые значения:

• "dir" — папка;
• "file" — файл.

fields

Список свойств JSON, которые следует включить в ответ. Ключи, не указанные в этом списке, будут отброшены при составлении ответа. Если параметр не указан, ответ возвращается полностью, без сокращений.

Имена ключей следует указывать через запятую, а вложенные ключи разделять точками. Например: name,_embedded.items.path.

preview_size

Требуемый размер уменьшенного изображения (превью файла), ссылку на которое Диск должен вернуть в ключе preview.

Вы можете задать как точный размер превью, так и размер одной из сторон. Получившееся изображение можно обрезать до квадрата с помощью параметра preview_crop.

Варианты значений

• Предопределенный размер большей стороны.

  Картинка уменьшается до указанного размера по большей стороне, пропорции исходного изображения сохраняются. Например, для размера S и картинки размером 120×200 будет сгененерировано превью размером 90×150, а для картинки 300×100 — превью размером 150×50.

  Поддерживаемые значения:

  -"S" — 150 пикселей;
  -"M" — 300 пикселей;
  -"L" — 500 пикселей;
  -"XL" — 800 пикселей;
  -"XXL" — 1024 пикселей;
  -"XXXL" — 1280 пикселей.

• Точная ширина (например, "120" или "120x") или точная высота (например, "x145").

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

  Если передан параметр preview_crop, из центра уменьшенного изображения также вырезается квадрат с заданной стороной.

• Точный размер (в формате <ширина>x<высота>, например "120x240").

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

  Если передан параметр preview_crop, из центра оригинального изображения вырезается фрагмент максимального размера в заданных пропорциях ширины и высоты (в примере — один к двум). Затем вырезанный фрагмент масштабируется до указанных размеров.

Формат ответаФормат ответа

Если запрос был обработан без ошибок, API отвечает кодом 200 OK, и возвращает метаинформацию о запрошенном количестве файлов в теле ответа, в объекте PublicResourcesList.

Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.

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

{
   "items": [
      {
        "public_key": "HQsmHLoeyBlJf8Eu1jlmzuU+ZaLkjPkgcvmokRUCIo8=",
        "name": "photo2.png",
        "preview": "https://downloader.disk.yandex.ru/preview/...",
        "created": "2014-04-22T14:57:13+04:00",
        "modified": "2014-04-22T14:57:14+04:00",
        "path": "disk:/foo/photo2.png",
        "md5": "53f4dc6379c8f95ddf11b9508cfea271",
        "type": "file",
        "mime_type": "image/png",
        "size": 54321
      },
      {
        "public_key": "kLsmHRoeyBlJf8Eu1jlmzuU+ZaLkjPkgcvmokRUCIo8=",
        "name": "photo1.png",
        "preview": "https://downloader.disk.yandex.ru/preview/...",
        "created": "2014-04-21T14:57:13+04:00",
        "modified": "2014-04-21T14:57:14+04:00",
        "path": "disk:/foo/photo1.png",
        "md5": "4334dc6379c8f95ddf11b9508cfea271",
        "type": "file",
        "mime_type": "image/png",
        "size": 34567
      }
    ],
    "type": "file",
    "limit": 20,
    "offset": 0
  }

Описание элементов ответа