mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-09 12:47:44 +00:00
81 lines
87 KiB
Markdown
81 lines
87 KiB
Markdown
# GetSearchAllLibrariesMetadata
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `rating_key` | *::String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
|
| `key` | *::String* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
|
| `guid` | *::String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
|
| `studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
|
| `skip_children` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | false |
|
|
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
|
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Movies |
|
|
| `library_section_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
|
| `type` | [::PlexRubySDK::Operations::GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
|
| `title` | *::String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
|
| `slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 4-for-texas |
|
|
| `content_rating` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | PG-13 |
|
|
| `summary` | *::String* | :heavy_check_mark: | 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)* | :heavy_minus_sign: | N/A | 7.6 |
|
|
| `audience_rating` | *T.nilable(::Float)* | :heavy_minus_sign: | N/A | 9.2 |
|
|
| `year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
|
|
| `season_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2022 |
|
|
| `tagline` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
|
| `flatten_seasons` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesFlattenSeasons)](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
|
|
| `show_ordering` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesShowOrdering)](../../models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
|
| `thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
|
| `art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
|
| `banner` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
|
| `duration` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 11558112 |
|
|
| `originally_available_at` | [DateTime](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
|
| `added_at` | *::Integer* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
|
| `updated_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
|
| `audience_rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
|
| `chapter_source` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | media |
|
|
| `primary_extra_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
|
| `rating_image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
|
| `grandparent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 66 |
|
|
| `grandparent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
|
| `grandparent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
|
| `grandparent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
|
|
| `grandparent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
|
| `parent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
|
| `grandparent_slug` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
|
| `grandparent_art` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
|
| `grandparent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
|
| `media` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
|
| `genre` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)> | :heavy_minus_sign: | N/A | |
|
|
| `country` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)> | :heavy_minus_sign: | N/A | |
|
|
| `director` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)> | :heavy_minus_sign: | N/A | |
|
|
| `writer` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)> | :heavy_minus_sign: | N/A | |
|
|
| `collection` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesCollection](../../models/operations/getsearchalllibrariescollection.md)> | :heavy_minus_sign: | N/A | |
|
|
| `role` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)> | :heavy_minus_sign: | N/A | |
|
|
| `location` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)> | :heavy_minus_sign: | N/A | |
|
|
| `media_guid` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesMediaGuid](../../models/operations/getsearchalllibrariesmediaguid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
|
| `ultra_blur_colors` | [T.nilable(::PlexRubySDK::Operations::GetSearchAllLibrariesUltraBlurColors)](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
|
| `meta_data_rating` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesMetaDataRating](../../models/operations/getsearchalllibrariesmetadatarating.md)> | :heavy_minus_sign: | N/A | |
|
|
| `image` | T::Array<[::PlexRubySDK::Operations::GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md)> | :heavy_minus_sign: | N/A | |
|
|
| `title_sort` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Whale |
|
|
| `view_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
|
| `last_viewed_at` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1682752242 |
|
|
| `original_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
|
| `view_offset` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 5222500 |
|
|
| `skip_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
|
| `index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
|
| `theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
|
| `leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 14 |
|
|
| `viewed_leaf_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 0 |
|
|
| `child_count` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
|
| `has_premium_extras` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
|
|
| `has_premium_primary_extra` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | 1 |
|
|
| `parent_rating_key` | *T.nilable(::String)* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
|
| `parent_guid` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
|
| `parent_studio` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | UCP |
|
|
| `parent_key` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
|
| `parent_title` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Caprica |
|
|
| `parent_index` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1 |
|
|
| `parent_year` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 2010 |
|
|
| `parent_thumb` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
|
| `parent_theme` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 | |