# GetLibraryMatchesRequest


## Fields

| Field                                                                                                       | Type                                                                                                        | Required                                                                                                    | Description                                                                                                 | Example                                                                                                     |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `Accepts`                                                                                                   | [*components.Accepts](../../models/components/accepts.md)                                                   | :heavy_minus_sign:                                                                                          | Indicates the client accepts the indicated media types                                                      |                                                                                                             |
| `ClientIdentifier`                                                                                          | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | An opaque identifier unique to the client                                                                   | abc123                                                                                                      |
| `Product`                                                                                                   | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | The name of the client product                                                                              | Plex for Roku                                                                                               |
| `Version`                                                                                                   | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | The version of the client application                                                                       | 2.4.1                                                                                                       |
| `Platform`                                                                                                  | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | The platform of the client                                                                                  | Roku                                                                                                        |
| `PlatformVersion`                                                                                           | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | The version of the platform                                                                                 | 4.3 build 1057                                                                                              |
| `Device`                                                                                                    | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | A relatively friendly name for the client device                                                            | Roku 3                                                                                                      |
| `Model`                                                                                                     | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | A potentially less friendly identifier for the device model                                                 | 4200X                                                                                                       |
| `DeviceVendor`                                                                                              | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | The device vendor                                                                                           | Roku                                                                                                        |
| `DeviceName`                                                                                                | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | A friendly name for the client                                                                              | Living Room TV                                                                                              |
| `Marketplace`                                                                                               | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | The marketplace on which the client application is distributed                                              | googlePlay                                                                                                  |
| `Type`                                                                                                      | **int64*                                                                                                    | :heavy_minus_sign:                                                                                          | The metadata type to filter by                                                                              |                                                                                                             |
| `IncludeFullMetadata`                                                                                       | [*components.BoolInt](../../models/components/boolint.md)                                                   | :heavy_minus_sign:                                                                                          | N/A                                                                                                         | 1                                                                                                           |
| `IncludeAncestorMetadata`                                                                                   | [*components.BoolInt](../../models/components/boolint.md)                                                   | :heavy_minus_sign:                                                                                          | N/A                                                                                                         | 1                                                                                                           |
| `IncludeAlternateMetadataSources`                                                                           | [*components.BoolInt](../../models/components/boolint.md)                                                   | :heavy_minus_sign:                                                                                          | N/A                                                                                                         | 1                                                                                                           |
| `GUID`                                                                                                      | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | Used for movies, shows, artists, albums, and tracks.  Allowed for various URI schemes, to be defined.       |                                                                                                             |
| `Title`                                                                                                     | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | The title to filter by or assign                                                                            |                                                                                                             |
| `Year`                                                                                                      | **int64*                                                                                                    | :heavy_minus_sign:                                                                                          | Used for movies shows, and albums.  Optional.                                                               |                                                                                                             |
| `Path`                                                                                                      | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | Used for movies, episodes, and tracks.  The full path to the media file, used for "cloud-scanning" an item. |                                                                                                             |
| `GrandparentTitle`                                                                                          | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | Used for episodes and tracks.  The title of the show/artist. Required if `path` isn't passed.               |                                                                                                             |
| `GrandparentYear`                                                                                           | **int64*                                                                                                    | :heavy_minus_sign:                                                                                          | Used for episodes.  The year of the show.                                                                   |                                                                                                             |
| `ParentIndex`                                                                                               | **int64*                                                                                                    | :heavy_minus_sign:                                                                                          | Used for episodes and tracks.  The season/album number.                                                     |                                                                                                             |
| `Index`                                                                                                     | **int64*                                                                                                    | :heavy_minus_sign:                                                                                          | Used for episodes and tracks.  The episode/tracks number in the season/album.                               |                                                                                                             |
| `OriginallyAvailableAt`                                                                                     | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | Used for episodes.  In the format `YYYY-MM-DD`.                                                             |                                                                                                             |
| `ParentTitle`                                                                                               | **string*                                                                                                   | :heavy_minus_sign:                                                                                          | Used for albums and tracks. The artist name for albums or the album name for tracks.                        |                                                                                                             |