Skip to content

Commit 75602dc

Browse files
yoshi-automationyoshi-automation
committed
feat(youtube): update the api
#### youtube:v3 The following keys were added: - resources.youtube.resources.v3.resources.videos.methods.batchGetStats (Total Keys: 14) - schemas.BatchGetStatsResponse (Total Keys: 8) - schemas.VideoStat (Total Keys: 35)
1 parent 1b4827d commit 75602dc

File tree

3 files changed

+289
-1
lines changed

3 files changed

+289
-1
lines changed

‎docs/dyn/youtube_v3.youtube.v3.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the liveChat Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="youtube_v3.youtube.v3.videos.html">videos()</a></code>
84+
</p>
85+
<p class="firstline">Returns the videos Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="#close">close()</a></code></p>
8489
<p class="firstline">Close httplib2 connections.</p>

‎docs/dyn/youtube_v3.youtube.v3.videos.html‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
<html><body>
2+
<style>
3+
4+
body, 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+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, 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 v3</a> . <a href="youtube_v3.youtube.html">youtube</a> . <a href="youtube_v3.youtube.v3.html">v3</a> . <a href="youtube_v3.youtube.v3.videos.html">videos</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#batchGetStats">batchGetStats(onBehalfOfContentOwner=None, part=None, videoIds=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Retrieves a batch of VideoStat resources, possibly filtered.</p>
80+
<p class="toc_element">
81+
<code><a href="#close">close()</a></code></p>
82+
<p class="firstline">Close httplib2 connections.</p>
83+
<h3>Method Details</h3>
84+
<div class="method">
85+
<code class="details" id="batchGetStats">batchGetStats(onBehalfOfContentOwner=None, part=None, videoIds=None, x__xgafv=None)</code>
86+
<pre>Retrieves a batch of VideoStat resources, possibly filtered.
87+
88+
Args:
89+
onBehalfOfContentOwner: string, Optional. **Note:** This parameter is intended exclusively for YouTube content partners. The `onBehalfOfContentOwner` parameter indicates that the request&#x27;s authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
90+
part: string, Required. The `**part**` parameter specifies a comma-separated list of one or more `videoStat` resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a `videoStat` resource, the `statistics` property contains `view_count` and `like_count`. As such, if you set `**part=snippet**`, the API response will contain all of those properties. (repeated)
91+
videoIds: string, Required. Return videos with the given ids. (repeated)
92+
x__xgafv: string, V1 error format.
93+
Allowed values
94+
1 - v1 error format
95+
2 - v2 error format
96+
97+
Returns:
98+
An object of the form:
99+
100+
{ # Response for the Videos.stats API. Returns VideoStat information about a batch of videos. VideoStat contains a subset of the information in Video that is relevant to statistics and content details.
101+
&quot;etag&quot;: &quot;A String&quot;, # Output only. Etag of this resource.
102+
&quot;items&quot;: [ # Output only. The videos&#x27; stats information.
103+
{ # A *VideoStat* resource represents a YouTube video&#x27;s stats.
104+
&quot;contentDetails&quot;: { # Details about the content of a YouTube Video. This is a subset of the information in VideoContentDetails specifically for the Videos.stats API. # Output only. The VideoStatsContentDetails object contains information about the video content, including the length of the video.
105+
&quot;duration&quot;: &quot;A String&quot;, # Output only. The length of the video. The property value is a [`google.protobuf.Duration`](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) object.
106+
},
107+
&quot;etag&quot;: &quot;A String&quot;, # Output only. Etag of this resource.
108+
&quot;kind&quot;: &quot;A String&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string &quot;youtube#videoStats&quot;.
109+
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name for the `VideoStats` resource, in the format `videoStats/{video_stat}`.
110+
&quot;snippet&quot;: { # Basic details about a video. This is a subset of the information in VideoSnippet specifically for the Videos.stats API. # Output only. The VideoStatsSnippet object contains basic details about the video, such publish time.
111+
&quot;publishTime&quot;: &quot;A String&quot;, # Output only. The date and time that the video was uploaded. The property value is a [`google.protobuf.Timestamp`](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp) object.
112+
},
113+
&quot;statistics&quot;: { # Statistics about the video, such as the number of times the video was viewed or liked. # Output only. The VideoStatsStatistics object contains statistics about the video.
114+
&quot;commentCount&quot;: &quot;A String&quot;, # Output only. The number of comments for the video.
115+
&quot;likeCount&quot;: &quot;A String&quot;, # Output only. The number of users who have indicated that they liked the video by giving it a positive rating.
116+
&quot;viewCount&quot;: &quot;A String&quot;, # Output only. The number of times the video has been viewed.
117+
},
118+
&quot;videoId&quot;: &quot;A String&quot;, # Output only. The ID that YouTube uses to uniquely identify the video.
119+
},
120+
],
121+
&quot;kind&quot;: &quot;youtube#batchGetStatsResponse&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string &quot;youtube#batchGetStatsResponse&quot;.
122+
}</pre>
123+
</div>
124+
125+
<div class="method">
126+
<code class="details" id="close">close()</code>
127+
<pre>Close httplib2 connections.</pre>
128+
</div>
129+
130+
</body></html>

‎googleapiclient/discovery_cache/documents/youtube.v3.json‎

Lines changed: 154 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4166,13 +4166,47 @@
41664166
}
41674167
}
41684168
}
4169+
},
4170+
"videos": {
4171+
"methods": {
4172+
"batchGetStats": {
4173+
"description": "Retrieves a batch of VideoStat resources, possibly filtered.",
4174+
"flatPath": "youtube/v3/videos:batchGetStats",
4175+
"httpMethod": "GET",
4176+
"id": "youtube.youtube.v3.videos.batchGetStats",
4177+
"parameterOrder": [],
4178+
"parameters": {
4179+
"onBehalfOfContentOwner": {
4180+
"description": "Optional. **Note:** This parameter is intended exclusively for YouTube content partners. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
4181+
"location": "query",
4182+
"type": "string"
4183+
},
4184+
"part": {
4185+
"description": "Required. The `**part**` parameter specifies a comma-separated list of one or more `videoStat` resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a `videoStat` resource, the `statistics` property contains `view_count` and `like_count`. As such, if you set `**part=snippet**`, the API response will contain all of those properties.",
4186+
"location": "query",
4187+
"repeated": true,
4188+
"type": "string"
4189+
},
4190+
"videoIds": {
4191+
"description": "Required. Return videos with the given ids.",
4192+
"location": "query",
4193+
"repeated": true,
4194+
"type": "string"
4195+
}
4196+
},
4197+
"path": "youtube/v3/videos:batchGetStats",
4198+
"response": {
4199+
"$ref": "BatchGetStatsResponse"
4200+
}
4201+
}
4202+
}
41694203
}
41704204
}
41714205
}
41724206
}
41734207
}
41744208
},
4175-
"revision": "20250714",
4209+
"revision": "20251125",
41764210
"rootUrl": "https://youtube.googleapis.com/",
41774211
"schemas": {
41784212
"AbuseReport": {
@@ -4647,6 +4681,32 @@
46474681
},
46484682
"type": "object"
46494683
},
4684+
"BatchGetStatsResponse": {
4685+
"description": "Response for the Videos.stats API. Returns VideoStat information about a batch of videos. VideoStat contains a subset of the information in Video that is relevant to statistics and content details.",
4686+
"id": "BatchGetStatsResponse",
4687+
"properties": {
4688+
"etag": {
4689+
"description": "Output only. Etag of this resource.",
4690+
"readOnly": true,
4691+
"type": "string"
4692+
},
4693+
"items": {
4694+
"description": "Output only. The videos' stats information.",
4695+
"items": {
4696+
"$ref": "VideoStat"
4697+
},
4698+
"readOnly": true,
4699+
"type": "array"
4700+
},
4701+
"kind": {
4702+
"default": "youtube#batchGetStatsResponse",
4703+
"description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"youtube#batchGetStatsResponse\".",
4704+
"readOnly": true,
4705+
"type": "string"
4706+
}
4707+
},
4708+
"type": "object"
4709+
},
46504710
"Caption": {
46514711
"description": "A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.",
46524712
"id": "Caption",
@@ -12068,6 +12128,48 @@ true
1206812128
},
1206912129
"type": "object"
1207012130
},
12131+
"VideoStat": {
12132+
"description": "A *VideoStat* resource represents a YouTube video's stats.",
12133+
"id": "VideoStat",
12134+
"properties": {
12135+
"contentDetails": {
12136+
"$ref": "VideoStatsContentDetails",
12137+
"description": "Output only. The VideoStatsContentDetails object contains information about the video content, including the length of the video.",
12138+
"readOnly": true
12139+
},
12140+
"etag": {
12141+
"description": "Output only. Etag of this resource.",
12142+
"readOnly": true,
12143+
"type": "string"
12144+
},
12145+
"kind": {
12146+
"description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"youtube#videoStats\".",
12147+
"readOnly": true,
12148+
"type": "string"
12149+
},
12150+
"name": {
12151+
"description": "Output only. Identifier. The resource name for the `VideoStats` resource, in the format `videoStats/{video_stat}`.",
12152+
"readOnly": true,
12153+
"type": "string"
12154+
},
12155+
"snippet": {
12156+
"$ref": "VideoStatsSnippet",
12157+
"description": "Output only. The VideoStatsSnippet object contains basic details about the video, such publish time.",
12158+
"readOnly": true
12159+
},
12160+
"statistics": {
12161+
"$ref": "VideoStatsStatistics",
12162+
"description": "Output only. The VideoStatsStatistics object contains statistics about the video.",
12163+
"readOnly": true
12164+
},
12165+
"videoId": {
12166+
"description": "Output only. The ID that YouTube uses to uniquely identify the video.",
12167+
"readOnly": true,
12168+
"type": "string"
12169+
}
12170+
},
12171+
"type": "object"
12172+
},
1207112173
"VideoStatistics": {
1207212174
"description": "Statistics about the video, such as the number of times the video was viewed or liked.",
1207312175
"id": "VideoStatistics",
@@ -12101,6 +12203,57 @@ true
1210112203
},
1210212204
"type": "object"
1210312205
},
12206+
"VideoStatsContentDetails": {
12207+
"description": "Details about the content of a YouTube Video. This is a subset of the information in VideoContentDetails specifically for the Videos.stats API.",
12208+
"id": "VideoStatsContentDetails",
12209+
"properties": {
12210+
"duration": {
12211+
"description": "Output only. The length of the video. The property value is a [`google.protobuf.Duration`](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) object.",
12212+
"format": "google-duration",
12213+
"readOnly": true,
12214+
"type": "string"
12215+
}
12216+
},
12217+
"type": "object"
12218+
},
12219+
"VideoStatsSnippet": {
12220+
"description": "Basic details about a video. This is a subset of the information in VideoSnippet specifically for the Videos.stats API.",
12221+
"id": "VideoStatsSnippet",
12222+
"properties": {
12223+
"publishTime": {
12224+
"description": "Output only. The date and time that the video was uploaded. The property value is a [`google.protobuf.Timestamp`](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp) object.",
12225+
"format": "google-datetime",
12226+
"readOnly": true,
12227+
"type": "string"
12228+
}
12229+
},
12230+
"type": "object"
12231+
},
12232+
"VideoStatsStatistics": {
12233+
"description": "Statistics about the video, such as the number of times the video was viewed or liked.",
12234+
"id": "VideoStatsStatistics",
12235+
"properties": {
12236+
"commentCount": {
12237+
"description": "Output only. The number of comments for the video.",
12238+
"format": "int64",
12239+
"readOnly": true,
12240+
"type": "string"
12241+
},
12242+
"likeCount": {
12243+
"description": "Output only. The number of users who have indicated that they liked the video by giving it a positive rating.",
12244+
"format": "int64",
12245+
"readOnly": true,
12246+
"type": "string"
12247+
},
12248+
"viewCount": {
12249+
"description": "Output only. The number of times the video has been viewed.",
12250+
"format": "int64",
12251+
"readOnly": true,
12252+
"type": "string"
12253+
}
12254+
},
12255+
"type": "object"
12256+
},
1210412257
"VideoStatus": {
1210512258
"description": "Basic details about a video category, such as its localized title. Next Id: 19",
1210612259
"id": "VideoStatus",

0 commit comments

Comments
 (0)