Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / youtube_v3.liveChatBans.html
blob: 52607c0d20778be930bf05d6ca5da6e1b43e57c3 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.liveChatBans.html">liveChatBans</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a chat ban.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Inserts a new resource into this collection.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]93 <code class="details" id="delete">delete(id, x__xgafv=None)</code>
94 <pre>Deletes a chat ban.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]95
96Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]97 id: string, A parameter (required)
98 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]102</pre>
103</div>
104
105<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]106 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
107 <pre>Inserts a new resource into this collection.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108
109Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]110 part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]112 The object takes the form of:
113
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114{ # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]116 &quot;kind&quot;: &quot;youtube#liveChatBan&quot;, # Identifies what kind of resource this is. Value: the fixed string `&quot;youtube#liveChatBan&quot;`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]118 &quot;snippet&quot;: { # The `snippet` object contains basic details about the ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]119 &quot;bannedUserDetails&quot;: {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]120 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]121 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
122 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]123 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]125 &quot;type&quot;: &quot;A String&quot;, # The type of ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 &quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of a ban, only filled if the ban has type TEMPORARY.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]127 &quot;liveChatId&quot;: &quot;A String&quot;, # The chat this ban is pertinent to.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]128 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]129 }
130
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135
136Returns:
137 An object of the form:
138
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 { # A `__liveChatBan__` resource represents a ban for a YouTube live chat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]141 &quot;kind&quot;: &quot;youtube#liveChatBan&quot;, # Identifies what kind of resource this is. Value: the fixed string `&quot;youtube#liveChatBan&quot;`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]143 &quot;snippet&quot;: { # The `snippet` object contains basic details about the ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]144 &quot;bannedUserDetails&quot;: {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]145 &quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]146 &quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
147 &quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]148 &quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]149 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]150 &quot;type&quot;: &quot;A String&quot;, # The type of ban.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]151 &quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of a ban, only filled if the ban has type TEMPORARY.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]152 &quot;liveChatId&quot;: &quot;A String&quot;, # The chat this ban is pertinent to.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]153 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]154 }</pre>
155</div>
156
157</body></html>