Blame - docs/dyn/youtube_v3.thirdPartyLinks.html - platform/external/python/google-api-python-client

blob: fe65f4d37082d66814f900268fd5b1cba7353f68 [file] [log] [blame]

Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	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.thirdPartyLinks.html">thirdPartyLinks</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-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">
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	81	<code><a href="#delete">delete(linkingToken, type, externalChannelId=None, part=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	82	<p class="firstline">Deletes a resource.</p>
				83	<p class="toc_element">
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	84	<code><a href="#insert">insert(part, body=None, externalChannelId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	85	<p class="firstline">Inserts a new resource into this collection.</p>
				86	<p class="toc_element">
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	87	<code><a href="#list">list(part, externalChannelId=None, linkingToken=None, type=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	88	<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
				89	<p class="toc_element">
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	90	<code><a href="#update">update(part, body=None, externalChannelId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	91	<p class="firstline">Updates an existing resource.</p>
				92	<h3>Method Details</h3>
				93	<div class="method">
Dmitry Frenkel	3e17f89	2020-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">
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	99	<code class="details" id="delete">delete(linkingToken, type, externalChannelId=None, part=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	100	<pre>Deletes a resource.
				101
				102	Args:
				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 Frenkel	3e17f89	2020-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.
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	108	externalChannelId: string, Channel ID to which changes should be applied, for delegation.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	109	part: string, Do not use. Required for compatibility. (repeated)
				110	x__xgafv: string, V1 error format.
				111	Allowed values
				112	1 - v1 error format
				113	2 - v2 error format
				114	</pre>
				115	</div>
				116
				117	<div class="method">
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	118	<code class="details" id="insert">insert(part, body=None, externalChannelId=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	119	<pre>Inserts a new resource into this collection.
				120
				121	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	122	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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	123	body: object, The request body.
				124	The object takes the form of:
				125
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	126	{ # A third party account link resource represents a link between a YouTube account or a channel and an account on a third-party service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	127	"etag": "A String", # Etag of this resource
				128	"kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
				129	"linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	130	"snippet": { # 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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	131	"channelToStoreLink": { # 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.
				132	"storeName": "A String", # Name of the store.
				133	"storeUrl": "A String", # Landing page of the store.
				134	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	135	"type": "A String", # Type of the link named after the entities that are being linked.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	136	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	137	"status": { # 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.
				138	"linkStatus": "A String",
				139	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	140	}
				141
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	142	externalChannelId: string, Channel ID to which changes should be applied, for delegation.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	143	x__xgafv: string, V1 error format.
				144	Allowed values
				145	1 - v1 error format
				146	2 - v2 error format
				147
				148	Returns:
				149	An object of the form:
				150
				151	{ # A third party account link resource represents a link between a YouTube account or a channel and an account on a third-party service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	152	"etag": "A String", # Etag of this resource
				153	"kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
				154	"linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
				155	"snippet": { # 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.
				156	"channelToStoreLink": { # 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.
				157	"storeName": "A String", # Name of the store.
				158	"storeUrl": "A String", # Landing page of the store.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	159	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	160	"type": "A String", # Type of the link named after the entities that are being linked.
				161	},
				162	"status": { # 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.
				163	"linkStatus": "A String",
				164	},
				165	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	166	</div>
				167
				168	<div class="method">
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	169	<code class="details" id="list">list(part, externalChannelId=None, linkingToken=None, type=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	170	<pre>Retrieves a list of resources, possibly filtered.
				171
				172	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	173	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)
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	174	externalChannelId: string, Channel ID to which changes should be applied, for delegation.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	175	linkingToken: string, Get a third party link with the given linking token.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	176	type: string, Get a third party link of the given type.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	177	Allowed values
				178	linkUnspecified -
				179	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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	180	x__xgafv: string, V1 error format.
				181	Allowed values
				182	1 - v1 error format
				183	2 - v2 error format
				184
				185	Returns:
				186	An object of the form:
				187
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	188	{ # A third party account link resource represents a link between a YouTube account or a channel and an account on a third-party service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	189	"etag": "A String", # Etag of this resource
				190	"kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
				191	"linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
				192	"snippet": { # 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	"channelToStoreLink": { # 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.
				194	"storeName": "A String", # Name of the store.
				195	"storeUrl": "A String", # Landing page of the store.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	196	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	197	"type": "A String", # Type of the link named after the entities that are being linked.
				198	},
				199	"status": { # 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.
				200	"linkStatus": "A String",
				201	},
				202	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	203	</div>
				204
				205	<div class="method">
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	206	<code class="details" id="update">update(part, body=None, externalChannelId=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	207	<pre>Updates an existing resource.
				208
				209	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	210	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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	211	body: object, The request body.
				212	The object takes the form of:
				213
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	214	{ # A third party account link resource represents a link between a YouTube account or a channel and an account on a third-party service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	215	"etag": "A String", # Etag of this resource
				216	"kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
				217	"linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	218	"snippet": { # 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.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	219	"channelToStoreLink": { # 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.
				220	"storeName": "A String", # Name of the store.
				221	"storeUrl": "A String", # Landing page of the store.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	222	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	223	"type": "A String", # Type of the link named after the entities that are being linked.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	224	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	225	"status": { # 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.
				226	"linkStatus": "A String",
				227	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	228	}
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	229
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	230	externalChannelId: string, Channel ID to which changes should be applied, for delegation.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	231	x__xgafv: string, V1 error format.
				232	Allowed values
				233	1 - v1 error format
				234	2 - v2 error format
				235
				236	Returns:
				237	An object of the form:
				238
				239	{ # A third party account link resource represents a link between a YouTube account or a channel and an account on a third-party service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	240	"etag": "A String", # Etag of this resource
				241	"kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
				242	"linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
				243	"snippet": { # 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.
				244	"channelToStoreLink": { # 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	"storeName": "A String", # Name of the store.
				246	"storeUrl": "A String", # Landing page of the store.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	247	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	248	"type": "A String", # Type of the link named after the entities that are being linked.
				249	},
				250	"status": { # 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.
				251	"linkStatus": "A String",
				252	},
				253	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	254	</div>
				255
				256	</body></html>