mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 04:20:52 +00:00
76 KiB
76 KiB
GetMediaMetaDataMetadata
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
rating_key |
::String | ✔️ | The rating key of the metadata item. | 44288 |
parent_rating_key |
T.nilable(::String) | ➖ | The rating key of the parent of this metadata item. | 48047 |
grandparent_rating_key |
T.nilable(::String) | ➖ | The rating key of the grandparent of this metadata item. | 45520 |
parent_guid |
T.nilable(::String) | ➖ | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
grandparent_guid |
T.nilable(::String) | ➖ | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
grandparent_slug |
T.nilable(::String) | ➖ | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
grandparent_key |
T.nilable(::String) | ➖ | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
parent_key |
T.nilable(::String) | ➖ | A key identifying the parent metadata in the library. | /library/metadata/48047 |
key |
::String | ✔️ | The API key to access metadata details. | /library/metadata/44288/children |
guid |
::String | ✔️ | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
slug |
T.nilable(::String) | ➖ | A URL-friendly identifier for the item. | better-call-saul |
studio |
T.nilable(::String) | ➖ | The studio that produced the content. | Sony Pictures Television |
type |
::String | ✔️ | The type of content (e.g., show, movie). | show |
title |
::String | ✔️ | The title of the content. | Better Call Saul |
original_title |
T.nilable(::String) | ➖ | The original title of the content. | Wicked: Part I |
library_section_title |
::String | ✔️ | The title of the library section. | TV Series |
library_section_id |
::Integer | ✔️ | The ID of the library section. | 2 |
library_section_key |
::String | ✔️ | The key of the library section. | /library/sections/2 |
content_rating |
T.nilable(::String) | ➖ | The content rating (e.g., TV-MA). | TV-MA |
summary |
::String | ✔️ | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
index |
T.nilable(::Integer) | ➖ | The index or order of the item. | 1 |
grandparent_title |
T.nilable(::String) | ➖ | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
parent_title |
T.nilable(::String) | ➖ | The title of the parent entity (typically the season's title). | Season 2 |
audience_rating |
T.nilable(::Float) | ➖ | The audience rating for the content. | 8.7 |
view_count |
T.nilable(::Integer) | ➖ | The number of times the item has been viewed. | 4 |
skip_count |
T.nilable(::Integer) | ➖ | The number of times the item has been skipped. | 1 |
last_viewed_at |
T.nilable(::Integer) | ➖ | Unix timestamp of when the item was last viewed. | 1625764795 |
year |
::Integer | ✔️ | The release year. | 2015 |
rating |
T.nilable(::Float) | ➖ | The general rating | 6 |
rating_image |
T.nilable(::String) | ➖ | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
tagline |
T.nilable(::String) | ➖ | The tagline of the content. | Make the call |
chapter_source |
T.nilable(::String) | ➖ | N/A | media |
primary_extra_key |
T.nilable(::String) | ➖ | N/A | /library/metadata/134704 |
thumb |
::String | ✔️ | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
art |
::String | ✔️ | URL of the art image. | /library/metadata/44288/art/1736487993 |
theme |
T.nilable(::String) | ➖ | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
duration |
::Integer | ✔️ | Duration of the content in milliseconds. | 2700000 |
originally_available_at |
DateTime | ➖ | The original release date. | 2015-02-08 |
leaf_count |
T.nilable(::Integer) | ➖ | The total number of episodes (or leaves). | 63 |
viewed_leaf_count |
T.nilable(::Integer) | ➖ | The number of episodes that have been viewed. | 4 |
child_count |
T.nilable(::Integer) | ➖ | The number of child items. | 6 |
added_at |
::Integer | ✔️ | N/A | 1556281940 |
updated_at |
::Integer | ✔️ | N/A | 1556281940 |
audience_rating_image |
T.nilable(::String) | ➖ | The URL for the audience rating image. | themoviedb://image.rating |
parent_index |
T.nilable(::Integer) | ➖ | The index number of the parent entity, which could indicate its order or position. | 2 |
parent_thumb |
T.nilable(::String) | ➖ | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
grandparent_thumb |
T.nilable(::String) | ➖ | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
grandparent_art |
T.nilable(::String) | ➖ | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
media |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataMedia> | ➖ | N/A | |
image |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataImage> | ✔️ | An array of image objects. | |
ultra_blur_colors |
::PlexRubySDK::Operations::GetMediaMetaDataUltraBlurColors | ✔️ | N/A | |
genre |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataGenre> | ➖ | An array of genre tags. | |
country |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataCountry> | ➖ | An array of country tags. | |
guids |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataGuids> | ➖ | An array of GUID objects. | |
ratings |
T::Array<::PlexRubySDK::Operations::Ratings> | ➖ | An array of rating objects. | |
role |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataRole> | ➖ | An array of Actor roles. | |
director |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataDirector> | ➖ | An array of Director roles. | |
writer |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataWriter> | ➖ | An array of Writer roles. | |
producer |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataProducer> | ➖ | An array of Writer roles. | |
similar |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataSimilar> | ➖ | An array of similar content objects. | |
location |
T::Array<::PlexRubySDK::Operations::GetMediaMetaDataLocation> | ➖ | An array of location objects. |