• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.guideCategories.html">guideCategories</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(part, regionCode=None, hl=None, id=None)</a></code></p>
79<p class="firstline">Returns a list of categories that can be associated with YouTube channels.</p>
80<h3>Method Details</h3>
81<div class="method">
82    <code class="details" id="list">list(part, regionCode=None, hl=None, id=None)</code>
83  <pre>Returns a list of categories that can be associated with YouTube channels.
84
85Args:
86  part: string, The part parameter specifies the guideCategory resource properties that the API response will include. Set the parameter value to snippet. (required)
87  regionCode: string, The regionCode parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.
88  hl: string, The hl parameter specifies the language that will be used for text values in the API response.
89  id: string, The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID.
90
91Returns:
92  An object of the form:
93
94    {
95    "eventId": "A String", # Serialized EventId of the request which produced this response.
96    "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
97    "kind": "youtube#guideCategoryListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategoryListResponse".
98    "visitorId": "A String", # The visitorId identifies the visitor.
99    "items": [ # A list of categories that can be associated with YouTube channels. In this map, the category ID is the map key, and its value is the corresponding guideCategory resource.
100      { # A guideCategory resource identifies a category that YouTube algorithmically assigns based on a channel's content or other indicators, such as the channel's popularity. The list is similar to video categories, with the difference being that a video's uploader can assign a video category but only YouTube can assign a channel category.
101        "snippet": { # Basic details about a guide category. # The snippet object contains basic details about the category, such as its title.
102          "channelId": "UCBR8-60-B28hp2BmDPdntcQ",
103          "title": "A String", # Description of the guide category.
104        },
105        "kind": "youtube#guideCategory", # Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategory".
106        "etag": "A String", # Etag of this resource.
107        "id": "A String", # The ID that YouTube uses to uniquely identify the guide category.
108      },
109    ],
110    "tokenPagination": { # Stub token pagination template to suppress results.
111    },
112    "etag": "A String", # Etag of this resource.
113    "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
114    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
115      "totalResults": 42, # The total number of results in the result set.
116      "resultsPerPage": 42, # The number of results included in the API response.
117    },
118  }</pre>
119</div>
120
121</body></html>