mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 04:20:52 +00:00
86 KiB
86 KiB
GetSearchAllLibrariesMetadata
Unknown
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
rating_key |
::String | ✔️ | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
key |
::String | ✔️ | The unique key for the media item. | /library/metadata/58683 |
guid |
::String | ✔️ | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
slug |
::String | ✔️ | A URL‐friendly version of the media title. | 4-for-texas |
studio |
T.nilable(::String) | ➖ | The studio that produced the media item. | 20th Century Studios |
type |
Models::Operations::GetSearchAllLibrariesType | ✔️ | N/A | movie |
title |
::String | ✔️ | The title of the media item. | Avatar: The Way of Water |
banner |
::String | ✔️ | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
title_sort |
::String | ✔️ | The sort title used for ordering media items. | Whale |
content_rating |
T.nilable(::String) | ➖ | The content rating for the media item. | PG-13 |
summary |
::String | ✔️ | A synopsis of the media item. | 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 |
::Float | ✔️ | The critic rating for the media item. | 7.6 |
audience_rating |
::Float | ✔️ | The audience rating for the media item. | 9.2 |
year |
T.nilable(::Integer) | ➖ | The release year of the media item. | 2022 |
tagline |
::String | ✔️ | A brief tagline for the media item. | Return to Pandora. |
thumb |
::String | ✔️ | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
art |
::String | ✔️ | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
theme |
::String | ✔️ | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
index |
::Integer | ✔️ | The index position of the media item. | 1 |
leaf_count |
T.nilable(::Integer) | ➖ | The number of leaf items (end nodes) under this media item. | 14 |
viewed_leaf_count |
T.nilable(::Integer) | ➖ | The number of leaf items that have been viewed. | 0 |
child_count |
::Integer | ✔️ | The number of child items associated with this media item. | 1 |
season_count |
::Integer | ✔️ | The total number of seasons (for TV shows). | 2022 |
duration |
::Integer | ✔️ | The duration of the media item in milliseconds. | 11558112 |
originally_available_at |
DateTime | ➖ | The original release date of the media item. | 2022-12-14 |
added_at |
::Integer | ✔️ | N/A | 1556281940 |
updated_at |
T.nilable(::Integer) | ➖ | Unix epoch datetime in seconds | 1556281940 |
parent_year |
T.nilable(::Integer) | ➖ | The release year of the parent media item. | 2010 |
audience_rating_image |
T.nilable(::String) | ➖ | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
chapter_source |
T.nilable(::String) | ➖ | The source from which chapter data is derived. | media |
primary_extra_key |
T.nilable(::String) | ➖ | The primary extra key associated with this media item. | /library/metadata/58684 |
original_title |
T.nilable(::String) | ➖ | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
parent_rating_key |
T.nilable(::String) | ➖ | The rating key of the parent media item. | 66 |
grandparent_rating_key |
T.nilable(::String) | ➖ | The rating key of the grandparent media item. | 66 |
parent_guid |
T.nilable(::String) | ➖ | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
grandparent_guid |
T.nilable(::String) | ➖ | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
grandparent_slug |
T.nilable(::String) | ➖ | The slug for the grandparent media item. | alice-in-borderland-2020 |
grandparent_key |
T.nilable(::String) | ➖ | The key of the grandparent media item. | /library/metadata/66 |
parent_key |
T.nilable(::String) | ➖ | The key of the parent media item. | /library/metadata/66 |
grandparent_title |
T.nilable(::String) | ➖ | The title of the grandparent media item. | Caprica |
grandparent_thumb |
T.nilable(::String) | ➖ | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
grandparent_theme |
T.nilable(::String) | ➖ | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
grandparent_art |
T.nilable(::String) | ➖ | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
parent_title |
T.nilable(::String) | ➖ | The title of the parent media item. | Caprica |
parent_index |
T.nilable(::Integer) | ➖ | The index position of the parent media item. | 1 |
parent_thumb |
T.nilable(::String) | ➖ | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
rating_image |
T.nilable(::String) | ➖ | The URL for the rating image. | rottentomatoes://image.rating.ripe |
view_count |
T.nilable(::Integer) | ➖ | The number of times this media item has been viewed. | 1 |
view_offset |
T.nilable(::Integer) | ➖ | The current playback offset (in milliseconds). | 5222500 |
skip_count |
T.nilable(::Integer) | ➖ | The number of times this media item has been skipped. | 1 |
subtype |
T.nilable(::String) | ➖ | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
last_rated_at |
T.nilable(::Integer) | ➖ | The Unix timestamp representing the last time the item was rated. | 1721813113 |
created_at_accuracy |
T.nilable(::String) | ➖ | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
created_at_tz_offset |
T.nilable(::String) | ➖ | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
last_viewed_at |
T.nilable(::Integer) | ➖ | Unix timestamp for when the media item was last viewed. | 1682752242 |
user_rating |
T.nilable(::Float) | ➖ | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
image |
T::Array<Models::Operations::GetSearchAllLibrariesImage> | ➖ | N/A | |
ultra_blur_colors |
T.nilable(Models::Operations::GetSearchAllLibrariesUltraBlurColors) | ➖ | N/A | |
guids |
T::Array<Models::Operations::GetSearchAllLibrariesGuids> | ➖ | N/A | |
library_section_id |
T.nilable(::Integer) | ➖ | The identifier for the library section. | 1 |
library_section_title |
T.nilable(::String) | ➖ | The title of the library section. | Movies |
library_section_key |
T.nilable(::String) | ➖ | The key corresponding to the library section. | /library/sections/1 |
show_ordering |
T.nilable(Models::Operations::GetSearchAllLibrariesShowOrdering) | ➖ | Setting that indicates the episode ordering for the show. Options: - None = Library default - tmdbAiring = The Movie Database (Aired) - aired = TheTVDB (Aired) - dvd = TheTVDB (DVD) - absolute = TheTVDB (Absolute) |
absolute |
flatten_seasons |
T.nilable(Models::Operations::GetSearchAllLibrariesFlattenSeasons) | ➖ | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). |
1 |
skip_children |
T.nilable(T::Boolean) | ➖ | Indicates whether child items should be skipped. | false |
media |
T::Array<Models::Operations::GetSearchAllLibrariesMedia> | ➖ | N/A | |
genre |
T::Array<Models::Operations::GetSearchAllLibrariesGenre> | ➖ | N/A | |
country |
T::Array<Models::Operations::GetSearchAllLibrariesCountry> | ➖ | N/A | |
director |
T::Array<Models::Operations::GetSearchAllLibrariesDirector> | ➖ | N/A | |
writer |
T::Array<Models::Operations::GetSearchAllLibrariesWriter> | ➖ | N/A | |
role |
T::Array<Models::Operations::GetSearchAllLibrariesRole> | ➖ | N/A | |
location |
T::Array<Models::Operations::GetSearchAllLibrariesLocation> | ➖ | N/A |