# GetLibraryMatchesRequest


## Fields

| Field                                                                                                       | Type                                                                                                        | Required                                                                                                    | Description                                                                                                 | Example                                                                                                     |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `accepts`                                                                                                   | [Optional\<Accepts>](../../models/shared/Accepts.md)                                                        | :heavy_minus_sign:                                                                                          | Indicates the client accepts the indicated media types                                                      |                                                                                                             |
| `clientIdentifier`                                                                                          | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | An opaque identifier unique to the client                                                                   | abc123                                                                                                      |
| `product`                                                                                                   | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | The name of the client product                                                                              | Plex for Roku                                                                                               |
| `version`                                                                                                   | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | The version of the client application                                                                       | 2.4.1                                                                                                       |
| `platform`                                                                                                  | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | The platform of the client                                                                                  | Roku                                                                                                        |
| `platformVersion`                                                                                           | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | The version of the platform                                                                                 | 4.3 build 1057                                                                                              |
| `device`                                                                                                    | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | A relatively friendly name for the client device                                                            | Roku 3                                                                                                      |
| `model`                                                                                                     | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | A potentially less friendly identifier for the device model                                                 | 4200X                                                                                                       |
| `deviceVendor`                                                                                              | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | The device vendor                                                                                           | Roku                                                                                                        |
| `deviceName`                                                                                                | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | A friendly name for the client                                                                              | Living Room TV                                                                                              |
| `marketplace`                                                                                               | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | The marketplace on which the client application is distributed                                              | googlePlay                                                                                                  |
| `type`                                                                                                      | *Optional\<Long>*                                                                                           | :heavy_minus_sign:                                                                                          | The metadata type to filter by                                                                              |                                                                                                             |
| `includeFullMetadata`                                                                                       | [Optional\<BoolInt>](../../models/shared/BoolInt.md)                                                        | :heavy_minus_sign:                                                                                          | N/A                                                                                                         | 1                                                                                                           |
| `includeAncestorMetadata`                                                                                   | [Optional\<BoolInt>](../../models/shared/BoolInt.md)                                                        | :heavy_minus_sign:                                                                                          | N/A                                                                                                         | 1                                                                                                           |
| `includeAlternateMetadataSources`                                                                           | [Optional\<BoolInt>](../../models/shared/BoolInt.md)                                                        | :heavy_minus_sign:                                                                                          | N/A                                                                                                         | 1                                                                                                           |
| `guid`                                                                                                      | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | Used for movies, shows, artists, albums, and tracks.  Allowed for various URI schemes, to be defined.       |                                                                                                             |
| `title`                                                                                                     | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | The title to filter by or assign                                                                            |                                                                                                             |
| `year`                                                                                                      | *Optional\<Long>*                                                                                           | :heavy_minus_sign:                                                                                          | Used for movies shows, and albums.  Optional.                                                               |                                                                                                             |
| `path`                                                                                                      | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | Used for movies, episodes, and tracks.  The full path to the media file, used for "cloud-scanning" an item. |                                                                                                             |
| `grandparentTitle`                                                                                          | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | Used for episodes and tracks.  The title of the show/artist. Required if `path` isn't passed.               |                                                                                                             |
| `grandparentYear`                                                                                           | *Optional\<Long>*                                                                                           | :heavy_minus_sign:                                                                                          | Used for episodes.  The year of the show.                                                                   |                                                                                                             |
| `parentIndex`                                                                                               | *Optional\<Long>*                                                                                           | :heavy_minus_sign:                                                                                          | Used for episodes and tracks.  The season/album number.                                                     |                                                                                                             |
| `index`                                                                                                     | *Optional\<Long>*                                                                                           | :heavy_minus_sign:                                                                                          | Used for episodes and tracks.  The episode/tracks number in the season/album.                               |                                                                                                             |
| `originallyAvailableAt`                                                                                     | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | Used for episodes.  In the format `YYYY-MM-DD`.                                                             |                                                                                                             |
| `parentTitle`                                                                                               | *Optional\<String>*                                                                                         | :heavy_minus_sign:                                                                                          | Used for albums and tracks. The artist name for albums or the album name for tracks.                        |                                                                                                             |