| 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.youtube.html">youtube</a> . <a href="youtube_v3.youtube.v3.html">v3</a> . <a href="youtube_v3.youtube.v3.infocards.html">infocards</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#list">list(part, onBehalfOfContentOwner=None, videoId=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Retrieves all infocards for a given video.</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| 82 | <code class="details" id="list">list(part, onBehalfOfContentOwner=None, videoId=None, x__xgafv=None)</code> |
| 83 | <pre>Retrieves all infocards for a given video. |
| 84 | |
| 85 | Args: |
| 86 | part: string, The properties to return. (required) (repeated) |
| 87 | onBehalfOfContentOwner: string, Content owner of the video. |
| 88 | videoId: string, Encrypted id of the video. |
| 89 | x__xgafv: string, V1 error format. |
| 90 | Allowed values |
| 91 | 1 - v1 error format |
| 92 | 2 - v2 error format |
| 93 | |
| 94 | Returns: |
| 95 | An object of the form: |
| 96 | |
| 97 | { |
| 98 | "items": [ # A list of infocards. |
| 99 | { |
| 100 | "snippet": { # The snippet object contains basic details about the infocard. |
| 101 | "linkInfocard": { |
| 102 | "customLinkText": "A String", # Custom text to show as the website link. |
| 103 | # Required. |
| 104 | "uploadedImage": { # Previously uploaded image. |
| 105 | "version": "A String", # The version in the thumbnail service. |
| 106 | "imageFile": "A String", # Image reference on the thumbnail service. |
| 107 | }, |
| 108 | "title": "A String", # The title to show on the card. |
| 109 | # Required. |
| 110 | "externalImageUrl": "A String", # URL to an externally hosted image. |
| 111 | "targetUrl": "A String", # The URL to which this card points. |
| 112 | # Required. |
| 113 | }, |
| 114 | "videoInfocard": { |
| 115 | "playbackStartOffset": "A String", # Playback start time offset in milliseconds. |
| 116 | # Optional. |
| 117 | "customMessage": "A String", # Each card can have a custom message. |
| 118 | # Optional. |
| 119 | "videoId": "A String", # Encrypted Video ID. |
| 120 | # Required. |
| 121 | }, |
| 122 | "teaser": { # Each card can have a teaser. |
| 123 | # Required. |
| 124 | "teaserStartOffset": "A String", # The offset from the video start at which the teaser should be displayed |
| 125 | # (activated), in milliseconds. |
| 126 | # Required. |
| 127 | "teaserText": "A String", # The teaser text to show at the top of the player for the info-card. |
| 128 | # Required for channel and link type cards. |
| 129 | # Optional for video and playlist type cards. |
| 130 | }, |
| 131 | "channelInfocard": { |
| 132 | "customMessage": "A String", # Each card can have a custom message. |
| 133 | # Required. |
| 134 | "channelId": "A String", # External channel ID. |
| 135 | # Required. |
| 136 | }, |
| 137 | "playlistInfocard": { |
| 138 | "playlistId": "A String", # External playlist ID. |
| 139 | # Required. |
| 140 | "startVideoId": "A String", # Starting video, if not the first. |
| 141 | # Optional. |
| 142 | "customMessage": "A String", # Each card can have a custom message. |
| 143 | # Optional. |
| 144 | }, |
| 145 | }, |
| 146 | "etag": "A String", # Etag of this resource. |
| 147 | "kind": "youtube#infocard", # Identifies what kind of resource this is. |
| 148 | "id": "A String", # UUID for this infocard. |
| 149 | }, |
| 150 | ], |
| 151 | "kind": "youtube#infocardListResponse", # Identifies what kind of resource this is. |
| 152 | "etag": "A String", # Etag of this resource. |
| 153 | }</pre> |
| 154 | </div> |
| 155 | |
| 156 | </body></html> |