|
<Response>
|
The top-level field for the XML response.
|
|
<method>
|
Parent tag: <Response>
A string containing the name of the API method used to retrieve the response. In this case, this field would return the string 'truveo.users.getFavoriteVideos'.
|
|
<VideoSet>
|
Parent tag: <Response>
The container for all of the video records in the set of returned videos.
|
|
<totalResultsAvailable>
|
Parent tag: <VideoSet>
An integer representing the total number of videos in the entire set of matching videos.
|
|
<totalResultsReturned>
|
Parent tag: <VideoSet>
An integer representing the total number of videos returned in this VideoSet.
|
|
<firstResultPosition>
|
Parent tag: <VideoSet>
An integer representing the position of the first Video in the entire set of matching videos.
|
|
<title>
|
Parent tag: <VideoSet>
A string containing a human-readable title for the set of videos returned in response to the submitted request. For example, this field would return a string such as "Most popular 'madonna' videos in Music on MTV" for the query 'madonna category:Music channel:MTV sort:mostPopular'.
|
|
<rssUrl>
|
Parent tag: <VideoSet>
A string containing the URL which will return an RSS feed for the set of videos returned in response to the submitted query.
|
|
<embedTag>
|
Parent tag: <VideoSet>
A string containing an HTML fragment that can be used to embed the returned video search results into a web page. When this HTML fragment is pasted into an existing webpage, it will automatically display a set of clickable thumbnails for the videos that match the submitted query.
|
|
<Video>
|
Parent tag: <VideoSet>
The container for all of the available metadata fields for an individual video record.
|
|
<id>
|
Parent tag: <Video>
A string which serves as a unique identifier for the video record. Each returned video will always have a valid id value.
|
|
<title>
|
Parent tag: <Video>
A string containing the title of the video in this result. Each returned video will always contain a title.
|
|
<videoUrl>
|
Parent tag: <Video>
A string containing the URL which, when be loaded into a browser window, will play the video. Loading this URL into a browser will result in two possible behaviors. For video that plays from an embedded player inside a web page, loading this URL will simply open the web page that contains the embedded video player. For video that plays in a standalone media player, loading this URL will first open the web page which links to the video (also called the 'referrer page') and then open a standalone media player which will play the video. Each returned video will always have a valid videoUrl value.
|
|
<channel>
|
Parent tag: <Video>
A string containing the name of the channel associated with this video record. For example, this string might contain a value such as 'CNN', 'ESPN', 'MTV', 'YouTube', etc.. Each returned video will always have a valid channel value.
|
|
<channelUrl>
|
Parent tag: <Video>
A string containing the URL for the channel associated with this video record. For example, this string might contain 'http:\www.cnn.com', 'http:\www.espn.com', etc.. Each returned video will always have a valid channelUrl value.
|
|
<dateFound>
|
Parent tag: <Video>
A string representation of the date when this video was first indexed by the Truveo video search engine. The format of this date conforms to the RFC 2822 specification. For example, 'Thu, 21 Dec 2000 16:01:07 +0200' is the typical date format. Each returned video will always have a valid dateFound value.
|
|
<vRank>
|
Parent tag: <Video>
A decimal value between 0 and 1 which represents the rank of this video record in the Truveo video search engine. VRank is an aggregate metric that is continuously calculated and assigned to each video record based on factors such as video popularity, recency, quality, etc.. Unless an alternate sorting operator is applied to the search results, the videos returned in response to a request will be ordered by descending vRank value. Each returned video will always have a valid vRank value.
|
|
<textRelevancy>
|
Parent tag: <Video>
A decimal value between 0 and 1 indicating how closely the text in the submitted query matches the text in this video record. A higher value indicates that the text in this video record is more closely related to the submitted query.
|
|
<description>
|
Parent tag: <Video>
A string containing a text description of the video in this result. When provided, this length of this description is typically one to three sentences.
|
|
<referrerPageUrl>
|
Parent tag: <Video>
A string containing the URL of the web page where a link to the video in this result is located.
|
|
<actor>
|
Parent tag: <Video>
A string containing the names of one or multiple actors associated with the video in this result. When available, this string is typically a comma-separated list of actor names.
|
|
<director>
|
Parent tag: <Video>
A string containing the names of one or multiple directors associated with the video in this result. When available, this string is typically a comma-separated list of director names.
|
|
<writer>
|
Parent tag: <Video>
A string containing the names of one or multiple writers associated with the video in this result. When available, this string is typically a comma-separated list of writer names.
|
|
<producer>
|
Parent tag: <Video>
A string containing the names of one or multiple producers associated with the video in this result. This field is commonly used for movie trailers and clips. When available, this string is typically a comma-separated list of director names.
|
|
<artist>
|
Parent tag: <Video>
A string containing the name of the musical artist or group associated with the video in this result. This field is typically used for clips such as music videos.
|
|
<album>
|
Parent tag: <Video>
A string containing the name of the musical album associated with the video in this result. This field is typically used for clips such as music videos.
|
|
<distributor>
|
Parent tag: <Video>
A string containing the name of the distribution organization, such as 'Warner Brothers' or 'Sony Pictures', associated with the video in this result.
|
|
<author>
|
Parent tag: <Video>
A string containing the name of the person or organization responsible for authoring the video associated with this result.
|
|
<copyright>
|
Parent tag: <Video>
A string containing any applicable copyright message for the video in this result.
|
|
<rating>
|
Parent tag: <Video>
A string containing the rating for the video in this result. For example, this field may contain a value such as 'G', 'PG-13', 'TV-MA', etc..
|
|
<runtime>
|
Parent tag: <Video>
An integer which represents the duration of the video clip in seconds.
|
|
<category>
|
Parent tag: <Video>
A string that contains the category of the video in this result. For example, this field might contain a value such as 'News', 'Sports', 'Movies', etc..
|
|
<tags>
|
Parent tag: <Video>
A string that contains a comma-delimited list of tags that are used to describe the video in this results. For example, this string might be something like 'funny, jerry seinfeld, TV'.
|
|
<showName>
|
Parent tag: <Video>
A string that contains the name of the show associated with the video in this result. For example, this field could contain a value such as 'Welcome Back Kotter', 'Star Trek', 'Scrubs', etc.. This field is typically used for television shows and clips.
|
|
<showUrl>
|
Parent tag: <Video>
A string that contains the URL which will provide additional information about the show identified in the showName field.
|
|
<episodeName>
|
Parent tag: <Video>
A string that contains the episode name associated with the video in this result. For example, for the television show 'Star Trek', an episode name might be 'The Trouble With Tribbles', 'The Enemy Within', etc.. This field is typically used for television shows and clips.
|
|
<episodeNumber>
|
Parent tag: <Video>
A string that contains a numerical value representing the episode number associated with the video in this result. This field is typically used for television shows and clips.
|
|
<seasonNumber>
|
Parent tag: <Video>
A string that contains a numerical value representing the season number associated with the video in this result. This field is typically used for television shows and clips.
|
|
<country>
|
Parent tag: <Video>
A string that contains the name of the country of origin specified for the video in this result. For example, this field might contain a value such as 'United States', 'France', 'Canada', etc.. Generally, country names will correspond with the ISO 3166-1 specification.
|
|
<language>
|
Parent tag: <Video>
A string that contains the language associated with the video in this result. For example, this field might contain a value such as 'English', 'French', etc.. Generally, language names will correspond with the ISO 639 specification.
|
|
<dateProduced>
|
Parent tag: <Video>
A string that describes the date or time period when the video in this result was originally produced.
|
|
<registerUrl>
|
Parent tag: <Video>
A string containing the URL which provides more information about how to register to access the video in this result. This field is only populated for video that can be viewed for free but requires each user to register with the host site before the video can be viewed.
|
|
<subscribeUrl>
|
Parent tag: <Video>
A string containing the URL which provides more information about how to subscribe to access the video in this result. This field is only populated for video which requires users to purchase a subscription before the video can be viewed.
|
|
<subscribePrice>
|
Parent tag: <Video>
A string containing the subscription price, as described by the subscribeUrl. For example, this field could contain the value '$10.99', '€5.99', etc..
|
|
<rentUrl>
|
Parent tag: <Video>
A string containing the URL which provides more information about how to rent the video in this result. This field is only populated for video that can be rented for a fee.
|
|
<rentPrice>
|
Parent tag: <Video>
A string containing the rent price, as described by the rentUrl. For example, this field could contain the value '$0.99', '€1.99', etc..
|
|
<buyUrl>
|
Parent tag: <Video>
A string containing the URL which provides more information about how to buy the video in this result. This field is only populated for video that can be purchased to own.
|
|
<buyPrice>
|
Parent tag: <Video>
A string containing the purchase price, as described by the buyUrl. For example, this field could contain the value '$14.99', '€10.99', etc..
|
|
<live>
|
Parent tag: <Video>
An integer indicating if the video in this result is a live stream. If the value of this field is '1', the video is a live stream. Otherwise, the video is not live.
|
|
<editorsPick>
|
Parent tag: <Video>
An integer indicating if the video in this result has been featured by a human editor. If the value of this field is '1', the video has been promoted in the search results by a human editor.
|
|
<viewCount>
|
Parent tag: <Video>
An integer representing the number of times the video in this result has been viewed.
|
|
<favoriteCount>
|
Parent tag: <Video>
An integer representing the number of times the video in this result has been selected as a user favorite.
|
|
<userRating>
|
Parent tag: <Video>
A decimal value between 0 and 5 representing the average user rating for the video in this result.
|
|
<userRatingCount>
|
Parent tag: <Video>
An integer representing the number of times this video has been rated.
|
|
<thumbnailUrl>
|
Parent tag: <Video>
A string containing the URL for the thumbnail image associated with the video in this result. While all thumbnails will not necessarily have a consistent height and width, this thumbnail image will typically have a width of 75 pixels.
|
|
<thumbnailUrlLarge>
|
Parent tag: <Video>
A string containing the URL for a large-format thumbnail image associated with the video in this result. This thumbnail image will typically have a width of 400 pixels.
|
|
<previewVideoUrl>
|
Parent tag: <Video>
A string containing the URL that will play a free preview of the video in this record. This field is typically used for premium video, where the video specified by the videoUrl field can only be viewed after a purchase has been made.
|
|
<hiDefVideoUrl>
|
Parent tag: <Video>
A string containing the URL that will play a high-definition version of the video in this record. For example, for videos that are available in AOL Hi-Q format, this field will provide the URL that, when loaded in a browser, will begin playing a high-definition version of this video.
|
|
<videoPlayerEmbedTag>
|
Parent tag: <Video>
A string containing the HTML tag which, when embedded in an existing web page, will launch an inline media player to play the video in this result.
|
|
<videoResultEmbedTag>
|
Parent tag: <Video>
A string containing the HTML tag which, when embedded in an existing web page, will display a thumbnail and related information about the video in this result. When this thumbnail is clicked, it will launch the appropriate media player to play the video.
|
|
<quality>
|
Parent tag: <Video>
A string that describes the quality of the video in this result. For example, the value of this field could be 'excellent', 'good', 'fair' or 'poor'.
|
|
<formats>
|
Parent tag: <Video>
A string containing a comma-separated list of the formats supported by the video in this result. For example, for a video that can be played using Windows Media Player, RealPlayer, or QuickTime, the value in this field would be 'win, real, qt'.
|
|
<bitrate>
|
Parent tag: <Video>
A string such as '300 kbps' that describes the bitrate of the video in this result.
|
|
<width>
|
Parent tag: <Video>
An integer representing the value in pixels for the width of the video in this result.
|
|
<height>
|
Parent tag: <Video>
An integer representing the value in pixels for the height of the video in this result.
|
|
<fileSize>
|
Parent tag: <Video>
A string such as '5204 kb' that specifies the size of the file associated with the video in this result.
|
|
<frameRate>
|
Parent tag: <Video>
A string such as '24 fps' that specifies the frame rate of this video in this result.
|
|
<codec>
|
Parent tag: <Video>
A string that identifies the codec used to encode the video in this result.
|
|
<sponsored>
|
Parent tag: <Video>
An integer representing the type of sponsored result this video is. 0 indicates unsponsored result, 1 indicates contextually relevant sponsored result, and 2 indicates a non-contextual sponsored result. For testing purposes, these queries always return a sponsored result: 'vsl', 'sim:3276274608'.
|
|
<canonicalId>
|
Parent tag: <Video>
A video record can have multiple unique identifiers. The canonical id is designed to be used for the canonical link element so that one video record only has one identifier for SEO purposes.
|
|
<redirectFor>
|
Parent tag: <Video>
For certain browsers, a video cannot be displayed in an iframe. This field lists these browsers for the video, if any.
|
|
<TagSet>
|
Parent tag: <Response>
The container for all of the tags associated with the entire set of matching videos. The TagSet is returned only if the parameter 'showRelatedItems' is set to 1.
|
|
<totalResultsReturned>
|
Parent tag: <TagSet>
An integer representing the total number of tags returned in this TagSet.
|
|
<firstResultPosition>
|
Parent tag: <TagSet>
An integer representing the position of the first Tag in the set of returned tags.
|
|
<Tag>
|
Parent tag: <TagSet>
The container for the name and count values of a single tag.
|
|
<name>
|
Parent tag: <Tag>
A string containing the name of the tag.
|
|
<count>
|
Parent tag: <Tag>
An integer representing the total number of times this tag has been assigned to any of the videos in the result set.
|
|
<ChannelSet>
|
Parent tag: <Response>
The container for all of the channels associated with the entire set of matching videos. The ChannelSet is returned only if the parameter 'showRelatedItems' is set to 1.
|
|
<totalResultsReturned>
|
Parent tag: <ChannelSet>
An integer representing the total number of channels returned in this ChannelSet.
|
|
<firstResultPosition>
|
Parent tag: <ChannelSet>
An integer representing the position of the first Channel in the set of returned channels.
|
|
<Channel>
|
Parent tag: <ChannelSet>
The container for the name and count values of a single channel.
|
|
<name>
|
Parent tag: <Channel>
A string containing the name of the channel.
|
|
<count>
|
Parent tag: <Channel>
An integer representing the total number of times this channel has been assigned to any of the videos in the result set.
|
|
<CategorySet>
|
Parent tag: <Response>
The container for all of the categories associated with the entire set of matching videos. The CategorySet is returned only if the parameter 'showRelatedItems' is set to 1.
|
|
<totalResultsReturned>
|
Parent tag: <CategorySet>
An integer representing the total number of categories returned in this CategorySet.
|
|
<firstResultPosition>
|
Parent tag: <CategorySet>
An integer representing the position of the first Category in the set of returned categories.
|
|
<Category>
|
Parent tag: <CategorySet>
The container for the name and count values of a single category.
|
|
<name>
|
Parent tag: <Category>
A string containing the name of the category.
|
|
<count>
|
Parent tag: <Category>
An integer representing the total number of times this category has been assigned to any of the videos in the result set.
|
|
<UserSet>
|
Parent tag: <Response>
The container for all of the users associated with the entire set of matching videos. The UserSet is returned only if the parameter 'showRelatedItems' is set to 1.
|
|
<totalResultsReturned>
|
Parent tag: <UserSet>
An integer representing the total number of users returned in this UserSet.
|
|
<firstResultPosition>
|
Parent tag: <UserSet>
An integer representing the position of the first User in the set of returned users.
|
|
<User>
|
Parent tag: <UserSet>
The container for the name and count values of a single user.
|
|
<name>
|
Parent tag: <User>
A string containing the name of the user.
|
|
<count>
|
Parent tag: <User>
An integer representing the total number of times this user has been assigned to any of the videos in the result set.
|