mirror of
https://github.com/LukeHagar/plexphp.git
synced 2025-12-06 12:37:47 +00:00
81 lines
87 KiB
Markdown
81 lines
87 KiB
Markdown
# GetSearchAllLibrariesMetadata
|
|
|
|
|
|
## 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 |
|
|
| `type` | [Operations\GetSearchAllLibrariesType](../../Models/Operations/GetSearchAllLibrariesType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
|
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
|
| `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. |
|
|
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
|
| `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
|
| `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false |
|
|
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
|
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
|
|
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
|
| `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
|
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
|
|
| `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 |
|
|
| `audienceRating` | *?float* | :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` | [?Operations\GetSearchAllLibrariesFlattenSeasons](../../Models/Operations/GetSearchAllLibrariesFlattenSeasons.md) | :heavy_minus_sign: | N/A | 1 |
|
|
| `showOrdering` | [?Operations\GetSearchAllLibrariesShowOrdering](../../Models/Operations/GetSearchAllLibrariesShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd |
|
|
| `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` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
|
| `updatedAt` | *?int* | :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` | array<[Operations\GetSearchAllLibrariesMedia](../../Models/Operations/GetSearchAllLibrariesMedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
|
| `genre` | array<[Operations\GetSearchAllLibrariesGenre](../../Models/Operations/GetSearchAllLibrariesGenre.md)> | :heavy_minus_sign: | N/A | |
|
|
| `country` | array<[Operations\GetSearchAllLibrariesCountry](../../Models/Operations/GetSearchAllLibrariesCountry.md)> | :heavy_minus_sign: | N/A | |
|
|
| `director` | array<[Operations\GetSearchAllLibrariesDirector](../../Models/Operations/GetSearchAllLibrariesDirector.md)> | :heavy_minus_sign: | N/A | |
|
|
| `writer` | array<[Operations\GetSearchAllLibrariesWriter](../../Models/Operations/GetSearchAllLibrariesWriter.md)> | :heavy_minus_sign: | N/A | |
|
|
| `collection` | array<[Operations\GetSearchAllLibrariesCollection](../../Models/Operations/GetSearchAllLibrariesCollection.md)> | :heavy_minus_sign: | N/A | |
|
|
| `role` | array<[Operations\GetSearchAllLibrariesRole](../../Models/Operations/GetSearchAllLibrariesRole.md)> | :heavy_minus_sign: | N/A | |
|
|
| `location` | array<[Operations\GetSearchAllLibrariesLocation](../../Models/Operations/GetSearchAllLibrariesLocation.md)> | :heavy_minus_sign: | N/A | |
|
|
| `mediaGuid` | array<[Operations\GetSearchAllLibrariesMediaGuid](../../Models/Operations/GetSearchAllLibrariesMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
|
| `ultraBlurColors` | [?Operations\GetSearchAllLibrariesUltraBlurColors](../../Models/Operations/GetSearchAllLibrariesUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
|
| `metaDataRating` | array<[Operations\GetSearchAllLibrariesMetaDataRating](../../Models/Operations/GetSearchAllLibrariesMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
|
| `image` | array<[Operations\GetSearchAllLibrariesImage](../../Models/Operations/GetSearchAllLibrariesImage.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 | |