Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

Restricts the search to videos uploaded within the specified time period. To retrieve videos irrespective of their age, set the property to %GDATA_YOUTUBE_AGE_ALL_TIME.

author?: string

An entry author. The service returns entries where the author name and/or e-mail address match your query string.

categories?: string

A category filter.

You can query on multiple categories by listing multiple categories separated by slashes. The service returns all entries that match all of the categories (like using AND between terms). For example: Fritz/Laurie returns entries that match both categories ("Fritz" and "Laurie").

To do an OR between terms, use a pipe character (|). For example: Fritz%7CLaurie returns entries that match either category.

An entry matches a specified category if the entry is in a category that has a matching term or label, as defined in the Atom specification. (Roughly, the "term" is the internal string used by the software to identify the category, while the "label" is the human-readable string presented to a user in a user interface.)

To exclude entries that match a given category, use the form -categoryname.

To query for a category that has a scheme – such as <category scheme="urn:google.com" term="public"/> – you must place the scheme in curly braces before the category name. For example: {urn:google.com}public. To match a category that has no scheme, use an empty pair of curly braces. If you don't specify curly braces, then categories in any scheme will match.

The above features can be combined. For example: A|-{urn:google.com}B/-C means (A OR (NOT B)) AND (NOT C).

etag?: string

The ETag against which to check for updates. If the server-side ETag matches this one, the requested feed hasn't changed, and is not returned unnecessarily.

Setting any of the other query properties will unset the ETag, as ETags match against entire queries. If the ETag should be used in a query, it must be set again using gdata_query_set_etag() after setting any other properties.

isStrict?: boolean

Strict query parameter checking. If this is enabled, an error will be returned by the online service if a parameter is not recognised.

latitude?: number

The latitude of a particular location of which videos should be found. This should be used in conjunction with #GDataYouTubeQuery:longitude; if either property is outside the valid range, neither will be used. Valid latitudes are between -90 and 900 degrees; any values of this property outside that range will unset the property in the query URI.

If #GDataYouTubeQuery:location-radius is a non-0 value, this will define a circle from which videos should be found.

For more information, see the online documentation.

license?: string

The content license which should be used to filter search results. If set to, for example, %GDATA_YOUTUBE_LICENSE_CC, only videos which are Creative Commons licensed will be returned in search results. Set this to %NULL to return videos under any license.

For more information, see the online documentation.

locationRadius?: number

The radius, in metres, of a circle from within which videos should be returned. The circle is centred on the latitude and longitude given in #GDataYouTubeQuery:latitude and #GDataYouTubeQuery:longitude.

Set this property to 0 to search for specific coordinates, rather than within a given radius.

For more information, see the documentation for #GDataYouTubeQuery:latitude.

longitude?: number

The longitude of a particular location of which videos should be found. This should be used in conjunction with #GDataYouTubeQuery:latitude; if either property is outside the valid range, neither will be used. Valid longitudes are between -180 and 180 degrees; any values of this property outside that range will unset the property in the query URI.

For more information, see the documentation for #GDataYouTubeQuery:latitude.

maxResults?: number

Maximum number of results to be retrieved. Most services have a default #GDataQuery:max-results size imposed by the server; if you wish to receive the entire feed, specify a large number such as %G_MAXUINT for this property.

Use 0 to not specify a maximum number of results.

orderBy?: string

Specifies the order of entries in a feed. Supported values are relevance, published, viewCount and rating.

Additionally, results most relevant to a specific language can be returned by setting the property to relevance_lang_languageCode, where languageCode is an ISO 639-1 language code, as used in #GDataYouTubeQuery:language.

For more information, see the online documentation.

publishedMax?: number

Upper bound on the entry publish date, exclusive.

publishedMin?: number

Lower bound on the entry publish date, inclusive.

q?: string

A full-text query string.

When creating a query, list search terms separated by spaces, in the form term1 term2 term3. (As with all of the query parameter values, the spaces must be URL encoded.) The service returns all entries that match all of the search terms (like using AND between terms). Like Google's web search, a service searches on complete words (and related words with the same stem), not substrings.

To search for an exact phrase, enclose the phrase in quotation marks: "exact phrase".

To exclude entries that match a given term, use the form -term.

The search is case-insensitive.

Example: to search for all entries that contain the exact phrase "Elizabeth Bennet" and the word "Darcy" but don't contain the word "Austen", use the following query: "Elizabeth Bennet" Darcy -Austen.

restriction?: string

An ISO 3166 two-letter country code that should be used to filter videos playable only in specific countries.

Previously, this property could also accept the client’s IP address for country lookup. This feature is no longer supported by Google, and will result in an error from the server if used. Use a country code instead.

For more information, see the online documentation.

safeSearch?: YouTubeSafeSearch

Whether the search results should include restricted content as well as standard content.

For more information, see the online documentation.

startIndex?: number

The one-based index of the first result to be retrieved. Use gdata_query_next_page() and gdata_query_previous_page() to implement pagination, rather than manually changing #GDataQuery:start-index.

Use 0 to not specify a start index.

updatedMax?: number

Upper bound on the entry update date, exclusive.

updatedMin?: number

Lower bound on the entry update date, inclusive.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method