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

76 KiB
Raw Blame History

GetMediaMetaDataMetadata

Fields

Field Type Required Description Example
ratingKey string ✔️ The rating key of the metadata item. 44288
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
type string ✔️ The type of content (e.g., show, movie). show
title string ✔️ The title of the content. Better Call Saul
librarySectionTitle string ✔️ The title of the library section. TV Series
librarySectionID int ✔️ The ID of the library section. 2
librarySectionKey string ✔️ The key of the library section. /library/sections/2
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.
year int ✔️ The release year. 2015
thumb string ✔️ URL of the thumbnail image. /library/metadata/44288/thumb/1736487993
art string ✔️ URL of the art image. /library/metadata/44288/art/1736487993
duration int ✔️ Duration of the content in milliseconds. 2700000
addedAt int ✔️ N/A 1556281940
updatedAt int ✔️ N/A 1556281940
image array<Operations\GetMediaMetaDataImage> ✔️ An array of image objects.
ultraBlurColors Operations\GetMediaMetaDataUltraBlurColors ✔️ N/A
parentRatingKey ?string The rating key of the parent of this metadata item. 48047
grandparentRatingKey ?string The rating key of the grandparent of this metadata item. 45520
parentGuid ?string A GUID identifying the parent entity (e.g., season) for the item. plex://season/618b89208dde18df707ad15c
grandparentGuid ?string A GUID identifying the grandparent entity (e.g., show). plex://show/5e16253691c20300412003a8
grandparentSlug ?string A URL-friendly identifier (slug) for the grandparent entity. alice-in-borderland-2020
grandparentKey ?string A key identifying the grandparent metadata in the library. /library/metadata/45520
parentKey ?string A key identifying the parent metadata in the library. /library/metadata/48047
slug ?string A URL-friendly identifier for the item. better-call-saul
studio ?string The studio that produced the content. Sony Pictures Television
originalTitle ?string The original title of the content. Wicked: Part I
contentRating ?string The content rating (e.g., TV-MA). TV-MA
index ?int The index or order of the item. 1
grandparentTitle ?string The title of the grandparent entity (typically the show's title). Alice in Borderland
parentTitle ?string The title of the parent entity (typically the season's title). Season 2
audienceRating ?float The audience rating for the content. 8.7
viewCount ?int The number of times the item has been viewed. 4
skipCount ?int The number of times the item has been skipped. 1
lastViewedAt ?int Unix timestamp of when the item was last viewed. 1625764795
rating ?float The general rating 6
ratingImage ?string The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). rottentomatoes://image.rating.ripe
tagline ?string The tagline of the content. Make the call
chapterSource ?string N/A media
primaryExtraKey ?string N/A /library/metadata/134704
theme ?string URL of the theme image. /library/metadata/44288/theme/1736487993
originallyAvailableAt \DateTime The original release date. 2015-02-08
leafCount ?int The total number of episodes (or leaves). 63
viewedLeafCount ?int The number of episodes that have been viewed. 4
childCount ?int The number of child items. 6
audienceRatingImage ?string The URL for the audience rating image. themoviedb://image.rating
parentIndex ?int The index number of the parent entity, which could indicate its order or position. 2
parentThumb ?string The URL of the parent's thumbnail image. /library/metadata/48047/thumb/1671800243
grandparentThumb ?string The URL of the grandparent's thumbnail image. /library/metadata/45520/thumb/1736488003
grandparentArt ?string The URL of the grandparent's art image. /library/metadata/45520/art/1736488003
media array<Operations\GetMediaMetaDataMedia> N/A
genre array<Operations\GetMediaMetaDataGenre> An array of genre tags.
country array<Operations\GetMediaMetaDataCountry> An array of country tags.
guids array<Operations\GetMediaMetaDataGuids> An array of GUID objects.
ratings array<Operations\Ratings> An array of rating objects.
role array<Operations\GetMediaMetaDataRole> An array of Actor roles.
director array<Operations\GetMediaMetaDataDirector> An array of Director roles.
writer array<Operations\GetMediaMetaDataWriter> An array of Writer roles.
producer array<Operations\Producer> An array of Writer roles.
similar array<Operations\Similar> An array of similar content objects.
location array<Operations\GetMediaMetaDataLocation> An array of location objects.