mirror of
https://github.com/LukeHagar/plexcsharp.git
synced 2025-12-06 20:47:49 +00:00
83 lines
90 KiB
Markdown
83 lines
90 KiB
Markdown
# GetLibraryItemsMetadata
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `RatingKey` | *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` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
|
| `SkipChildren` | *bool* | :heavy_minus_sign: | N/A | false |
|
|
| `LibrarySectionID` | *long* | :heavy_minus_sign: | N/A | 1 |
|
|
| `LibrarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
|
| `LibrarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
|
| `Type` | [GetLibraryItemsLibraryType](../../Models/Requests/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
|
| `Title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
|
| `Slug` | *string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
|
| `ContentRating` | *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` | *double* | :heavy_minus_sign: | N/A | 7.6 |
|
|
| `AudienceRating` | *double* | :heavy_minus_sign: | N/A | 9.2 |
|
|
| `Year` | *int* | :heavy_minus_sign: | N/A | 2022 |
|
|
| `SeasonCount` | *int* | :heavy_minus_sign: | N/A | 2022 |
|
|
| `Tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
|
| `FlattenSeasons` | [GetLibraryItemsFlattenSeasons](../../Models/Requests/GetLibraryItemsFlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
|
| `EpisodeSort` | [GetLibraryItemsEpisodeSort](../../Models/Requests/GetLibraryItemsEpisodeSort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
|
| `EnableCreditsMarkerGeneration` | [GetLibraryItemsEnableCreditsMarkerGeneration](../../Models/Requests/GetLibraryItemsEnableCreditsMarkerGeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
|
| `ShowOrdering` | [GetLibraryItemsShowOrdering](../../Models/Requests/GetLibraryItemsShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
|
|
| `Thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
|
| `Art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
|
| `Banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
|
| `Duration` | *int* | :heavy_minus_sign: | N/A | 11558112 |
|
|
| `OriginallyAvailableAt` | [LocalDate](https://nodatime.org/3.1.x/api/NodaTime.LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
|
| `AddedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
|
| `UpdatedAt` | *long* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
|
| `AudienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
|
| `ChapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
|
| `PrimaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
|
| `RatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
|
| `GrandparentRatingKey` | *string* | :heavy_minus_sign: | N/A | 66 |
|
|
| `GrandparentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
|
| `GrandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
|
| `GrandparentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
|
| `GrandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
|
| `ParentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
|
| `GrandparentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
|
| `GrandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
|
| `GrandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
|
| `Media` | List<[GetLibraryItemsMedia](../../Models/Requests/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
|
| `Genre` | List<[GetLibraryItemsGenre](../../Models/Requests/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
|
|
| `Country` | List<[GetLibraryItemsCountry](../../Models/Requests/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
|
|
| `Director` | List<[GetLibraryItemsDirector](../../Models/Requests/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
|
|
| `Writer` | List<[GetLibraryItemsWriter](../../Models/Requests/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
|
| `Collection` | List<[GetLibraryItemsCollection](../../Models/Requests/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
|
| `Role` | List<[GetLibraryItemsRole](../../Models/Requests/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
|
| `Location` | List<[GetLibraryItemsLocation](../../Models/Requests/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
|
| `MediaGuid` | List<[GetLibraryItemsMediaGuid](../../Models/Requests/GetLibraryItemsMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
|
| `UltraBlurColors` | [GetLibraryItemsUltraBlurColors](../../Models/Requests/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
|
| `MetaDataRating` | List<[GetLibraryItemsMetaDataRating](../../Models/Requests/GetLibraryItemsMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
|
| `Image` | List<[GetLibraryItemsImage](../../Models/Requests/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
|
| `TitleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
|
| `ViewCount` | *int* | :heavy_minus_sign: | N/A | 1 |
|
|
| `LastViewedAt` | *int* | :heavy_minus_sign: | N/A | 1682752242 |
|
|
| `OriginalTitle` | *string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
|
| `ViewOffset` | *int* | :heavy_minus_sign: | N/A | 5222500 |
|
|
| `SkipCount` | *int* | :heavy_minus_sign: | N/A | 1 |
|
|
| `Index` | *int* | :heavy_minus_sign: | N/A | 1 |
|
|
| `Theme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
|
| `LeafCount` | *int* | :heavy_minus_sign: | N/A | 14 |
|
|
| `ViewedLeafCount` | *int* | :heavy_minus_sign: | N/A | 0 |
|
|
| `ChildCount` | *int* | :heavy_minus_sign: | N/A | 1 |
|
|
| `HasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
|
|
| `HasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
|
| `ParentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
|
| `ParentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
|
| `ParentStudio` | *string* | :heavy_minus_sign: | N/A | UCP |
|
|
| `ParentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
|
| `ParentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
|
| `ParentIndex` | *int* | :heavy_minus_sign: | N/A | 1 |
|
|
| `ParentYear` | *int* | :heavy_minus_sign: | N/A | 2010 |
|
|
| `ParentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
|
| `ParentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 | |