GVD

Data Dictionaries and Controlled Vocabulary

Data Dictionaries

There are two data dictionaries for GVD. One is General and the other is for Video on Demand (VOD).

• [GVD Data Dictionary]
• [GVD VOD Data Dictionary]

Controlled Vocabulary (CV)

The CV is a list of terms that can appear in metadata that are managed (controlled) by GVD. The CV helps simplify data indexing and searching, and ensures consistency of results across different datasets . To get the CV, access it directly from:

http://gvd-api.gracenote.com/v1/cv?updateId=0&limit=1&api_key=\<*your-api-key*\>

You can also view the CV endpoint using the GVD API Explorer. Log onto your Gracenote account and access the API using your Gracenote API key:

http://developer.tmsapi.com/io-docs

Examples

Code
 
<media_context>  
 <id>GN000RM9TKMEAWC</id>  
 <type>image</type>  
 <subtype>IMG_PRG_MAIN</subtype>  
 <status>inactive</status>  
 ...

In the above XML snippet, both type and subtype are defined in the Controlled Vocabulary. That is:

• media type: can be audio, video, or image
• media subtype: can be IMG_CONT_MAIN, IMG_PRG_MAIN, and so on. Some CV types are shared among objects. For example, is used by Program and Catalog Items, as shown below. Rating values in this case are different. Program uses the MPAA rating (RTG_USA_01). Catalog Item for the same program is for TV viewing, so it uses a USA Parental Rating (RTG_USA_04). Here are the possible CV rating definitions for USA:
• RTG_USA_01: MPAA (USA)
• RTG_USA_02: MPAA TV (USA)
• RTG_USA_03: FAB (USA)
• RTG_USA_04: UPR (USA Parental Rating)
• RTG_USA_05: PML (North America) Rating values for a program will also differ across different countries and regions, based on different standards boards. Program Context

Code
 
<program_context>  
 <id>GN2SR1QQGJAA2EB</id>  
 <type>MOVIE</type>  
 <subtype>MOVIE_FEATURE_FILM</subtype>  
 <status>active</status>  
 ...  
 <program_root_id>GN1J2GTWCEGV8RZ</program_root_id>  
 <ratings>  
 <rating>  
 <type>RTG_USA_01</type>  
 <subtype>RTG_USA_01_01</subtype>  
 </rating>  
 </ratings>
*Catalog Item*
```xml
<gvd_object>  
 <id>GNDJZQDBSJK1GX2</id>  
 <type>CatalogItem</type>  
 <update_id>3511835765</update_id>  
 <update_date>2018-07-11T22:14:57Z</update_date>  
 <catalog_item>  
 <id>GNDJZQDBSJK1GX2</id>  
 <status>active</status>  
 <program_context_id>GN2SR1QQGJAA2EB</program_context_id>  
 <program_root_id>GN1J2GTWCEGV8RZ</program_root_id>  
 ...  
 <ratings>  
 <rating>  
 <type>RTG_USA_04</type>  
 <subtype>RTG_USA_04_04</subtype>  
 </rating>  
 </ratings>  
 <source_id>GN03H147TQJE1H2</source_id>

Controlled Vocabulary Endpoint

v1/cv Returns the Controlled Vocabulary for Global Video Data.

Parameter	Value	Type	Description
updateId	0	string	Returns a Controlled Vocabulary object modified at or after updateId with all of the CV in a single object
limit	10	string	Approximate maximum number of a CV object to be returned by API; frequently should be 1
id		string	Used for a lookup of a direct CV object by its Gracenote ID. Use Lookup calls for QA/troubleshooting purposes only. Gracenote does not support lookup APIs for Client production environments.
api_key		string	Gracenote API Key

Country CVs, GNIDs, and XIDs

Below is a list of controlled vocabulary names (CVs) and corresponding GNIDs for countries and regions. It also shows which Gracenote XID system is used for each country.

CV	Country Name	Region	GNID	XID System
CTR_AIA	Anguilla	Caribbean	GN1AYWKT6ZHBHWZ	TMS
CTR_ATG	Antigua and Barbuda	Caribbean	GN0RMK4V0X24H64	TMS
CTR_ARG	Argentina	Latin America	GN6X4PXYG2MDXRV	TMS
CTR_AUS	Australia	ANZ	GN40VEHPJ338S9G	VDMS
CTR_AUT	Austria	Europe	GN41P46G0WMQQWK	TMS
CTR_BHS	Bahamas	Caribbean	GN71NJZ91Q6QK35	TMS
CTR_BHR	Bahrain	Middle East	GN53Y5ZKKBXQC52	WOI
CTR_BGD	Bangladesh	APAC	GNC1ZK7Q5KFT3X1	WOI
CTR_BRB	Barbados	Caribbean	GN2RT4T4BNGV2CZ	TMS
CTR_BEL	Belgium	Europe	GN7ZS0THXD0GCM5	VDMS
CTR_BLZ	Belize	Latin America	GN5F171QJ0X7SVR	TMS
CTR_BMU	Bermuda	Caribbean	GN2MWEK37JGTX31	TMS
CTR_BES	Bonaire, Sint Eustatius and Saba	Caribbean	GNFKXFTNCAXFKZB	TMS
CTR_BRA	Brazil	Latin America	GNAGTW1KKECVVB3	TMS
CTR_BGR	Bulgaria	Europe	GNFG6T24DS6B7G1	VDMS
CTR_CAN	Canada	North America	GN2QRGWBE1CGA1D	TMS
CTR_CYM	Cayman Islands	Caribbean	GN8GNFC1EWBVDG7	TMS
CTR_CHL	Chile	Latin America	GN7ZFYVVYZZ2VTJ	TMS
CTR_CHN	China	APAC	GTMST493W7GA5B6	VDMS
CTR_COL	Colombia	Latin America	GNF89EAEYYV0CWK	TMS
CTR_CRI	Costa Rica	Latin America	GN6R1P1A0HAVHQ0	TMS
CTR_HRV	Croatia	Europe	GN0N43SPGHTEFFP	VDMS
CTR_CUW	Curaçao	Caribbean	GN7YEDBDB9EMD1V	TMS
CTR_CZE	Czech Republic	Europe	GNF1EEGNNSD06K6	VDMS
CTR_DNK	Denmark	Europe	GN3XZ3T3NHNTJZ9	TMS
CTR_DOM	Dominican Republic	Caribbean	GNFZS45RHZXD1X4	TMS
CTR_ECU	Ecuador	Latin America	GNA5PWXKR6RDT5N	TMS
CTR_EGY	Egypt	Africa	GN8XVSYZ9YK0DDA	WOI
CTR_EST	Estonia	Europe	GN60B8H8EF0JNEG	VDMS
CTR_FIN	Finland	Europe	GNARTC229TV1H94	TMS
CTR_FRA	France	Europe	GN0F4GAAR04HRV7	TMS
CTR_DEU	Germany	Europe	GNBSTKPC046N7YF	TMS
CTR_GRD	Grenada	Caribbean	GNCMCPMHKFQ9DS4	TMS
CTR_GTM	Guatemala	Latin America	GNADEREBCEXET2P	TMS
CTR_GUY	Guyana	Latin America	GNAQEM6SC7ECXV8	TMS
CTR_HND	Honduras	Latin America	GN8MJ96ZHVTD4FA	TMS
CTR_IND	India	APAC	GN9169P75VY1R3R	WOI
CTR_IDN	Indonesia	APAC	GNC5YHP3V3W9AJC	WOI
CTR_IRN	Iran, Islamic Republic of	Middle East	GN7AP77RNFPBSE0	WOI
CTR_IRL	Ireland	Europe	GN14EGZEW9DN1YT	TMS
CTR_ITA	Italy	Europe	GN0CG8HSY05HNW4	TMS
CTR_JAM	Jamaica	Caribbean	GND9J62D8HAHB4Q	TMS
CTR_JPN	Japan	APAC	GNA5T5PXBRED7AD	VDMS, Core
CTR_KWT	Kuwait	Middle East	GNDYX3BK8SC83E7	WOI
CTR_LVA	Latvia	Europe	GNAEDY8ZZ6FP209	VDMS
CTR_LBN	Lebanon	Middle East	GN5TAK6WZ2J4PA9	WOI
CTR_LTU	Lithuania	Europe	GNAF2BPJV3HKDNQ	VDMS
CTR_LUX	Luxembourg	Europe	GN18V90V4N7FSZK	VDMS
CTR_MEX	Mexico	Latin America	GN2BG5REGTFWJWF	TMS
CTR_NPL	Nepal	APAC	GN4G54757XDHW24	WOI
CTR_NLD	Netherlands	Europe	GNCJ2M90TJ5M2AA	VDMS
CTR_NZL	New Zealand	ANZ	GNAF9MZ01S48BR9	TMS
CTR_NOR	Norway	Europe	GNA9135SCY501RJ	TMS
CTR_OMN	Oman	Middle East	GN0NAF4WGND8CPW	VDMS
CTR_PAN	Panama	Latin America	GNBSWD4ZH7Q2KWE	VDMS
CTR_PER	Peru	Latin America	GN30VJH0VSX6BN5	TMS
CTR_PHL	Philippines	APAC	GNF9GGNNSRAX7NF	WOI
CTR_POL	Poland	Europe	GN04ASBDNGX8J2H	VDMS
CTR_PRT	Portugal	Europe	GNFGBDF63SN2M2P	VDMS
CTR_PRI	Puerto Rico	North America	GN4Z0DTN8QEC5TE	TMS
CTR_QAT	Qatar	APAC	GN56BCZTZWR9VVJ	WOI
CTR_ROU	Romania	Europe	GN43RBDMZEYB9ZX	VDMS
CTR_RUS	Russian Federation	Europe	GN2PGA8AF7VWWMB	VDMS
CTR_KNA	Saint Kitts and Nevis	Caribbean	GN5GEDMZ2A4K62R	TMS
CTR_LCA	Saint Lucia	Caribbean	GNE8TDCS158086Z	TMS
CTR_SXM	Saint Martin	Caribbean	TBD	TMS
CTR_VCT	Saint Vincent and Grenadines	Caribbean	GN67NDTGD0GQMKW	TMS
CTR_SAU	Saudi Arabia	Middle East	GN1BPRX7BFCMXPY	WOI
CTR_ZAF	South Africa	Africa	GN76AWNXPPXZNND	VDMS
CTR_ESP	Spain	Europe	GNCVN907M8FV3FF	TMS
CTR_LKA	Sri Lanka	APAC	GNEZSHW9G085J5F	WOI
CTR_SWE	Sweden	Europe	GN04Y7T94TSZFPN	TMS
CTR_CHE	Switzerland	Europe	GNE0GWKWGW9X2R1	TMS
CTR_THA	Thailand	APAC	GN1G2TMJCZYAZTY	WOI
CTR_TTO	Trinidad and Tobago	Caribbean	GN0WM5PQS4R2FTA	TMS
CTR_TUN	Tunisia	Africa	GN1Q9XR6VS6YDV4	WOI
CTR_TUR	Turkey	Europe	GN4DFS0BQ78MEVM	VDMS
CTR_TCA	Turks and Caicos Islands	Caribbean	GN214KZX19DYC96	TMS
CTR_ARE	United Arab Emirates	APAC	GN89MGKPD95ZGN2	WOI
CTR_GBR	United Kingdom	Europe	GNA8SAG3JTSV1ZX	TMS
CTR_USA	United States of America	North America	GN8K6VWDN8EQ98M	TMS
CTR_URY	Uruguay	Latin America	GN36A9XHTQBM7JT	TMS
CTR_VEN	Venezuela (Bolivarian Republic of)	Latin America	GNAKYR74B6A6W6Z	TMS
CTR_VNM	Vietnam	APAC	GN2DR1AN80XPTJY	WOI
CTR_VGB	Virgin Islands, British	Caribbean	GNDBMAWMSG9G3CE	TMS
CTR_HKG	Hong Kong	APAC	GN1XK7QJCSH19N6	VDMS
CTR_HUN	Hungary	Europe	GN0AXE1CJQHZW3C	VDMS

Image Controlled Vocabulary

CV	Description	Additional Information
IMG_CONT_CHARACTER	Contributor Character Image	Individual cast member.
IMG_CONT_ENSEMBLE	Cast Ensemble	Major cast of a program.
IMG_CONT_ENSEMBLE_MKT	Cast Ensemble (Market)	Major cast of a program.
IMG_CONT_MAIN	Contributor Main Image	Celebrity image, not in character; often referred to as ''red carpet''.
IMG_CONT_MAIN_BRD	Contributor Main Image (Branded)	Celebrity image, not in character; often referred to as ''red carpet''.
IMG_COVER_ART_BACK	Cover Art Back	DVD Box Art Back.
IMG_COVER_ART_FRONT	Cover Art Front	DVD Box Art Front.
IMG_COVER_ART_FRONT_MKT	Cover Art Front (Market)	DVD Box Art Front.
IMG_KEY_ART	Key Art	Publicity photo for a movie, no title treatment.
IMG_KEY_ART_BRD	Key Art (Branded)	Publicity photo for a movie, no title treatment.
IMG_PRG_LOGO	Program Logo	Official logo of a show.
IMG_PRG_LOGO_BRD	Program Logo (Branded)	Official logo of a show.
IMG_PRG_MAIN_SEASON_TEXT	Program Main Image with Season Text	May contain image types such as VOD Art; a TV Show logo with no background photo; a photo of the home team Venue as the background and the 2 team logos in the foreground; a poster; a banner, etc.
IMG_PRG_MAIN_SEASON_TEXT_MKT	Program Main Image with Season Text (Market)	May contain image types such as VOD Art; a TV Show logo with no background photo; a photo of the home team Venue as the background and the 2 team logos in the foreground; a poster; a banner, etc.
IMG_PRG_STAPLE_BRD	Staple Image (Branded)	Publicity photo for a movie, no title treatment.
IMG_SOURCE_LOGO	Source Logo	Channel or Source logo.
IMG_SOURCE_LOGO_DARK	Source Logo Dark	Official logo for a channel, works well on dark backgrounds.
IMG_SOURCE_LOGO_GRAY	Source Logo Gray	Official logo for a channel.
IMG_SOURCE_LOGO_WHITE	Source Logo White	Official logo for a channel.
IMG_SPORT_LOGO_BRD	Sport Logo (Branded)	Simplified version of team logo; less small text; more distinguishable in small sizes.
IMG_CONT_CHARACTER_MKT	Contributor Character Image (Market)	Individual cast member.
IMG_COVER_ART_FRONT_BRD	Cover Art Front (Branded)	DVD Box Art Front.
IMG_PRG_LOGO_MKT	Program Logo (Market)	Official logo of a show.
IMG_PRG_STAPLE_MKT	Staple Image (Market)	Publicity photo for a movie, no title treatment.
IMG_PRG_ICONIC	Program Iconic Image	Single representative image for a program; typically same image as used for Banner but no text treatment.
IMG_PRG_STAPLE	Staple Image	Publicity photo for a movie, no title treatment.
IMG_KEY_ART_MKT	Key Art (Market)	Publicity photo for a movie, no title treatment.
IMG_SPORT_LOGO	Sport Logo	Simplified version of team logo; less small text; more distinguishable in small sizes.
IMG_SPORT_LOGO_MKT	Sport Logo (Market)	Simplified version of team logo; less small text; more distinguishable in small sizes.
IMG_CONT_CHARACTER_BRD	Contributor Character Image (Branded)	Individual cast member.
IMG_CONT_ENSEMBLE_BRD	Cast Ensemble (Branded)	Major cast of a program.
IMG_SOURCE_LOGO_LIGHT	Source Logo Light	Official logo for a channel, works well on light backgrounds.
IMG_PRG_ICONIC_BRD	Program Iconic Image (Branded)	Single representative image for a program; typically same image as used for Banner but no text treatment.
IMG_PRG_ICONIC_MKT	Program Iconic Image (Market)	Single representative image for a program; typically same image as used for Banner but no text treatment.
IMG_CONT_MAIN_MKT	Contributor Main Image (Market)	Celebrity image, not in character; often referred to as "red carpet".
IMG_PORTRAIT	Portrait	An image of a person or group of people that captures the personality of the subject by using effective lighting, backdrops, and poses. A portrait picture might be artistic, or it might be clinical, as part of a medical study.
IMG_PRG_MAIN_SEASON_TEXT_BRD	Program Main Image with Season Text (Branded)	May contain image types such as VOD Art; a TV Show logo with no background photo; a photo of the home team Venue as the background and the team logos in the foreground; a poster; a banner, etc.
IMG_PRG_MAIN	Program Main Image	May contain image types such as VOD Art; a TV Show logo with no background photo; a photo of the home team Venue as the background and the team logos in the foreground; a poster; a banner, etc.
IMG_PRG_MAIN_BRD	Program Main Image (Branded)	May contain image types such as VOD Art; a TV Show logo with no background photo; a photo of the home team Venue as the background and the team logos in the foreground; a poster; a banner, etc.
IMG_PRG_MAIN_MKT	Program Main Image (Market)	May contain image types such as VOD Art; a TV Show logo with no background photo; a photo of the home team Venue as the background and the team logos in the foreground; a poster; a banner, etc.