| <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="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(linkingToken, type, externalChannelId=None, 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, externalChannelId=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, externalChannelId=None, 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, externalChannelId=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="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(linkingToken, type, externalChannelId=None, 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) | |
| Allowed values | |
| linkUnspecified - | |
| 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. | |
| externalChannelId: string, Channel ID to which changes should be applied, for delegation. | |
| 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, externalChannelId=None, x__xgafv=None)</code> | |
| <pre>Inserts a new resource into this collection. | |
| Args: | |
| 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) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service. | |
| "etag": "A String", # Etag of this resource | |
| "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink". | |
| "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked. | |
| "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. | |
| "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. | |
| "merchantId": "A String", # Google Merchant Center id of the store. | |
| "storeName": "A String", # Name of the store. | |
| "storeUrl": "A String", # Landing page of the store. | |
| }, | |
| "type": "A String", # Type of the link named after the entities that are being linked. | |
| }, | |
| "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. | |
| "linkStatus": "A String", | |
| }, | |
| } | |
| externalChannelId: string, Channel ID to which changes should be applied, for delegation. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service. | |
| "etag": "A String", # Etag of this resource | |
| "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink". | |
| "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked. | |
| "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. | |
| "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. | |
| "merchantId": "A String", # Google Merchant Center id of the store. | |
| "storeName": "A String", # Name of the store. | |
| "storeUrl": "A String", # Landing page of the store. | |
| }, | |
| "type": "A String", # Type of the link named after the entities that are being linked. | |
| }, | |
| "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. | |
| "linkStatus": "A String", | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(part, externalChannelId=None, linkingToken=None, type=None, x__xgafv=None)</code> | |
| <pre>Retrieves a list of resources, possibly filtered. | |
| Args: | |
| 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) | |
| externalChannelId: string, Channel ID to which changes should be applied, for delegation. | |
| linkingToken: string, Get a third party link with the given linking token. | |
| type: string, Get a third party link of the given type. | |
| Allowed values | |
| linkUnspecified - | |
| 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. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "etag": "A String", # Etag of this resource. | |
| "items": [ | |
| { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service. | |
| "etag": "A String", # Etag of this resource | |
| "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink". | |
| "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked. | |
| "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. | |
| "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. | |
| "merchantId": "A String", # Google Merchant Center id of the store. | |
| "storeName": "A String", # Name of the store. | |
| "storeUrl": "A String", # Landing page of the store. | |
| }, | |
| "type": "A String", # Type of the link named after the entities that are being linked. | |
| }, | |
| "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. | |
| "linkStatus": "A String", | |
| }, | |
| }, | |
| ], | |
| "kind": "youtube#thirdPartyLinkListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLinkListResponse". | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="update">update(part, body=None, externalChannelId=None, x__xgafv=None)</code> | |
| <pre>Updates an existing resource. | |
| Args: | |
| 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) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service. | |
| "etag": "A String", # Etag of this resource | |
| "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink". | |
| "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked. | |
| "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. | |
| "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. | |
| "merchantId": "A String", # Google Merchant Center id of the store. | |
| "storeName": "A String", # Name of the store. | |
| "storeUrl": "A String", # Landing page of the store. | |
| }, | |
| "type": "A String", # Type of the link named after the entities that are being linked. | |
| }, | |
| "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. | |
| "linkStatus": "A String", | |
| }, | |
| } | |
| externalChannelId: string, Channel ID to which changes should be applied, for delegation. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service. | |
| "etag": "A String", # Etag of this resource | |
| "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink". | |
| "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked. | |
| "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. | |
| "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. | |
| "merchantId": "A String", # Google Merchant Center id of the store. | |
| "storeName": "A String", # Name of the store. | |
| "storeUrl": "A String", # Landing page of the store. | |
| }, | |
| "type": "A String", # Type of the link named after the entities that are being linked. | |
| }, | |
| "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. | |
| "linkStatus": "A String", | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |