Integrating Your Catalog with Fire TV
Integrating your media catalog with Amazon Fire TV allows your content to be discovered and launched from the Fire TV home screen when users search for it (either through voice or text search).
- Catalog Integration Overview
- Criteria for Catalog Integration
- Contact Us to Get Started
- Resources in This Section
- Changes to the Catalog Data Format (CDF) XML Schema
Catalog Integration Overview
Catalog Integration has two major components:
- A catalog file that specifies the movies and TV shows that you offer through your app.
- Integration between your app and the Fire TV Home Screen Launcher, which enables users to play your content directly from search and browse results.
Catalog Integration allows your content to be included in the results of a search performed from the Fire TV home screen. It also allows a user to find your content while browsing Fire TV outside of your app, such as when browsing by genre (also known as "universal browse and search"). Regardless of where in the Fire TV UI users find your content, they can play it directly without needing to open your app first.
Criteria for Catalog Integration
Not every app qualifies for catalog integration. 90% of your app's catalog must be available for catalog integration, and all titles be indexed on IMDB or Amazon Video for referencing. Only content that is matched against IMDB will be discoverable via catalog integration.
Contact Us to Get Started
To begin your catalog integration with our platform, contact us for further information. If your content qualifies for integration into the catalog, it takes two weeks to set up our systems to provide you with a sandbox to test the integration.
Resources in This Section
These topics will teach you about Fire TV catalog and launcher integration. If you're new to this, reading these topics in the given order is recommended.
- Understanding Fire TV Catalog Integration: Introduction to Catalog Integration concepts.
- Getting Started with Fire TV Catalog Integration: A quick-start guide to Fire TV catalog integration.
- About the Catalog Data Format (CDF): An overview of the Catalog Data Format (CDF) catalog file that contains your content's metadata.
- Setting Up Your AWS Account for Fire TV Catalog Integration: One-time setup instructions for AWS.
- Uploading Your Catalog to Amazon: Learn the process for configuring AWS and uploading your CDF file to our service.
- Receiving and Understanding the Fire TV Catalog Ingestion Report: Learn about the reports on your catalog's ingestion results.
- Integrating Your App with the Fire TV Home Screen Launcher: How to modify your app to integrate subscription and playback information into the Amazon Fire TV launcher.
- Test Cases for Verifying Fire TV Deep Links: Recommended test cases to run for testing launcher integration.
- Testing Launcher Integration with ADB: Using the Android Debug Bridge to test your app's integration with the launcher.
- Testing Fire TV Launcher Integration with the Integration Test App: We provide a simple app with which you can test your app's integration with the launcher.
- Fire TV Catalog Integration Frequently Asked Questions: Frequently asked questions about Catalog Integration.
Read these topics as needed:
- Catalog Data Format (CDF) Ingestion Report Messages: Interpret the messages contained in the ingestion report and troubleshoot your CDF file.
- Migrating a Catalog Data Format (CDF) File to the Latest Version: Step-by-Step instructions to adapt your catalog file to the latest CDF schema version.
These documents can be used as a reference once you have a grasp of the overall catalog and launcher integration concepts.
- Fire TV Catalog Data Format (CDF) Schema: Overall reference documentation for the Catalog Data Format XML schema definition (XSD).
- Catalog Data Format (CDF) Schema Definition: The XSD file that defines the current CDF.
- Catalog Data Format (CDF) Examples: Download a zip file that contains examples of CDF XML examples of individual media types as well as a full catalog, and examples showing how to tie shows, seasons, specials, extras, and episodes together.
Changes to the Catalog Data Format (CDF) XML Schema
From time to time, the CDF schema, on which your catalog file is based, is updated to add new features. In rare cases, existing elements might be removed or altered. Check here for a summary of the latest changes. The current version of the CDF schema is 1.8.