blob: 2c309bdb5347aadb7ee3c7c1c5f0e5aa7284a0c8 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.thirdPartyLinks.html">thirdPartyLinks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(linkingToken, type, part=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new resource into this collection.</p>
<p class="toc_element">
<code><a href="#list">list(part, linkingToken=None, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
<p class="toc_element">
<code><a href="#update">update(part, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(linkingToken, type, part=None, x__xgafv=None)</code>
<pre>Deletes a resource.
Args:
linkingToken: string, Delete the partner links with the given linking token. (required)
type: string, Type of the link to be deleted. (required)
part: string, Do not use. Required for compatibility. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
<pre>Inserts a new resource into this collection.
Args:
part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies the
&lt;code&gt;thirdPartyLink&lt;/code&gt; resource parts that the API request and
response will include. Supported values are &lt;code&gt;linkingToken&lt;/code&gt;,
&lt;code&gt;status&lt;/code&gt;, and &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
# a link between a YouTube account or a channel and an account on a
# third-party service.
&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-
# party account link.
# type-specific information.
&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
# merchandising platform.
# YouTube channel.
&quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
&quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
},
&quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
},
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
&quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
# &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
&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
# of the link.
# the status of the link.
&quot;linkStatus&quot;: &quot;A String&quot;,
},
&quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
# channel with which the third party account is linked.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
# a link between a YouTube account or a channel and an account on a
# third-party service.
&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-
# party account link.
# type-specific information.
&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
# merchandising platform.
# YouTube channel.
&quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
&quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
},
&quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
},
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
&quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
# &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
&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
# of the link.
# the status of the link.
&quot;linkStatus&quot;: &quot;A String&quot;,
},
&quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
# channel with which the third party account is linked.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(part, linkingToken=None, type=None, x__xgafv=None)</code>
<pre>Retrieves a list of resources, possibly filtered.
Args:
part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies the
&lt;code&gt;thirdPartyLink&lt;/code&gt; resource parts that the API response will
include. Supported values are &lt;code&gt;linkingToken&lt;/code&gt;,
&lt;code&gt;status&lt;/code&gt;, and &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
linkingToken: string, Get a third party link with the given linking token.
type: string, Get a third party link of the given type.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
# a link between a YouTube account or a channel and an account on a
# third-party service.
&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-
# party account link.
# type-specific information.
&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
# merchandising platform.
# YouTube channel.
&quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
&quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
},
&quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
},
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
&quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
# &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
&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
# of the link.
# the status of the link.
&quot;linkStatus&quot;: &quot;A String&quot;,
},
&quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
# channel with which the third party account is linked.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(part, body=None, x__xgafv=None)</code>
<pre>Updates an existing resource.
Args:
part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies the
&lt;code&gt;thirdPartyLink&lt;/code&gt; resource parts that the API request and
response will include. Supported values are &lt;code&gt;linkingToken&lt;/code&gt;,
&lt;code&gt;status&lt;/code&gt;, and &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
# a link between a YouTube account or a channel and an account on a
# third-party service.
&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-
# party account link.
# type-specific information.
&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
# merchandising platform.
# YouTube channel.
&quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
&quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
},
&quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
},
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
&quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
# &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
&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
# of the link.
# the status of the link.
&quot;linkStatus&quot;: &quot;A String&quot;,
},
&quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
# channel with which the third party account is linked.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A &lt;code&gt;&lt;strong&gt;third party account link&lt;/strong&gt;&lt;/code&gt; resource represents
# a link between a YouTube account or a channel and an account on a
# third-party service.
&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-
# party account link.
# type-specific information.
&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
# merchandising platform.
# YouTube channel.
&quot;storeName&quot;: &quot;A String&quot;, # Name of the store.
&quot;storeUrl&quot;: &quot;A String&quot;, # Landing page of the store.
},
&quot;type&quot;: &quot;A String&quot;, # Type of the link named after the entities that are being linked.
},
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource
&quot;kind&quot;: &quot;youtube#thirdPartyLink&quot;, # Identifies what kind of resource this is. Value: the fixed string
# &lt;code&gt;&quot;youtube#thirdPartyLink&quot;&lt;/code&gt;.
&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
# of the link.
# the status of the link.
&quot;linkStatus&quot;: &quot;A String&quot;,
},
&quot;linkingToken&quot;: &quot;A String&quot;, # The &lt;code&gt;linking_token&lt;/code&gt; identifies a YouTube account and
# channel with which the third party account is linked.
}</pre>
</div>
</body></html>