mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 04:20:46 +00:00
92 KiB
92 KiB
GetLibraryItemsMetadata
Unknown
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
ratingKey |
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 |
Optional<String> | ➖ | The studio that produced the media item. | 20th Century Studios |
type |
GetLibraryItemsType | ✔️ | 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 |
titleSort |
String | ✔️ | The sort title used for ordering media items. | Whale |
contentRating |
Optional<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 |
audienceRating |
double | ✔️ | The audience rating for the media item. | 9.2 |
year |
Optional<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 |
int | ✔️ | The index position of the media item. | 1 |
leafCount |
Optional<Integer> | ➖ | The number of leaf items (end nodes) under this media item. | 14 |
viewedLeafCount |
Optional<Integer> | ➖ | The number of leaf items that have been viewed. | 0 |
childCount |
int | ✔️ | The number of child items associated with this media item. | 1 |
seasonCount |
int | ✔️ | The total number of seasons (for TV shows). | 2022 |
duration |
int | ✔️ | The duration of the media item in milliseconds. | 11558112 |
originallyAvailableAt |
LocalDate | ➖ | The original release date of the media item. | 2022-12-14 |
addedAt |
long | ✔️ | N/A | 1556281940 |
updatedAt |
Optional<Long> | ➖ | Unix epoch datetime in seconds | 1556281940 |
audienceRatingImage |
Optional<String> | ➖ | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
chapterSource |
Optional<String> | ➖ | The source from which chapter data is derived. | media |
primaryExtraKey |
Optional<String> | ➖ | The primary extra key associated with this media item. | /library/metadata/58684 |
originalTitle |
Optional<String> | ➖ | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
parentRatingKey |
Optional<String> | ➖ | The rating key of the parent media item. | 66 |
grandparentRatingKey |
Optional<String> | ➖ | The rating key of the grandparent media item. | 66 |
parentGuid |
Optional<String> | ➖ | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
grandparentGuid |
Optional<String> | ➖ | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
grandparentSlug |
Optional<String> | ➖ | The slug for the grandparent media item. | alice-in-borderland-2020 |
grandparentKey |
Optional<String> | ➖ | The key of the grandparent media item. | /library/metadata/66 |
parentKey |
Optional<String> | ➖ | The key of the parent media item. | /library/metadata/66 |
grandparentTitle |
Optional<String> | ➖ | The title of the grandparent media item. | Caprica |
grandparentThumb |
Optional<String> | ➖ | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
grandparentTheme |
Optional<String> | ➖ | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
grandparentArt |
Optional<String> | ➖ | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
parentTitle |
Optional<String> | ➖ | The title of the parent media item. | Caprica |
parentIndex |
Optional<Integer> | ➖ | The index position of the parent media item. | 1 |
parentThumb |
Optional<String> | ➖ | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
ratingImage |
Optional<String> | ➖ | The URL for the rating image. | rottentomatoes://image.rating.ripe |
viewCount |
Optional<Integer> | ➖ | The number of times this media item has been viewed. | 1 |
viewOffset |
Optional<Integer> | ➖ | The current playback offset (in milliseconds). | 5222500 |
skipCount |
Optional<Integer> | ➖ | The number of times this media item has been skipped. | 1 |
subtype |
Optional<String> | ➖ | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
lastRatedAt |
Optional<Long> | ➖ | The Unix timestamp representing the last time the item was rated. | 1721813113 |
createdAtAccuracy |
Optional<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 |
createdAtTZOffset |
Optional<String> | ➖ | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
lastViewedAt |
Optional<Integer> | ➖ | Unix timestamp for when the media item was last viewed. | 1682752242 |
userRating |
Optional<Float> | ➖ | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
image |
List<GetLibraryItemsImage> | ➖ | N/A | |
ultraBlurColors |
Optional<GetLibraryItemsUltraBlurColors> | ➖ | N/A | |
guids |
List<GetLibraryItemsGuids> | ➖ | N/A | |
librarySectionID |
Optional<Long> | ➖ | The identifier for the library section. | 1 |
librarySectionTitle |
Optional<String> | ➖ | The title of the library section. | Movies |
librarySectionKey |
Optional<String> | ➖ | The key corresponding to the library section. | /library/sections/1 |
showOrdering |
Optional<ShowOrdering> | ➖ | 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 |
flattenSeasons |
Optional<FlattenSeasons> | ➖ | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). |
1 |
skipChildren |
Optional<Boolean> | ➖ | Indicates whether child items should be skipped. | false |
media |
List<GetLibraryItemsMedia> | ➖ | N/A | |
genre |
List<GetLibraryItemsGenre> | ➖ | N/A | |
country |
List<GetLibraryItemsCountry> | ➖ | N/A | |
director |
List<GetLibraryItemsDirector> | ➖ | N/A | |
writer |
List<GetLibraryItemsWriter> | ➖ | N/A | |
producer |
List<GetLibraryItemsProducer> | ➖ | N/A | |
collection |
List<GetLibraryItemsCollection> | ➖ | N/A | |
role |
List<GetLibraryItemsRole> | ➖ | N/A | |
ratings |
List<Ratings> | ➖ | N/A | |
similar |
List<GetLibraryItemsSimilar> | ➖ | N/A | |
location |
List<GetLibraryItemsLocation> | ➖ | N/A | |
chapter |
List<Chapter> | ➖ | N/A | |
marker |
List<Marker> | ➖ | N/A | |
extras |
Optional<Extras> | ➖ | N/A |