Use Case 3: Building an OTT/VOD Program Guide
Note: For instructional purposes, the use cases described below use GVD API queries to retrieve and navigate data. For real-world applications, you should populate your databases using the instructions in Getting Seed Data and Updates and map primary database keys to IDs based on instructions in Mapping GNIDs to Primary Database Keys. Then use standard database queries to retrieve and navigate GVD data.
Also, the GNIDs used in this use case are for explanation only. They may change if the element becomes inactive or is deleted.
Process
Below are the recommended steps to create a VOD grid specific to a source of interest.
1. Access VOD/OTT Sources
The VOD/OTT sources are available in Source XML.
Example: Netflix U.S. GN1Y0WGNPMP1CG0
Code
2. Retrieve Catalog Items
Catalog Items are programs specific to a source. In other words, if a program is available in VOD sources, it is treated as a separate entity in Catalog Item XML. A list of such catalog items for a Source constitutes a Catalog Manifest (CM).
Example: "Friends, The One with the Baby on the Bus"
Catalog Item for HD+ 1080p:
Code
Catalog Item for HD 720p:
Code
3. Access Program Metadata
Every Catalog item points to a single program context that is relevant to a Source. The programs metadata is available in Program XML.
Example:
- Program GNID:
GN8F1KAK7F908V0 - Program Context GNID:
GN0BZGX7QJB44C7
Code
4. Retrieve Contributors
All program images, cast and crew for the above programs are available in Media and Contributor XML endpoints respectively. Similarly, Cast/Crew imagery can be located in Media endpoint.
Example:
Code
5. Access Media and Images
Images are of multiple types (vocabulary) and renditions (size/aspect ratio). All relevant images that are tagged to Program and Contributors are available in Media Endpoint.
Code