Refresh docs
diff --git a/docs/dyn/youtube_v3.subscriptions.html b/docs/dyn/youtube_v3.subscriptions.html
index 74b2864..68f9232 100644
--- a/docs/dyn/youtube_v3.subscriptions.html
+++ b/docs/dyn/youtube_v3.subscriptions.html
@@ -81,7 +81,7 @@
<code><a href="#insert">insert(part=None, body)</a></code></p>
<p class="firstline">Adds a subscription for the authenticated user's channel.</p>
<p class="toc_element">
- <code><a href="#list">list(part=None, pageToken=None, channelId=None, mine=None, maxResults=None, forChannelId=None, order=None, id=None)</a></code></p>
+ <code><a href="#list">list(part=None, pageToken=None, id=None, channelId=None, mine=None, maxResults=None, forChannelId=None, mySubscribers=None, order=None)</a></code></p>
<p class="firstline">Returns subscription resources that match the API request criteria.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -108,31 +108,85 @@
The object takes the form of:
{ # 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.
+ "kind": "youtube#subscription", # The kind, fixed to "youtube#subscription".
+ "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
+ "newItemCount": 42, # The number of new items in the subscription since its content was last read.
+ "activityType": "A String", # The type of activity this subscription is for (only uploads, everything).
+ "totalItemCount": 42, # The approximate number of items that the subscription points to.
+ },
"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.
- "description": "A String", # The subscription's details.
+ "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.
+ "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ },
"title": "A String", # The subscription's title.
"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.
- "kind": "A String", # The kind, or type, of the referred resource.
+ "kind": "A String", # The type of the API resource.
"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.
"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.
"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.
},
"channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
"publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # A map of thumbnail images associated with the subscription. 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.
- "a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name.
+ "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
+ "description": "A String", # The subscription's details.
+ },
+ "etag": "A String", # Etag of this resource.
+ "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the sbuscriber.
+ "title": "A String", # The title of the subscriber.
+ "channelId": "A String", # The channel ID of the subscriber.
+ "description": "A String", # The description of the subscriber.
+ "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
+ "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
- "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
- "newItemCount": 42, # The number of new items in the subscription since its content was last read.
- "totalItemCount": 42, # The approximate number of items that the subscription points to.
- },
- "kind": "youtube#subscription", # The type of the API resource. For subscription resources, the value will be youtube#subscription.
- "etag": "A String", # The ETag of the subscription resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
}
@@ -141,37 +195,91 @@
An object of the form:
{ # 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.
+ "kind": "youtube#subscription", # The kind, fixed to "youtube#subscription".
+ "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
+ "newItemCount": 42, # The number of new items in the subscription since its content was last read.
+ "activityType": "A String", # The type of activity this subscription is for (only uploads, everything).
+ "totalItemCount": 42, # The approximate number of items that the subscription points to.
+ },
"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.
- "description": "A String", # The subscription's details.
+ "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.
+ "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ },
"title": "A String", # The subscription's title.
"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.
- "kind": "A String", # The kind, or type, of the referred resource.
+ "kind": "A String", # The type of the API resource.
"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.
"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.
"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.
},
"channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
"publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # A map of thumbnail images associated with the subscription. 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.
- "a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name.
+ "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
+ "description": "A String", # The subscription's details.
+ },
+ "etag": "A String", # Etag of this resource.
+ "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the sbuscriber.
+ "title": "A String", # The title of the subscriber.
+ "channelId": "A String", # The channel ID of the subscriber.
+ "description": "A String", # The description of the subscriber.
+ "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
+ "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
- "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
- "newItemCount": 42, # The number of new items in the subscription since its content was last read.
- "totalItemCount": 42, # The approximate number of items that the subscription points to.
- },
- "kind": "youtube#subscription", # The type of the API resource. For subscription resources, the value will be youtube#subscription.
- "etag": "A String", # The ETag of the subscription resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(part=None, pageToken=None, channelId=None, mine=None, maxResults=None, forChannelId=None, order=None, id=None)</code>
+ <code class="details" id="list">list(part=None, pageToken=None, id=None, channelId=None, mine=None, maxResults=None, forChannelId=None, mySubscribers=None, order=None)</code>
<pre>Returns subscription resources that match the API request criteria.
Args:
@@ -179,50 +287,107 @@
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)
pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
+ id: string, The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID.
channelId: string, The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions.
mine: boolean, Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions.
maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
forChannelId: string, The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels.
+ mySubscribers: boolean, Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user.
order: string, The order parameter specifies the method that will be used to sort resources in the API response.
Allowed values
alphabetical - Sort alphabetically.
relevance - Sort by relevance.
unread - Sort by order of activity.
- id: string, The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID.
Returns:
An object of the form:
{ # A paginated list of subscriptions returned as the response to a youtube.subscriptions.list call.
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
"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.
"kind": "youtube#subscriptionListResponse", # The type of the API response. For this operation, the value will be youtube#subscriptionListResponse.
+ "visitorId": "A String", # The visitorId identifies the visitor.
"items": [ # A list of subscriptions that match the request criteria.
{ # 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.
+ "kind": "youtube#subscription", # The kind, fixed to "youtube#subscription".
+ "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
+ "newItemCount": 42, # The number of new items in the subscription since its content was last read.
+ "activityType": "A String", # The type of activity this subscription is for (only uploads, everything).
+ "totalItemCount": 42, # The approximate number of items that the subscription points to.
+ },
"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.
- "description": "A String", # The subscription's details.
+ "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.
+ "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ },
"title": "A String", # The subscription's title.
"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.
- "kind": "A String", # The kind, or type, of the referred resource.
+ "kind": "A String", # The type of the API resource.
"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.
"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.
"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.
},
"channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
"publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # A map of thumbnail images associated with the subscription. 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.
- "a_key": { # A thumbnail is an image representing a YouTube resource. # The thumbnail image's name.
+ "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
+ "description": "A String", # The subscription's details.
+ },
+ "etag": "A String", # Etag of this resource.
+ "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the sbuscriber.
+ "title": "A String", # The title of the subscriber.
+ "channelId": "A String", # The channel ID of the subscriber.
+ "description": "A String", # The description of the subscriber.
+ "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
+ "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42, # (Optional) Width of the thumbnail image.
+ "height": 42, # (Optional) Height of the thumbnail image.
+ },
+ "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
"height": 42, # (Optional) Height of the thumbnail image.
},
},
},
- "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
- "newItemCount": 42, # The number of new items in the subscription since its content was last read.
- "totalItemCount": 42, # The approximate number of items that the subscription points to.
- },
- "kind": "youtube#subscription", # The type of the API resource. For subscription resources, the value will be youtube#subscription.
- "etag": "A String", # The ETag of the subscription resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
},
],