blob: 2eabc0f0347960c0162ea570d4b339b484849e9e [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.videoCategories.html">videoCategories</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(part, regionCode=None, hl=None, id=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(part, regionCode=None, hl=None, id=None, x__xgafv=None)</code>
<pre>Retrieves a list of resources, possibly filtered.
Args:
part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies the
&lt;code&gt;videoCategory&lt;/code&gt; resource properties that the API response will
include. Set the parameter value to &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
regionCode: string, A parameter
hl: string, A parameter
id: string, Returns the video categories with the given IDs for Stubby or Apiary. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;prevPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the &lt;code&gt;pageToken&lt;/code&gt;
# parameter to retrieve the previous page in the result set.
&quot;items&quot;: [ # A list of video categories that can be associated with YouTube videos. In
# this map, the video category ID is the map key, and its value is the
# corresponding &lt;code&gt;videoCategory&lt;/code&gt; resource.
{ # A &lt;code&gt;&lt;strong&gt;videoCategory&lt;/strong&gt;&lt;/code&gt; resource identifies a
# category that has been or could be associated with uploaded videos.
&quot;snippet&quot;: { # Basic details about a video category, such as its localized title. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the video
# category, including its title.
&quot;assignable&quot;: True or False,
&quot;title&quot;: &quot;A String&quot;, # The video category&#x27;s title.
&quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel that created the video category.
},
&quot;kind&quot;: &quot;youtube#videoCategory&quot;, # Identifies what kind of resource this is. Value: the fixed string
# &lt;code&gt;&quot;youtube#videoCategory&quot;&lt;/code&gt;.
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
&quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video category.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the &lt;code&gt;pageToken&lt;/code&gt;
# parameter to retrieve the next page in the result set.
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
&quot;visitorId&quot;: &quot;A String&quot;, # The &lt;code&gt;visitorId&lt;/code&gt; identifies the visitor.
&quot;kind&quot;: &quot;youtube#videoCategoryListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string
# &lt;code&gt;&quot;youtube#videoCategoryListResponse&quot;&lt;/code&gt;.
&quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
},
&quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
&quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items # General pagination information.
# available and number of resources returned in a single page.
&quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
&quot;totalResults&quot;: 42, # The total number of results in the result set.
},
}</pre>
</div>
</body></html>