Метатеги

class yandex_music._client_async.metatags.MetatagsMixin

Метатеги.

Миксин для методов, связанных с метатегами (подборки по настроениям, занятиям, жанрам и эпохам).

async metatags(*args, **kwargs)

Получение дерева метатегов.

Parameters:

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Дерево метатегов или None.

Return type:

yandex_music.Metatags | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async metatag(metatag_id, tracks_count=None, artists_count=None, composers_count=None, albums_count=None, promotions_count=None, features_count=None, playlists_count=None, concerts_count=None, tracks_sort_by=None, albums_sort_by=None, with_likes_count=None, *args, **kwargs)

Получение информации о метатеге.

Note

Известные значения для tracks_sort_by и albums_sort_by: popular, new.

Поля tracks, composers, promotions, features и concerts в модели yandex_music.Metatag не представлены, так как во всех опробованных метатегах возвращали пустой список.

Parameters:

  • metatag_id (str) – Идентификатор метатега.

  • tracks_count (int, optional) – Количество треков в ответе.

  • artists_count (int, optional) – Количество артистов в ответе.

  • composers_count (int, optional) – Количество композиторов в ответе.

  • albums_count (int, optional) – Количество альбомов в ответе.

  • promotions_count (int, optional) – Количество промоакций в ответе.

  • features_count (int, optional) – Количество фич в ответе.

  • playlists_count (int, optional) – Количество плейлистов в ответе.

  • concerts_count (int, optional) – Количество концертов в ответе.

  • tracks_sort_by (str, optional) – Параметр сортировки треков.

  • albums_sort_by (str, optional) – Параметр сортировки альбомов.

  • with_likes_count (bool, optional) – Возвращать ли количество лайков.

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Метатег или None.

Return type:

yandex_music.Metatag | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async metatag_albums(metatag_id, period=None, sort_by=None, offset=0, limit=25, *args, **kwargs)

Получение альбомов метатега.

Note

Известные значения для sort_by: popular, new.

Parameters:

  • metatag_id (str) – Идентификатор метатега.

  • period (str, optional) – Период выборки.

  • sort_by (str, optional) – Параметр сортировки.

  • offset (int, optional) – Смещение от начала списка.

  • limit (int, optional) – Количество альбомов на странице.

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница списка альбомов метатега или None.

Return type:

yandex_music.MetatagAlbums | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async metatag_artists(metatag_id, period='week', sort_by=None, offset=0, limit=25, tracks_per_artist=None, *args, **kwargs)

Получение артистов метатега.

Note

Параметр period обязателен (без него API возвращает ошибку валидации). Известные значения для period: week, month, day. Известные значения для sort_by: popular.

Parameters:

  • metatag_id (str) – Идентификатор метатега.

  • period (str, optional) – Период выборки.

  • sort_by (str, optional) – Параметр сортировки.

  • offset (int, optional) – Смещение от начала списка.

  • limit (int, optional) – Количество артистов на странице.

  • tracks_per_artist (int, optional) – Количество популярных треков на артиста.

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница списка артистов метатега или None.

Return type:

yandex_music.MetatagArtists | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async metatag_playlists(metatag_id, sort_by=None, offset=0, limit=25, with_likes_count=None, *args, **kwargs)

Получение плейлистов метатега.

Note

Известные значения для sort_by: popular, new.

Parameters:

  • metatag_id (str) – Идентификатор метатега.

  • sort_by (str, optional) – Параметр сортировки.

  • offset (int, optional) – Смещение от начала списка.

  • limit (int, optional) – Количество плейлистов на странице.

  • with_likes_count (bool, optional) – Возвращать ли количество лайков.

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница списка плейлистов метатега или None.

Return type:

yandex_music.MetatagPlaylists | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.