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 | |
| 75 | <h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.activities.html">activities</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#insert">insert(part, body=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 79 | <p class="firstline">Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.)</p> |
| 80 | <p class="toc_element"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(part, channelId=None, home=None, maxResults=None, mine=None, pageToken=None, publishedAfter=None, publishedBefore=None, regionCode=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 88 | <code class="details" id="insert">insert(part, body=None)</code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 89 | <pre>Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.) |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 90 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 91 | Note: Even though an activity resource can contain information about actions like a user rating a video or marking a video as a favorite, you need to use other API methods to generate those activity resources. For example, you would use the API's videos.rate() method to rate a video and the playlistItems.insert() method to mark a video as a favorite. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 92 | |
| 93 | Args: |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 94 | 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) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 95 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 96 | The object takes the form of: |
| 97 | |
| 98 | { # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 99 | "contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video. |
| 100 | "bulletin": { # Details about a channel bulletin post. # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin. |
| 101 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post. |
| 102 | "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. |
| 103 | "kind": "A String", # The type of the API resource. |
| 104 | "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. |
| 105 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 106 | }, |
| 107 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 108 | "channelItem": { # Details about a resource which was added to a channel. # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem. |
| 109 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel. |
| 110 | "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. |
| 111 | "kind": "A String", # The type of the API resource. |
| 112 | "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. |
| 113 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 114 | }, |
| 115 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | "comment": { # Information about a resource that received a comment. # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment. |
| 117 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment. |
| 118 | "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. |
| 119 | "kind": "A String", # The type of the API resource. |
| 120 | "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. |
| 121 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 122 | }, |
| 123 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | "favorite": { # Information about a video that was marked as a favorite video. # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite. |
| 125 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite. |
| 126 | "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. |
| 127 | "kind": "A String", # The type of the API resource. |
| 128 | "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. |
| 129 | "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. |
| 130 | }, |
| 131 | }, |
| 132 | "like": { # Information about a resource that received a positive (like) rating. # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like. |
| 133 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource. |
| 134 | "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. |
| 135 | "kind": "A String", # The type of the API resource. |
| 136 | "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. |
| 137 | "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. |
| 138 | }, |
| 139 | }, |
| 140 | "playlistItem": { # Information about a new playlist item. # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem. |
| 141 | "playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist. |
| 142 | "playlistItemId": "A String", # ID of the item within the playlist. |
| 143 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist. |
| 144 | "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. |
| 145 | "kind": "A String", # The type of the API resource. |
| 146 | "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. |
| 147 | "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. |
| 148 | }, |
| 149 | }, |
| 150 | "promotedItem": { # Details about a resource which is being promoted. # The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem. |
| 151 | "adTag": "A String", # The URL the client should fetch to request a promoted item. |
| 152 | "clickTrackingUrl": "A String", # The URL the client should ping to indicate that the user clicked through on this promoted item. |
| 153 | "creativeViewUrl": "A String", # The URL the client should ping to indicate that the user was shown this promoted item. |
| 154 | "ctaType": "A String", # The type of call-to-action, a message to the user indicating action that can be taken. |
| 155 | "customCtaButtonText": "A String", # The custom call-to-action button text. If specified, it will override the default button text for the cta_type. |
| 156 | "descriptionText": "A String", # The text description to accompany the promoted item. |
| 157 | "destinationUrl": "A String", # The URL the client should direct the user to, if the user chooses to visit the advertiser's website. |
| 158 | "forecastingUrl": [ # The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown. |
| 159 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 160 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 161 | "impressionUrl": [ # The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item. |
| 162 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 163 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 164 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the promoted video. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 165 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 166 | "recommendation": { # Information that identifies the recommended resource. # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation. |
| 167 | "reason": "A String", # The reason that the resource is recommended to the user. |
| 168 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource. |
| 169 | "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. |
| 170 | "kind": "A String", # The type of the API resource. |
| 171 | "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. |
| 172 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 173 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 174 | "seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation. |
| 175 | "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. |
| 176 | "kind": "A String", # The type of the API resource. |
| 177 | "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. |
| 178 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 179 | }, |
| 180 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 181 | "social": { # Details about a social network post. # The social object contains details about a social network post. This property is only present if the snippet.type is social. |
| 182 | "author": "A String", # The author of the social network post. |
| 183 | "imageUrl": "A String", # An image of the post's author. |
| 184 | "referenceUrl": "A String", # The URL of the social network post. |
| 185 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post. |
| 186 | "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. |
| 187 | "kind": "A String", # The type of the API resource. |
| 188 | "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. |
| 189 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 190 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 191 | "type": "A String", # The name of the social network. |
| 192 | }, |
| 193 | "subscription": { # Information about a channel that a user subscribed to. # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription. |
| 194 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to. |
| 195 | "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. |
| 196 | "kind": "A String", # The type of the API resource. |
| 197 | "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. |
| 198 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 199 | }, |
| 200 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 201 | "upload": { # Information about the uploaded video. # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload. |
| 202 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 203 | }, |
| 204 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 205 | "etag": "A String", # Etag of this resource. |
| 206 | "id": "A String", # The ID that YouTube uses to uniquely identify the activity. |
| 207 | "kind": "youtube#activity", # Identifies what kind of resource this is. Value: the fixed string "youtube#activity". |
| 208 | "snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID. |
| 209 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity. |
| 210 | "channelTitle": "A String", # Channel title for the channel responsible for this activity |
| 211 | "description": "A String", # The description of the resource primarily associated with the activity. |
| 212 | "groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value. |
| 213 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 214 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the resource that is primarily associated with the activity. 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. |
| 215 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 216 | "height": 42, # (Optional) Height of the thumbnail image. |
| 217 | "url": "A String", # The thumbnail image's URL. |
| 218 | "width": 42, # (Optional) Width of the thumbnail image. |
| 219 | }, |
| 220 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 221 | "height": 42, # (Optional) Height of the thumbnail image. |
| 222 | "url": "A String", # The thumbnail image's URL. |
| 223 | "width": 42, # (Optional) Width of the thumbnail image. |
| 224 | }, |
| 225 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 226 | "height": 42, # (Optional) Height of the thumbnail image. |
| 227 | "url": "A String", # The thumbnail image's URL. |
| 228 | "width": 42, # (Optional) Width of the thumbnail image. |
| 229 | }, |
| 230 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 231 | "height": 42, # (Optional) Height of the thumbnail image. |
| 232 | "url": "A String", # The thumbnail image's URL. |
| 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. |
| 236 | "height": 42, # (Optional) Height of the thumbnail image. |
| 237 | "url": "A String", # The thumbnail image's URL. |
| 238 | "width": 42, # (Optional) Width of the thumbnail image. |
| 239 | }, |
| 240 | }, |
| 241 | "title": "A String", # The title of the resource primarily associated with the activity. |
| 242 | "type": "A String", # The type of activity that the resource describes. |
| 243 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 244 | } |
| 245 | |
| 246 | |
| 247 | Returns: |
| 248 | An object of the form: |
| 249 | |
| 250 | { # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 251 | "contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video. |
| 252 | "bulletin": { # Details about a channel bulletin post. # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin. |
| 253 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post. |
| 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. |
| 255 | "kind": "A String", # The type of the API resource. |
| 256 | "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. |
| 257 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 258 | }, |
| 259 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 260 | "channelItem": { # Details about a resource which was added to a channel. # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem. |
| 261 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel. |
| 262 | "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. |
| 263 | "kind": "A String", # The type of the API resource. |
| 264 | "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. |
| 265 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 266 | }, |
| 267 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 268 | "comment": { # Information about a resource that received a comment. # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment. |
| 269 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment. |
| 270 | "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. |
| 271 | "kind": "A String", # The type of the API resource. |
| 272 | "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. |
| 273 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 274 | }, |
| 275 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 276 | "favorite": { # Information about a video that was marked as a favorite video. # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite. |
| 277 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite. |
| 278 | "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. |
| 279 | "kind": "A String", # The type of the API resource. |
| 280 | "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. |
| 281 | "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. |
| 282 | }, |
| 283 | }, |
| 284 | "like": { # Information about a resource that received a positive (like) rating. # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like. |
| 285 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource. |
| 286 | "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. |
| 287 | "kind": "A String", # The type of the API resource. |
| 288 | "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. |
| 289 | "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. |
| 290 | }, |
| 291 | }, |
| 292 | "playlistItem": { # Information about a new playlist item. # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem. |
| 293 | "playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist. |
| 294 | "playlistItemId": "A String", # ID of the item within the playlist. |
| 295 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist. |
| 296 | "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. |
| 297 | "kind": "A String", # The type of the API resource. |
| 298 | "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. |
| 299 | "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. |
| 300 | }, |
| 301 | }, |
| 302 | "promotedItem": { # Details about a resource which is being promoted. # The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem. |
| 303 | "adTag": "A String", # The URL the client should fetch to request a promoted item. |
| 304 | "clickTrackingUrl": "A String", # The URL the client should ping to indicate that the user clicked through on this promoted item. |
| 305 | "creativeViewUrl": "A String", # The URL the client should ping to indicate that the user was shown this promoted item. |
| 306 | "ctaType": "A String", # The type of call-to-action, a message to the user indicating action that can be taken. |
| 307 | "customCtaButtonText": "A String", # The custom call-to-action button text. If specified, it will override the default button text for the cta_type. |
| 308 | "descriptionText": "A String", # The text description to accompany the promoted item. |
| 309 | "destinationUrl": "A String", # The URL the client should direct the user to, if the user chooses to visit the advertiser's website. |
| 310 | "forecastingUrl": [ # The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown. |
| 311 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 312 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 313 | "impressionUrl": [ # The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item. |
| 314 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 315 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 316 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the promoted video. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 317 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 318 | "recommendation": { # Information that identifies the recommended resource. # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation. |
| 319 | "reason": "A String", # The reason that the resource is recommended to the user. |
| 320 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource. |
| 321 | "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. |
| 322 | "kind": "A String", # The type of the API resource. |
| 323 | "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. |
| 324 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 325 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 326 | "seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation. |
| 327 | "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. |
| 328 | "kind": "A String", # The type of the API resource. |
| 329 | "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. |
| 330 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 331 | }, |
| 332 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 333 | "social": { # Details about a social network post. # The social object contains details about a social network post. This property is only present if the snippet.type is social. |
| 334 | "author": "A String", # The author of the social network post. |
| 335 | "imageUrl": "A String", # An image of the post's author. |
| 336 | "referenceUrl": "A String", # The URL of the social network post. |
| 337 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post. |
| 338 | "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. |
| 339 | "kind": "A String", # The type of the API resource. |
| 340 | "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. |
| 341 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 342 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 343 | "type": "A String", # The name of the social network. |
| 344 | }, |
| 345 | "subscription": { # Information about a channel that a user subscribed to. # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription. |
| 346 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to. |
| 347 | "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. |
| 348 | "kind": "A String", # The type of the API resource. |
| 349 | "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. |
| 350 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 351 | }, |
| 352 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 353 | "upload": { # Information about the uploaded video. # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload. |
| 354 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 355 | }, |
| 356 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 357 | "etag": "A String", # Etag of this resource. |
| 358 | "id": "A String", # The ID that YouTube uses to uniquely identify the activity. |
| 359 | "kind": "youtube#activity", # Identifies what kind of resource this is. Value: the fixed string "youtube#activity". |
| 360 | "snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID. |
| 361 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity. |
| 362 | "channelTitle": "A String", # Channel title for the channel responsible for this activity |
| 363 | "description": "A String", # The description of the resource primarily associated with the activity. |
| 364 | "groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value. |
| 365 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 366 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the resource that is primarily associated with the activity. 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. |
| 367 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 368 | "height": 42, # (Optional) Height of the thumbnail image. |
| 369 | "url": "A String", # The thumbnail image's URL. |
| 370 | "width": 42, # (Optional) Width of the thumbnail image. |
| 371 | }, |
| 372 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 373 | "height": 42, # (Optional) Height of the thumbnail image. |
| 374 | "url": "A String", # The thumbnail image's URL. |
| 375 | "width": 42, # (Optional) Width of the thumbnail image. |
| 376 | }, |
| 377 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 378 | "height": 42, # (Optional) Height of the thumbnail image. |
| 379 | "url": "A String", # The thumbnail image's URL. |
| 380 | "width": 42, # (Optional) Width of the thumbnail image. |
| 381 | }, |
| 382 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 383 | "height": 42, # (Optional) Height of the thumbnail image. |
| 384 | "url": "A String", # The thumbnail image's URL. |
| 385 | "width": 42, # (Optional) Width of the thumbnail image. |
| 386 | }, |
| 387 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 388 | "height": 42, # (Optional) Height of the thumbnail image. |
| 389 | "url": "A String", # The thumbnail image's URL. |
| 390 | "width": 42, # (Optional) Width of the thumbnail image. |
| 391 | }, |
| 392 | }, |
| 393 | "title": "A String", # The title of the resource primarily associated with the activity. |
| 394 | "type": "A String", # The type of activity that the resource describes. |
| 395 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 396 | }</pre> |
| 397 | </div> |
| 398 | |
| 399 | <div class="method"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 400 | <code class="details" id="list">list(part, channelId=None, home=None, maxResults=None, mine=None, pageToken=None, publishedAfter=None, publishedBefore=None, regionCode=None)</code> |
| 401 | <pre>Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 402 | |
| 403 | Args: |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 404 | part: string, The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 405 | |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 406 | If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. (required) |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 407 | channelId: string, The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities. |
| 408 | home: boolean, Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 409 | maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 410 | mine: boolean, Set this parameter's value to true to retrieve a feed of the authenticated user's activities. |
| 411 | 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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 412 | publishedAfter: string, The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 413 | publishedBefore: string, The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 414 | regionCode: string, The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 415 | |
| 416 | Returns: |
| 417 | An object of the form: |
| 418 | |
| 419 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 420 | "etag": "A String", # Etag of this resource. |
| 421 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| 422 | "items": [ # A list of activities, or events, that match the request criteria. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 423 | { # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 424 | "contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video. |
| 425 | "bulletin": { # Details about a channel bulletin post. # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin. |
| 426 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post. |
| 427 | "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. |
| 428 | "kind": "A String", # The type of the API resource. |
| 429 | "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. |
| 430 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 431 | }, |
| 432 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 433 | "channelItem": { # Details about a resource which was added to a channel. # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem. |
| 434 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel. |
| 435 | "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. |
| 436 | "kind": "A String", # The type of the API resource. |
| 437 | "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. |
| 438 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 439 | }, |
| 440 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 441 | "comment": { # Information about a resource that received a comment. # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment. |
| 442 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment. |
| 443 | "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. |
| 444 | "kind": "A String", # The type of the API resource. |
| 445 | "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. |
| 446 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 447 | }, |
| 448 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 449 | "favorite": { # Information about a video that was marked as a favorite video. # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite. |
| 450 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite. |
| 451 | "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. |
| 452 | "kind": "A String", # The type of the API resource. |
| 453 | "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. |
| 454 | "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. |
| 455 | }, |
| 456 | }, |
| 457 | "like": { # Information about a resource that received a positive (like) rating. # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like. |
| 458 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource. |
| 459 | "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. |
| 460 | "kind": "A String", # The type of the API resource. |
| 461 | "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. |
| 462 | "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. |
| 463 | }, |
| 464 | }, |
| 465 | "playlistItem": { # Information about a new playlist item. # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem. |
| 466 | "playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist. |
| 467 | "playlistItemId": "A String", # ID of the item within the playlist. |
| 468 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist. |
| 469 | "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. |
| 470 | "kind": "A String", # The type of the API resource. |
| 471 | "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. |
| 472 | "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. |
| 473 | }, |
| 474 | }, |
| 475 | "promotedItem": { # Details about a resource which is being promoted. # The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem. |
| 476 | "adTag": "A String", # The URL the client should fetch to request a promoted item. |
| 477 | "clickTrackingUrl": "A String", # The URL the client should ping to indicate that the user clicked through on this promoted item. |
| 478 | "creativeViewUrl": "A String", # The URL the client should ping to indicate that the user was shown this promoted item. |
| 479 | "ctaType": "A String", # The type of call-to-action, a message to the user indicating action that can be taken. |
| 480 | "customCtaButtonText": "A String", # The custom call-to-action button text. If specified, it will override the default button text for the cta_type. |
| 481 | "descriptionText": "A String", # The text description to accompany the promoted item. |
| 482 | "destinationUrl": "A String", # The URL the client should direct the user to, if the user chooses to visit the advertiser's website. |
| 483 | "forecastingUrl": [ # The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown. |
| 484 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 485 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 486 | "impressionUrl": [ # The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item. |
| 487 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 488 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 489 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the promoted video. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 490 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 491 | "recommendation": { # Information that identifies the recommended resource. # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation. |
| 492 | "reason": "A String", # The reason that the resource is recommended to the user. |
| 493 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource. |
| 494 | "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. |
| 495 | "kind": "A String", # The type of the API resource. |
| 496 | "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. |
| 497 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 498 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 499 | "seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation. |
| 500 | "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. |
| 501 | "kind": "A String", # The type of the API resource. |
| 502 | "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. |
| 503 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 504 | }, |
| 505 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 506 | "social": { # Details about a social network post. # The social object contains details about a social network post. This property is only present if the snippet.type is social. |
| 507 | "author": "A String", # The author of the social network post. |
| 508 | "imageUrl": "A String", # An image of the post's author. |
| 509 | "referenceUrl": "A String", # The URL of the social network post. |
| 510 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post. |
| 511 | "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. |
| 512 | "kind": "A String", # The type of the API resource. |
| 513 | "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. |
| 514 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 515 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 516 | "type": "A String", # The name of the social network. |
| 517 | }, |
| 518 | "subscription": { # Information about a channel that a user subscribed to. # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription. |
| 519 | "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to. |
| 520 | "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. |
| 521 | "kind": "A String", # The type of the API resource. |
| 522 | "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. |
| 523 | "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. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 524 | }, |
| 525 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 526 | "upload": { # Information about the uploaded video. # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload. |
| 527 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 528 | }, |
| 529 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 530 | "etag": "A String", # Etag of this resource. |
| 531 | "id": "A String", # The ID that YouTube uses to uniquely identify the activity. |
| 532 | "kind": "youtube#activity", # Identifies what kind of resource this is. Value: the fixed string "youtube#activity". |
| 533 | "snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID. |
| 534 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity. |
| 535 | "channelTitle": "A String", # Channel title for the channel responsible for this activity |
| 536 | "description": "A String", # The description of the resource primarily associated with the activity. |
| 537 | "groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value. |
| 538 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 539 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the resource that is primarily associated with the activity. 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. |
| 540 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 541 | "height": 42, # (Optional) Height of the thumbnail image. |
| 542 | "url": "A String", # The thumbnail image's URL. |
| 543 | "width": 42, # (Optional) Width of the thumbnail image. |
| 544 | }, |
| 545 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 546 | "height": 42, # (Optional) Height of the thumbnail image. |
| 547 | "url": "A String", # The thumbnail image's URL. |
| 548 | "width": 42, # (Optional) Width of the thumbnail image. |
| 549 | }, |
| 550 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 551 | "height": 42, # (Optional) Height of the thumbnail image. |
| 552 | "url": "A String", # The thumbnail image's URL. |
| 553 | "width": 42, # (Optional) Width of the thumbnail image. |
| 554 | }, |
| 555 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 556 | "height": 42, # (Optional) Height of the thumbnail image. |
| 557 | "url": "A String", # The thumbnail image's URL. |
| 558 | "width": 42, # (Optional) Width of the thumbnail image. |
| 559 | }, |
| 560 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 561 | "height": 42, # (Optional) Height of the thumbnail image. |
| 562 | "url": "A String", # The thumbnail image's URL. |
| 563 | "width": 42, # (Optional) Width of the thumbnail image. |
| 564 | }, |
| 565 | }, |
| 566 | "title": "A String", # The title of the resource primarily associated with the activity. |
| 567 | "type": "A String", # The type of activity that the resource describes. |
| 568 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 569 | }, |
| 570 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 571 | "kind": "youtube#activityListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#activityListResponse". |
| 572 | "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. |
| 573 | "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. |
| 574 | "resultsPerPage": 42, # The number of results included in the API response. |
| 575 | "totalResults": 42, # The total number of results in the result set. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 576 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 577 | "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. |
| 578 | "tokenPagination": { # Stub token pagination template to suppress results. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 579 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 580 | "visitorId": "A String", # The visitorId identifies the visitor. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 581 | }</pre> |
| 582 | </div> |
| 583 | |
| 584 | <div class="method"> |
| 585 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 586 | <pre>Retrieves the next page of results. |
| 587 | |
| 588 | Args: |
| 589 | previous_request: The request for the previous page. (required) |
| 590 | previous_response: The response from the request for the previous page. (required) |
| 591 | |
| 592 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 593 | 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] | 594 | page. Returns None if there are no more items in the collection. |
| 595 | </pre> |
| 596 | </div> |
| 597 | |
| 598 | </body></html> |