Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / youtube_v3.thirdPartyLinks.html
blob: 7df56345b9251418e019e8c466257069332f0dee [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">
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(linkingToken, type, part=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a resource.</p>
83<p class="toc_element">
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>
86<p class="toc_element">
87 <code><a href="#list">list(part, linkingToken=None, type=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
89<p class="toc_element">
90 <code><a href="#update">update(part, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Updates an existing resource.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 <code class="details" id="delete">delete(linkingToken, type, part=None, x__xgafv=None)</code>
100 <pre>Deletes a resource.
101
102Args:
103 linkingToken: string, Delete the partner links with the given linking token. (required)
104 type: string, Type of the link to be deleted. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]105 Allowed values
106 linkUnspecified -
107 channelToStoreLink - A link that is connecting (or about to connect) a channel with a store on a merchandising platform in order to enable retail commerce capabilities for that channel on YouTube.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]108 part: string, Do not use. Required for compatibility. (repeated)
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113</pre>
114</div>
115
116<div class="method">
117 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
118 <pre>Inserts a new resource into this collection.
119
120Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]121 part: string, The *part* parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet. (required) (repeated)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]122 body: object, The request body.
123 The object takes the form of:
124
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]125{ # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
126 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
127 &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]128 &quot;linkStatus&quot;: &quot;A String&quot;,
129 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]130 &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
131 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
132 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
133 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
134 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
135 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
136 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
137 },
138 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 }
140
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]149 { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
150 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
151 &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]152 &quot;linkStatus&quot;: &quot;A String&quot;,
153 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]154 &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
155 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
156 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
157 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
158 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
159 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
160 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
161 },
162 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="list">list(part, linkingToken=None, type=None, x__xgafv=None)</code>
168 <pre>Retrieves a list of resources, possibly filtered.
169
170Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]171 part: string, The *part* parameter specifies the thirdPartyLink resource parts that the API response will include. Supported values are linkingToken, status, and snippet. (required) (repeated)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]172 linkingToken: string, Get a third party link with the given linking token.
173 type: string, Get a third party link of the given type.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]174 Allowed values
175 linkUnspecified -
176 channelToStoreLink - A link that is connecting (or about to connect) a channel with a store on a merchandising platform in order to enable retail commerce capabilities for that channel on YouTube.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182Returns:
183 An object of the form:
184
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]185 { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
186 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
187 &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]188 &quot;linkStatus&quot;: &quot;A String&quot;,
189 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]190 &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
191 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
192 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
193 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
194 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
195 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
196 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
197 },
198 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]199 }</pre>
200</div>
201
202<div class="method">
203 <code class="details" id="update">update(part, body=None, x__xgafv=None)</code>
204 <pre>Updates an existing resource.
205
206Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]207 part: string, The *part* parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet. (required) (repeated)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]208 body: object, The request body.
209 The object takes the form of:
210
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]211{ # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
212 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
213 &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]214 &quot;linkStatus&quot;: &quot;A String&quot;,
215 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]216 &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
217 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
218 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
219 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
220 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
221 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
222 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
223 },
224 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]225 }
226
227 x__xgafv: string, V1 error format.
228 Allowed values
229 1 - v1 error format
230 2 - v2 error format
231
232Returns:
233 An object of the form:
234
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]235 { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
236 &quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thirdPartyLink&quot;.
237 &quot;status&quot;: { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]238 &quot;linkStatus&quot;: &quot;A String&quot;,
239 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]240 &quot;linkingToken&quot;: &quot;A String&quot;, # The linking_token identifies a YouTube account and channel with which the third party account is linked.
241 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
242 &quot;snippet&quot;: { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
243 &quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
244 &quot;channelToStoreLink&quot;: { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
245 &quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
246 &quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
247 },
248 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]249 }</pre>
250</div>
251
252</body></html>