Files
plexphp/docs/Models/Operations/GetLibraryItemsMetadata.md

80 KiB
Raw Blame History

GetLibraryItemsMetadata

Fields

Field Type Required Description Example
ratingKey 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
type Operations\GetLibraryItemsType ✔️ The type of media content
movie
title string ✔️ N/A Avatar: The Way of Water
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.
addedAt int ✔️ Unix epoch datetime in seconds 1556281940
studio ?string N/A 20th Century Studios
skipChildren ?bool N/A false
slug ?string N/A 4-for-texas
contentRating ?string N/A PG-13
rating ?float N/A 7.6
audienceRating ?float N/A 9.2
year ?int N/A 2022
seasonCount ?int N/A 2022
tagline ?string N/A Return to Pandora.
flattenSeasons ?Operations\FlattenSeasons N/A 1
showOrdering ?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)).
dvd
thumb ?string N/A /library/metadata/58683/thumb/1703239236
art ?string N/A /library/metadata/58683/art/1703239236
banner ?string N/A /library/metadata/58683/banner/1703239236
duration ?int N/A 11558112
originallyAvailableAt \DateTime N/A 2022-12-14 00:00:00 +0000 UTC
updatedAt ?int Unix epoch datetime in seconds 1556281940
audienceRatingImage ?string N/A rottentomatoes://image.rating.upright
chapterSource ?string N/A media
primaryExtraKey ?string N/A /library/metadata/58684
ratingImage ?string N/A rottentomatoes://image.rating.ripe
grandparentRatingKey ?string N/A 66
grandparentGuid ?string N/A plex://show/5d9c081b170e24001f2a7be4
grandparentKey ?string N/A /library/metadata/66
grandparentTitle ?string N/A Caprica
grandparentThumb ?string N/A /library/metadata/66/thumb/1705716261
grandparentSlug ?string N/A alice-in-borderland-2020
grandparentArt ?string N/A /library/metadata/66/art/1705716261
grandparentTheme ?string N/A /library/metadata/66/theme/1705716261
media array<Operations\GetLibraryItemsMedia> The Media object is only included when type query is 4 or higher.
genre array<Operations\GetLibraryItemsGenre> N/A
country array<Operations\GetLibraryItemsCountry> N/A
director array<Operations\GetLibraryItemsDirector> N/A
writer array<Operations\GetLibraryItemsWriter> N/A
collection array<Operations\Collection> N/A
role array<Operations\GetLibraryItemsRole> N/A
mediaGuid array<Operations\MediaGuid> The Guid object is only included in the response if the includeGuids parameter is set to 1.
ultraBlurColors ?Operations\UltraBlurColors N/A
image array<Operations\GetLibraryItemsImage> N/A
titleSort ?string N/A Whale
viewCount ?int N/A 1
lastViewedAt ?int N/A 1682752242
originalTitle ?string N/A 映画 ブラッククローバー 魔法帝の剣
viewOffset ?int N/A 5222500
skipCount ?int N/A 1
index ?int N/A 1
theme ?string N/A /library/metadata/1/theme/1705636920
leafCount ?int N/A 14
viewedLeafCount ?int N/A 0
childCount ?int N/A 1
hasPremiumExtras ?string N/A 1
hasPremiumPrimaryExtra ?string N/A 1
parentRatingKey ?string The rating key of the parent item.
66
parentGuid ?string N/A plex://show/5d9c081b170e24001f2a7be4
parentStudio ?string N/A UCP
parentKey ?string N/A /library/metadata/66
parentTitle ?string N/A Caprica
parentIndex ?int N/A 1
parentYear ?int N/A 2010
parentThumb ?string N/A /library/metadata/66/thumb/1705716261
parentTheme ?string N/A /library/metadata/66/theme/1705716261