| <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.youtube.html">youtube</a> . <a href="youtube_v3.youtube.v3.html">v3</a> . <a href="youtube_v3.youtube.v3.infocards.html">infocards</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#list">list(part, onBehalfOfContentOwner=None, videoId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves all infocards for a given video.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="list">list(part, onBehalfOfContentOwner=None, videoId=None, x__xgafv=None)</code> |
| <pre>Retrieves all infocards for a given video. |
| |
| Args: |
| part: string, The properties to return. (required) (repeated) |
| onBehalfOfContentOwner: string, Content owner of the video. |
| videoId: string, Encrypted id of the video. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "items": [ # A list of infocards. |
| { |
| "snippet": { # The snippet object contains basic details about the infocard. |
| "linkInfocard": { |
| "customLinkText": "A String", # Custom text to show as the website link. |
| # Required. |
| "uploadedImage": { # Previously uploaded image. |
| "version": "A String", # The version in the thumbnail service. |
| "imageFile": "A String", # Image reference on the thumbnail service. |
| }, |
| "title": "A String", # The title to show on the card. |
| # Required. |
| "externalImageUrl": "A String", # URL to an externally hosted image. |
| "targetUrl": "A String", # The URL to which this card points. |
| # Required. |
| }, |
| "videoInfocard": { |
| "playbackStartOffset": "A String", # Playback start time offset in milliseconds. |
| # Optional. |
| "customMessage": "A String", # Each card can have a custom message. |
| # Optional. |
| "videoId": "A String", # Encrypted Video ID. |
| # Required. |
| }, |
| "teaser": { # Each card can have a teaser. |
| # Required. |
| "teaserStartOffset": "A String", # The offset from the video start at which the teaser should be displayed |
| # (activated), in milliseconds. |
| # Required. |
| "teaserText": "A String", # The teaser text to show at the top of the player for the info-card. |
| # Required for channel and link type cards. |
| # Optional for video and playlist type cards. |
| }, |
| "channelInfocard": { |
| "customMessage": "A String", # Each card can have a custom message. |
| # Required. |
| "channelId": "A String", # External channel ID. |
| # Required. |
| }, |
| "playlistInfocard": { |
| "playlistId": "A String", # External playlist ID. |
| # Required. |
| "startVideoId": "A String", # Starting video, if not the first. |
| # Optional. |
| "customMessage": "A String", # Each card can have a custom message. |
| # Optional. |
| }, |
| }, |
| "etag": "A String", # Etag of this resource. |
| "kind": "youtube#infocard", # Identifies what kind of resource this is. |
| "id": "A String", # UUID for this infocard. |
| }, |
| ], |
| "kind": "youtube#infocardListResponse", # Identifies what kind of resource this is. |
| "etag": "A String", # Etag of this resource. |
| }</pre> |
| </div> |
| |
| </body></html> |
