Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / youtube_v3.thirdPartyLinks.html
blob: 2c309bdb5347aadb7ee3c7c1c5f0e5aa7284a0c8 [file] [log] [blame]
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[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
75<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.thirdPartyLinks.html">thirdPartyLinks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(linkingToken, type, part=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a resource.</p>
80<p class="toc_element">
81 <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Inserts a new resource into this collection.</p>
83<p class="toc_element">
84 <code><a href="#list">list(part, linkingToken=None, type=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
86<p class="toc_element">
87 <code><a href="#update">update(part, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Updates an existing resource.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(linkingToken, type, part=None, x__xgafv=None)</code>
92 <pre>Deletes a resource.
93
94Args:
95 linkingToken: string, Delete the partner links with the given linking token. (required)
96 type: string, Type of the link to be deleted. (required)
97 part: string, Do not use. Required for compatibility. (repeated)
98 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
102</pre>
103</div>
104
105<div class="method">
106 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
107 <pre>Inserts a new resource into this collection.
108
109Args:
110 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies the
111&lt;code&gt;thirdPartyLink&lt;/code&gt; resource parts that the API request and
112response will include. Supported values are &lt;code&gt;linkingToken&lt;/code&gt;,
113&lt;code&gt;status&lt;/code&gt;, and &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
114 body: object, The request body.
115 The object takes the form of:
116
117{ # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
118 # a link between a YouTube account or a channel and an account on a
119 # third-party service.
120 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the third-
121 # party account link.
122 # type-specific information.
123 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a # Information specific to a link between a channel and a store on a
124 # merchandising platform.
125 # YouTube channel.
126 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
127 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
128 },
129 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
130 },
131 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
132 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
133 # &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
134 &quot;status&quot;: { # The &lt;code&gt;third-party link status&lt;/code&gt; object contains information about # The &lt;code&gt;status&lt;/code&gt; object contains information about the status
135 # of the link.
136 # the status of the link.
137 &quot;linkStatus&quot;: &quot;A String&quot;,
138 },
139 &quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
140 # channel with which the third party account is linked.
141 }
142
143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
147
148Returns:
149 An object of the form:
150
151 { # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
152 # a link between a YouTube account or a channel and an account on a
153 # third-party service.
154 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the third-
155 # party account link.
156 # type-specific information.
157 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a # Information specific to a link between a channel and a store on a
158 # merchandising platform.
159 # YouTube channel.
160 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
161 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
162 },
163 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
164 },
165 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
166 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
167 # &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
168 &quot;status&quot;: { # The &lt;code&gt;third-party link status&lt;/code&gt; object contains information about # The &lt;code&gt;status&lt;/code&gt; object contains information about the status
169 # of the link.
170 # the status of the link.
171 &quot;linkStatus&quot;: &quot;A String&quot;,
172 },
173 &quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
174 # channel with which the third party account is linked.
175 }</pre>
176</div>
177
178<div class="method">
179 <code class="details" id="list">list(part, linkingToken=None, type=None, x__xgafv=None)</code>
180 <pre>Retrieves a list of resources, possibly filtered.
181
182Args:
183 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies the
184&lt;code&gt;thirdPartyLink&lt;/code&gt; resource parts that the API response will
185include. Supported values are &lt;code&gt;linkingToken&lt;/code&gt;,
186&lt;code&gt;status&lt;/code&gt;, and &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
187 linkingToken: string, Get a third party link with the given linking token.
188 type: string, Get a third party link of the given type.
189 x__xgafv: string, V1 error format.
190 Allowed values
191 1 - v1 error format
192 2 - v2 error format
193
194Returns:
195 An object of the form:
196
197 { # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
198 # a link between a YouTube account or a channel and an account on a
199 # third-party service.
200 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the third-
201 # party account link.
202 # type-specific information.
203 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a # Information specific to a link between a channel and a store on a
204 # merchandising platform.
205 # YouTube channel.
206 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
207 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
208 },
209 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
210 },
211 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
212 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
213 # &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
214 &quot;status&quot;: { # The &lt;code&gt;third-party link status&lt;/code&gt; object contains information about # The &lt;code&gt;status&lt;/code&gt; object contains information about the status
215 # of the link.
216 # the status of the link.
217 &quot;linkStatus&quot;: &quot;A String&quot;,
218 },
219 &quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
220 # channel with which the third party account is linked.
221 }</pre>
222</div>
223
224<div class="method">
225 <code class="details" id="update">update(part, body=None, x__xgafv=None)</code>
226 <pre>Updates an existing resource.
227
228Args:
229 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies the
230&lt;code&gt;thirdPartyLink&lt;/code&gt; resource parts that the API request and
231response will include. Supported values are &lt;code&gt;linkingToken&lt;/code&gt;,
232&lt;code&gt;status&lt;/code&gt;, and &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
233 body: object, The request body.
234 The object takes the form of:
235
236{ # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
237 # a link between a YouTube account or a channel and an account on a
238 # third-party service.
239 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the third-
240 # party account link.
241 # type-specific information.
242 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a # Information specific to a link between a channel and a store on a
243 # merchandising platform.
244 # YouTube channel.
245 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
246 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
247 },
248 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
249 },
250 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
251 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
252 # &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
253 &quot;status&quot;: { # The &lt;code&gt;third-party link status&lt;/code&gt; object contains information about # The &lt;code&gt;status&lt;/code&gt; object contains information about the status
254 # of the link.
255 # the status of the link.
256 &quot;linkStatus&quot;: &quot;A String&quot;,
257 },
258 &quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
259 # channel with which the third party account is linked.
260 }
261
262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
266
267Returns:
268 An object of the form:
269
270 { # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
271 # a link between a YouTube account or a channel and an account on a
272 # third-party service.
273 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the third-
274 # party account link.
275 # type-specific information.
276 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a # Information specific to a link between a channel and a store on a
277 # merchandising platform.
278 # YouTube channel.
279 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
280 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
281 },
282 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
283 },
284 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
285 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
286 # &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
287 &quot;status&quot;: { # The &lt;code&gt;third-party link status&lt;/code&gt; object contains information about # The &lt;code&gt;status&lt;/code&gt; object contains information about the status
288 # of the link.
289 # the status of the link.
290 &quot;linkStatus&quot;: &quot;A String&quot;,
291 },
292 &quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
293 # channel with which the third party account is linked.
294 }</pre>
295</div>
296
297</body></html>