| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [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 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 75 | <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.subscriptions.html">subscriptions</a></h1> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a resource.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 84 | <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Inserts a new resource into this collection.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 86 | <p class="toc_element"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 87 | <code><a href="#list">list(part, onBehalfOfContentOwner=None, order=None, pageToken=None, mine=None, id=None, myRecentSubscribers=None, maxResults=None, channelId=None, forChannelId=None, onBehalfOfContentOwnerChannel=None, mySubscribers=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> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</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"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 99 | <code class="details" id="delete">delete(id, x__xgafv=None)</code> |
| 100 | <pre>Deletes a resource. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 101 | |
| 102 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 103 | id: string, A parameter (required) |
| 104 | x__xgafv: string, V1 error format. |
| 105 | Allowed values |
| 106 | 1 - v1 error format |
| 107 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 108 | </pre> |
| 109 | </div> |
| 110 | |
| 111 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 112 | <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code> |
| 113 | <pre>Inserts a new resource into this collection. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 114 | |
| 115 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 116 | part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. (required) (repeated) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 117 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 118 | The object takes the form of: |
| 119 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 120 | { # A *subscription* resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 121 | "id": "A String", # The ID that YouTube uses to uniquely identify the subscription. |
| 122 | "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription. |
| 123 | "activityType": "A String", # The type of activity this subscription is for (only uploads, everything). |
| 124 | "totalItemCount": 42, # The approximate number of items that the subscription points to. |
| 125 | "newItemCount": 42, # The number of new items in the subscription since its content was last read. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 126 | }, |
| 127 | "snippet": { # Basic details about a subscription, including title, description and thumbnails of the subscribed item. # The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 128 | "channelTitle": "A String", # Channel title for the channel that the subscription belongs to. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 129 | "title": "A String", # The subscription's title. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 130 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 131 | "description": "A String", # The subscription's details. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 132 | "publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 133 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 134 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 135 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 136 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 137 | "width": 42, # (Optional) Width of the thumbnail image. |
| 138 | }, |
| 139 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 140 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 141 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 142 | "width": 42, # (Optional) Width of the thumbnail image. |
| 143 | }, |
| 144 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 145 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 146 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 147 | "width": 42, # (Optional) Width of the thumbnail image. |
| 148 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 149 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 150 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 151 | "url": "A String", # The thumbnail image's URL. |
| 152 | "width": 42, # (Optional) Width of the thumbnail image. |
| 153 | }, |
| 154 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 155 | "height": 42, # (Optional) Height of the thumbnail image. |
| 156 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 157 | "width": 42, # (Optional) Width of the thumbnail image. |
| 158 | }, |
| 159 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 160 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information about the channel that the user subscribed to. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 161 | "kind": "A String", # The type of the API resource. |
| 162 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video. |
| 163 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 164 | "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 165 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 166 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 167 | "etag": "A String", # Etag of this resource. |
| 168 | "kind": "youtube#subscription", # Identifies what kind of resource this is. Value: the fixed string "youtube#subscription". |
| 169 | "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the subscriber. |
| 170 | "description": "A String", # The description of the subscriber. |
| 171 | "title": "A String", # The title of the subscriber. |
| 172 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber. |
| 173 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 174 | "height": 42, # (Optional) Height of the thumbnail image. |
| 175 | "url": "A String", # The thumbnail image's URL. |
| 176 | "width": 42, # (Optional) Width of the thumbnail image. |
| 177 | }, |
| 178 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 179 | "height": 42, # (Optional) Height of the thumbnail image. |
| 180 | "url": "A String", # The thumbnail image's URL. |
| 181 | "width": 42, # (Optional) Width of the thumbnail image. |
| 182 | }, |
| 183 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 184 | "height": 42, # (Optional) Height of the thumbnail image. |
| 185 | "url": "A String", # The thumbnail image's URL. |
| 186 | "width": 42, # (Optional) Width of the thumbnail image. |
| 187 | }, |
| 188 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 189 | "height": 42, # (Optional) Height of the thumbnail image. |
| 190 | "url": "A String", # The thumbnail image's URL. |
| 191 | "width": 42, # (Optional) Width of the thumbnail image. |
| 192 | }, |
| 193 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 194 | "height": 42, # (Optional) Height of the thumbnail image. |
| 195 | "url": "A String", # The thumbnail image's URL. |
| 196 | "width": 42, # (Optional) Width of the thumbnail image. |
| 197 | }, |
| 198 | }, |
| 199 | "channelId": "A String", # The channel ID of the subscriber. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 200 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 201 | } |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 202 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 203 | x__xgafv: string, V1 error format. |
| 204 | Allowed values |
| 205 | 1 - v1 error format |
| 206 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 207 | |
| 208 | Returns: |
| 209 | An object of the form: |
| 210 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 211 | { # A *subscription* resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 212 | "id": "A String", # The ID that YouTube uses to uniquely identify the subscription. |
| 213 | "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription. |
| 214 | "activityType": "A String", # The type of activity this subscription is for (only uploads, everything). |
| 215 | "totalItemCount": 42, # The approximate number of items that the subscription points to. |
| 216 | "newItemCount": 42, # The number of new items in the subscription since its content was last read. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 217 | }, |
| 218 | "snippet": { # Basic details about a subscription, including title, description and thumbnails of the subscribed item. # The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 219 | "channelTitle": "A String", # Channel title for the channel that the subscription belongs to. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 220 | "title": "A String", # The subscription's title. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 221 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 222 | "description": "A String", # The subscription's details. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 223 | "publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 224 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 225 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 226 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 227 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 228 | "width": 42, # (Optional) Width of the thumbnail image. |
| 229 | }, |
| 230 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 231 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 232 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 233 | "width": 42, # (Optional) Width of the thumbnail image. |
| 234 | }, |
| 235 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 236 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 237 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 238 | "width": 42, # (Optional) Width of the thumbnail image. |
| 239 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 240 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 241 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 242 | "url": "A String", # The thumbnail image's URL. |
| 243 | "width": 42, # (Optional) Width of the thumbnail image. |
| 244 | }, |
| 245 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 246 | "height": 42, # (Optional) Height of the thumbnail image. |
| 247 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 248 | "width": 42, # (Optional) Width of the thumbnail image. |
| 249 | }, |
| 250 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 251 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information about the channel that the user subscribed to. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 252 | "kind": "A String", # The type of the API resource. |
| 253 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video. |
| 254 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 255 | "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 256 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 257 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 258 | "etag": "A String", # Etag of this resource. |
| 259 | "kind": "youtube#subscription", # Identifies what kind of resource this is. Value: the fixed string "youtube#subscription". |
| 260 | "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the subscriber. |
| 261 | "description": "A String", # The description of the subscriber. |
| 262 | "title": "A String", # The title of the subscriber. |
| 263 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber. |
| 264 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 265 | "height": 42, # (Optional) Height of the thumbnail image. |
| 266 | "url": "A String", # The thumbnail image's URL. |
| 267 | "width": 42, # (Optional) Width of the thumbnail image. |
| 268 | }, |
| 269 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 270 | "height": 42, # (Optional) Height of the thumbnail image. |
| 271 | "url": "A String", # The thumbnail image's URL. |
| 272 | "width": 42, # (Optional) Width of the thumbnail image. |
| 273 | }, |
| 274 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 275 | "height": 42, # (Optional) Height of the thumbnail image. |
| 276 | "url": "A String", # The thumbnail image's URL. |
| 277 | "width": 42, # (Optional) Width of the thumbnail image. |
| 278 | }, |
| 279 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 280 | "height": 42, # (Optional) Height of the thumbnail image. |
| 281 | "url": "A String", # The thumbnail image's URL. |
| 282 | "width": 42, # (Optional) Width of the thumbnail image. |
| 283 | }, |
| 284 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 285 | "height": 42, # (Optional) Height of the thumbnail image. |
| 286 | "url": "A String", # The thumbnail image's URL. |
| 287 | "width": 42, # (Optional) Width of the thumbnail image. |
| 288 | }, |
| 289 | }, |
| 290 | "channelId": "A String", # The channel ID of the subscriber. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 291 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 292 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 293 | </div> |
| 294 | |
| 295 | <div class="method"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 296 | <code class="details" id="list">list(part, onBehalfOfContentOwner=None, order=None, pageToken=None, mine=None, id=None, myRecentSubscribers=None, maxResults=None, channelId=None, forChannelId=None, onBehalfOfContentOwnerChannel=None, mySubscribers=None, x__xgafv=None)</code> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 297 | <pre>Retrieves a list of resources, possibly filtered. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 298 | |
| 299 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 300 | part: string, The *part* parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set *part=snippet*, the API response will also contain all of those nested properties. (required) (repeated) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 301 | onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 302 | order: string, The order of the returned subscriptions |
| 303 | Allowed values |
| 304 | subscriptionOrderUnspecified - |
| 305 | relevance - Sort by relevance. |
| 306 | unread - Sort by order of activity. |
| 307 | alphabetical - Sort alphabetically. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 308 | pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 309 | mine: boolean, Flag for returning the subscriptions of the authenticated user. |
| 310 | id: string, Return the subscriptions with the given IDs for Stubby or Apiary. (repeated) |
| 311 | myRecentSubscribers: boolean, A parameter |
| 312 | maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. |
| 313 | channelId: string, Return the subscriptions of the given channel owner. |
| 314 | forChannelId: string, Return the subscriptions to the subset of these channels that the authenticated user is subscribed to. |
| 315 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. |
| 316 | mySubscribers: boolean, Return the subscribers of the given channel owner. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 317 | x__xgafv: string, V1 error format. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 318 | Allowed values |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 319 | 1 - v1 error format |
| 320 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 321 | |
| 322 | Returns: |
| 323 | An object of the form: |
| 324 | |
| 325 | { |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 326 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 327 | "items": [ # A list of subscriptions that match the request criteria. |
| 328 | { # A *subscription* resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 329 | "id": "A String", # The ID that YouTube uses to uniquely identify the subscription. |
| 330 | "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription. |
| 331 | "activityType": "A String", # The type of activity this subscription is for (only uploads, everything). |
| 332 | "totalItemCount": 42, # The approximate number of items that the subscription points to. |
| 333 | "newItemCount": 42, # The number of new items in the subscription since its content was last read. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 334 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 335 | "snippet": { # Basic details about a subscription, including title, description and thumbnails of the subscribed item. # The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 336 | "channelTitle": "A String", # Channel title for the channel that the subscription belongs to. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 337 | "title": "A String", # The subscription's title. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 338 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 339 | "description": "A String", # The subscription's details. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 340 | "publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 format. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 341 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 342 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 343 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 344 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 345 | "width": 42, # (Optional) Width of the thumbnail image. |
| 346 | }, |
| 347 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 348 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 349 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 350 | "width": 42, # (Optional) Width of the thumbnail image. |
| 351 | }, |
| 352 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 353 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 354 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 355 | "width": 42, # (Optional) Width of the thumbnail image. |
| 356 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 357 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 358 | "height": 42, # (Optional) Height of the thumbnail image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 359 | "url": "A String", # The thumbnail image's URL. |
| 360 | "width": 42, # (Optional) Width of the thumbnail image. |
| 361 | }, |
| 362 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 363 | "height": 42, # (Optional) Height of the thumbnail image. |
| 364 | "url": "A String", # The thumbnail image's URL. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 365 | "width": 42, # (Optional) Width of the thumbnail image. |
| 366 | }, |
| 367 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 368 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information about the channel that the user subscribed to. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 369 | "kind": "A String", # The type of the API resource. |
| 370 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video. |
| 371 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 372 | "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 373 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 374 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 375 | "etag": "A String", # Etag of this resource. |
| 376 | "kind": "youtube#subscription", # Identifies what kind of resource this is. Value: the fixed string "youtube#subscription". |
| 377 | "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the subscriber. |
| 378 | "description": "A String", # The description of the subscriber. |
| 379 | "title": "A String", # The title of the subscriber. |
| 380 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber. |
| 381 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 382 | "height": 42, # (Optional) Height of the thumbnail image. |
| 383 | "url": "A String", # The thumbnail image's URL. |
| 384 | "width": 42, # (Optional) Width of the thumbnail image. |
| 385 | }, |
| 386 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 387 | "height": 42, # (Optional) Height of the thumbnail image. |
| 388 | "url": "A String", # The thumbnail image's URL. |
| 389 | "width": 42, # (Optional) Width of the thumbnail image. |
| 390 | }, |
| 391 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 392 | "height": 42, # (Optional) Height of the thumbnail image. |
| 393 | "url": "A String", # The thumbnail image's URL. |
| 394 | "width": 42, # (Optional) Width of the thumbnail image. |
| 395 | }, |
| 396 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 397 | "height": 42, # (Optional) Height of the thumbnail image. |
| 398 | "url": "A String", # The thumbnail image's URL. |
| 399 | "width": 42, # (Optional) Width of the thumbnail image. |
| 400 | }, |
| 401 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 402 | "height": 42, # (Optional) Height of the thumbnail image. |
| 403 | "url": "A String", # The thumbnail image's URL. |
| 404 | "width": 42, # (Optional) Width of the thumbnail image. |
| 405 | }, |
| 406 | }, |
| 407 | "channelId": "A String", # The channel ID of the subscriber. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 408 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 409 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 410 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 411 | "tokenPagination": { # Stub token pagination template to suppress results. |
| 412 | }, |
| 413 | "etag": "A String", # Etag of this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 414 | "visitorId": "A String", # The visitorId identifies the visitor. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 415 | "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. |
| 416 | "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. |
| 417 | "kind": "youtube#subscriptionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#subscriptionListResponse". |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 418 | "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 419 | "totalResults": 42, # The total number of results in the result set. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 420 | "resultsPerPage": 42, # The number of results included in the API response. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 421 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 422 | }</pre> |
| 423 | </div> |
| 424 | |
| 425 | <div class="method"> |
| 426 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 427 | <pre>Retrieves the next page of results. |
| 428 | |
| 429 | Args: |
| 430 | previous_request: The request for the previous page. (required) |
| 431 | previous_response: The response from the request for the previous page. (required) |
| 432 | |
| 433 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 434 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 435 | page. Returns None if there are no more items in the collection. |
| 436 | </pre> |
| 437 | </div> |
| 438 | |
| 439 | </body></html> |