mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 04:20:52 +00:00
90 KiB
90 KiB
GetLibraryItemsMetadata
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
rating_key |
::String | ✔️ | The rating key (Media ID) of this media item. Note: This is always an integer, but is represented as a string in the API. |
58683 |
key |
::String | ✔️ | N/A | /library/metadata/58683 |
guid |
::String | ✔️ | N/A | plex://movie/5d7768ba96b655001fdc0408 |
studio |
T.nilable(::String) | ➖ | N/A | 20th Century Studios |
skip_children |
T.nilable(T::Boolean) | ➖ | N/A | false |
library_section_id |
T.nilable(::Integer) | ➖ | N/A | 1 |
library_section_title |
T.nilable(::String) | ➖ | N/A | Movies |
library_section_key |
T.nilable(::String) | ➖ | N/A | /library/sections/1 |
type |
::PlexRubySDK::Operations::GetLibraryItemsLibraryType | ✔️ | The type of media content |
movie |
title |
::String | ✔️ | N/A | Avatar: The Way of Water |
slug |
T.nilable(::String) | ➖ | N/A | 4-for-texas |
content_rating |
T.nilable(::String) | ➖ | N/A | PG-13 |
summary |
::String | ✔️ | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
rating |
T.nilable(::Float) | ➖ | N/A | 7.6 |
audience_rating |
T.nilable(::Float) | ➖ | N/A | 9.2 |
year |
T.nilable(::Integer) | ➖ | N/A | 2022 |
season_count |
T.nilable(::Integer) | ➖ | N/A | 2022 |
tagline |
T.nilable(::String) | ➖ | N/A | Return to Pandora. |
flatten_seasons |
T.nilable(::PlexRubySDK::Operations::FlattenSeasons) | ➖ | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
episode_sort |
T.nilable(::PlexRubySDK::Operations::EpisodeSort) | ➖ | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
enable_credits_marker_generation |
T.nilable(::PlexRubySDK::Operations::EnableCreditsMarkerGeneration) | ➖ | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
show_ordering |
T.nilable(::PlexRubySDK::Operations::ShowOrdering) | ➖ | Setting that indicates the episode ordering for the show. None = Library default, tmdbAiring = The Movie Database (Aired), aired = TheTVDB (Aired), dvd = TheTVDB (DVD), absolute = TheTVDB (Absolute)). |
absolute |
thumb |
T.nilable(::String) | ➖ | N/A | /library/metadata/58683/thumb/1703239236 |
art |
T.nilable(::String) | ➖ | N/A | /library/metadata/58683/art/1703239236 |
banner |
T.nilable(::String) | ➖ | N/A | /library/metadata/58683/banner/1703239236 |
duration |
T.nilable(::Integer) | ➖ | N/A | 11558112 |
originally_available_at |
DateTime | ➖ | N/A | 2022-12-14 00:00:00 +0000 UTC |
added_at |
::Integer | ✔️ | Unix epoch datetime in seconds | 1556281940 |
updated_at |
T.nilable(::Integer) | ➖ | Unix epoch datetime in seconds | 1556281940 |
audience_rating_image |
T.nilable(::String) | ➖ | N/A | rottentomatoes://image.rating.upright |
chapter_source |
T.nilable(::String) | ➖ | N/A | media |
primary_extra_key |
T.nilable(::String) | ➖ | N/A | /library/metadata/58684 |
rating_image |
T.nilable(::String) | ➖ | N/A | rottentomatoes://image.rating.ripe |
grandparent_rating_key |
T.nilable(::String) | ➖ | N/A | 66 |
grandparent_guid |
T.nilable(::String) | ➖ | N/A | plex://show/5d9c081b170e24001f2a7be4 |
grandparent_key |
T.nilable(::String) | ➖ | N/A | /library/metadata/66 |
grandparent_title |
T.nilable(::String) | ➖ | N/A | Caprica |
grandparent_thumb |
T.nilable(::String) | ➖ | N/A | /library/metadata/66/thumb/1705716261 |
parent_slug |
T.nilable(::String) | ➖ | N/A | alice-in-borderland-2020 |
grandparent_slug |
T.nilable(::String) | ➖ | N/A | alice-in-borderland-2020 |
grandparent_art |
T.nilable(::String) | ➖ | N/A | /library/metadata/66/art/1705716261 |
grandparent_theme |
T.nilable(::String) | ➖ | N/A | /library/metadata/66/theme/1705716261 |
media |
T::Array<::PlexRubySDK::Operations::GetLibraryItemsMedia> | ➖ | The Media object is only included when type query is 4 or higher. |
|
genre |
T::Array<::PlexRubySDK::Operations::GetLibraryItemsGenre> | ➖ | N/A | |
country |
T::Array<::PlexRubySDK::Operations::GetLibraryItemsCountry> | ➖ | N/A | |
director |
T::Array<::PlexRubySDK::Operations::GetLibraryItemsDirector> | ➖ | N/A | |
writer |
T::Array<::PlexRubySDK::Operations::GetLibraryItemsWriter> | ➖ | N/A | |
collection |
T::Array<::PlexRubySDK::Operations::GetLibraryItemsCollection> | ➖ | N/A | |
role |
T::Array<::PlexRubySDK::Operations::GetLibraryItemsRole> | ➖ | N/A | |
location |
T::Array<::PlexRubySDK::Operations::GetLibraryItemsLocation> | ➖ | N/A | |
media_guid |
T::Array<::PlexRubySDK::Operations::MediaGuid> | ➖ | The Guid object is only included in the response if the includeGuids parameter is set to 1. |
|
ultra_blur_colors |
T.nilable(::PlexRubySDK::Operations::GetLibraryItemsUltraBlurColors) | ➖ | N/A | |
meta_data_rating |
T::Array<::PlexRubySDK::Operations::MetaDataRating> | ➖ | N/A | |
image |
T::Array<::PlexRubySDK::Operations::GetLibraryItemsImage> | ➖ | N/A | |
title_sort |
T.nilable(::String) | ➖ | N/A | Whale |
view_count |
T.nilable(::Integer) | ➖ | N/A | 1 |
last_viewed_at |
T.nilable(::Integer) | ➖ | N/A | 1682752242 |
original_title |
T.nilable(::String) | ➖ | N/A | 映画 ブラッククローバー 魔法帝の剣 |
view_offset |
T.nilable(::Integer) | ➖ | N/A | 5222500 |
skip_count |
T.nilable(::Integer) | ➖ | N/A | 1 |
index |
T.nilable(::Integer) | ➖ | N/A | 1 |
theme |
T.nilable(::String) | ➖ | N/A | /library/metadata/1/theme/1705636920 |
leaf_count |
T.nilable(::Integer) | ➖ | N/A | 14 |
viewed_leaf_count |
T.nilable(::Integer) | ➖ | N/A | 0 |
child_count |
T.nilable(::Integer) | ➖ | N/A | 1 |
has_premium_extras |
T.nilable(::String) | ➖ | N/A | 1 |
has_premium_primary_extra |
T.nilable(::String) | ➖ | N/A | 1 |
parent_rating_key |
T.nilable(::String) | ➖ | The rating key of the parent item. |
66 |
parent_guid |
T.nilable(::String) | ➖ | N/A | plex://show/5d9c081b170e24001f2a7be4 |
parent_studio |
T.nilable(::String) | ➖ | N/A | UCP |
parent_key |
T.nilable(::String) | ➖ | N/A | /library/metadata/66 |
parent_title |
T.nilable(::String) | ➖ | N/A | Caprica |
parent_index |
T.nilable(::Integer) | ➖ | N/A | 1 |
parent_year |
T.nilable(::Integer) | ➖ | N/A | 2010 |
parent_thumb |
T.nilable(::String) | ➖ | N/A | /library/metadata/66/thumb/1705716261 |
parent_theme |
T.nilable(::String) | ➖ | N/A | /library/metadata/66/theme/1705716261 |