mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-09 20:57:43 +00:00
66 lines
74 KiB
Markdown
66 lines
74 KiB
Markdown
# GetMediaMetaDataMetadata
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `rating_key` | *::String* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
|
|
| `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
|
|
| `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
|
|
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
|
|
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
|
|
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
|
|
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
|
|
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
|
|
| `key` | *::String* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
|
|
| `guid` | *::String* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
|
|
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
|
|
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
|
|
| `type` | *::String* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
|
|
| `title` | *::String* | :heavy_check_mark: | The title of the content. | Better Call Saul |
|
|
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
|
|
| `library_section_title` | *::String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
|
| `library_section_id` | *::Integer* | :heavy_check_mark: | The ID of the library section. | 2 |
|
|
| `library_section_key` | *::String* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
|
|
| `content_rating` | *::String* | :heavy_check_mark: | The content rating (e.g., TV-MA). | TV-MA |
|
|
| `summary` | *::String* | :heavy_check_mark: | 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)* | :heavy_minus_sign: | The index or order of the item. | 1 |
|
|
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
|
|
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
|
|
| `audience_rating` | *::Float* | :heavy_check_mark: | The audience rating for the content. | 8.7 |
|
|
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
|
|
| `skip_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
|
|
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
|
|
| `year` | *::Integer* | :heavy_check_mark: | The release year. | 2015 |
|
|
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | The tagline of the content. | Make the call |
|
|
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
|
|
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
|
|
| `thumb` | *::String* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
|
|
| `art` | *::String* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
|
|
| `theme` | *T.nilable(::String)* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
|
| `duration` | *::Integer* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
|
|
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_check_mark: | The original release date. | 2015-02-08 |
|
|
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
|
|
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
|
|
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of child items. | 6 |
|
|
| `added_at` | *::Integer* | :heavy_check_mark: | Unix timestamp when the item was added. | 1625505101 |
|
|
| `updated_at` | *::Integer* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 |
|
|
| `audience_rating_image` | *::String* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating |
|
|
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
|
|
| `parent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
|
|
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
|
|
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
|
|
| `media` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)> | :heavy_minus_sign: | N/A | |
|
|
| `image` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)> | :heavy_check_mark: | An array of image objects. | |
|
|
| `ultra_blur_colors` | [::PlexRubySDK::Operations::GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
|
|
| `genre` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)> | :heavy_minus_sign: | An array of genre tags. | |
|
|
| `country` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataCountry](../../models/operations/getmediametadatacountry.md)> | :heavy_minus_sign: | An array of country tags. | |
|
|
| `guids` | T::Array<[::PlexRubySDK::Operations::Guids](../../models/operations/guids.md)> | :heavy_check_mark: | An array of GUID objects. | |
|
|
| `rating` | T::Array<[::PlexRubySDK::Operations::Rating](../../models/operations/rating.md)> | :heavy_check_mark: | An array of rating objects. | |
|
|
| `role` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
|
|
| `director` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
|
|
| `writer` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
|
| `producer` | T::Array<[::PlexRubySDK::Operations::Producer](../../models/operations/producer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
|
| `similar` | T::Array<[::PlexRubySDK::Operations::Similar](../../models/operations/similar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
|
|
| `location` | T::Array<[::PlexRubySDK::Operations::GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)> | :heavy_minus_sign: | An array of location objects. | | |