docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/youtube_v3.subscriptions.html b/docs/dyn/youtube_v3.subscriptions.html
index c385962..0e1f089 100644
--- a/docs/dyn/youtube_v3.subscriptions.html
+++ b/docs/dyn/youtube_v3.subscriptions.html
@@ -75,19 +75,27 @@
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.subscriptions.html">subscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new resource into this collection.</p>
<p class="toc_element">
- <code><a href="#list">list(part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, mine=None, channelId=None, forChannelId=None, order=None, id=None, mySubscribers=None, myRecentSubscribers=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(part, myRecentSubscribers=None, maxResults=None, order=None, channelId=None, mine=None, mySubscribers=None, pageToken=None, onBehalfOfContentOwnerChannel=None, id=None, onBehalfOfContentOwner=None, forChannelId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(id, x__xgafv=None)</code>
<pre>Deletes a resource.
@@ -105,118 +113,92 @@
<pre>Inserts a new resource into this collection.
Args:
- part: string, The <code><strong>part</strong></code> parameter serves two purposes in
-this operation. It identifies the properties that the write operation will
-set as well as the properties that the API response will include. (required) (repeated)
+ part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. (required) (repeated)
body: object, The request body.
The object takes the form of:
-{ # A <code><strong>subscription</strong></code> 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.
- "snippet": { # Basic details about a subscription, including title, description and # The <code>snippet</code> object contains basic details about the
- # subscription, including its title and the channel that the user subscribed
- # to.
- # thumbnails of the subscribed item.
- "title": "A String", # The subscription's title.
- "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information about the channel that
- # the user subscribed to.
- "kind": "A String", # The type of the API resource.
- "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
- # <code>resourceId.kind</code> value is <code>youtube#video</code>.
- "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
- # <code>resourceId.kind</code> value is <code>youtube#channel</code>.
- "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
- # <code>resourceId.kind</code> value is <code>youtube#playlist</code>.
+{ # 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.
+ "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
+ "totalItemCount": 42, # The approximate number of items that the subscription points to.
+ "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).
},
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
- "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.
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
+ "etag": "A String", # Etag of this resource.
+ "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.
+ "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
+ "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 format.
+ "description": "A String", # The subscription's details.
+ "title": "A String", # The subscription's title.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
},
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
+ "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.
+ "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.
+ "kind": "A String", # The type of the API resource.
+ "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.
+ "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.
},
},
- "publishedAt": "A String", # The date and time that the subscription was created. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- },
- "kind": "youtube#subscription", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#subscription"</code>.
- "contentDetails": { # Details about the content to witch a subscription refers. # The <code>contentDetails</code> 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.
- },
- "etag": "A String", # Etag of this resource.
- "subscriberSnippet": { # Basic details about a subscription's subscriber including title, # The <code>subscriberSnippet</code> object contains basic details about the
- # subscriber.
- # description, channel ID and thumbnails.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
+ "kind": "youtube#subscription", # Identifies what kind of resource this is. Value: the fixed string "youtube#subscription".
+ "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the subscriber.
+ "description": "A String", # The description of the subscriber.
+ "title": "A String", # The title of the subscriber.
+ "channelId": "A String", # The channel ID 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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
},
},
- "title": "A String", # The title of the subscriber.
- "description": "A String", # The description of the subscriber.
- "channelId": "A String", # The channel ID of the subscriber.
- },
- "id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
-}
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -226,173 +208,112 @@
Returns:
An object of the form:
- { # A <code><strong>subscription</strong></code> 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.
- "snippet": { # Basic details about a subscription, including title, description and # The <code>snippet</code> object contains basic details about the
- # subscription, including its title and the channel that the user subscribed
- # to.
- # thumbnails of the subscribed item.
- "title": "A String", # The subscription's title.
- "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information about the channel that
- # the user subscribed to.
- "kind": "A String", # The type of the API resource.
- "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
- # <code>resourceId.kind</code> value is <code>youtube#video</code>.
- "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
- # <code>resourceId.kind</code> value is <code>youtube#channel</code>.
- "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
- # <code>resourceId.kind</code> value is <code>youtube#playlist</code>.
+ { # 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.
+ "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
+ "totalItemCount": 42, # The approximate number of items that the subscription points to.
+ "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).
},
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
- "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.
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
+ "etag": "A String", # Etag of this resource.
+ "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.
+ "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
+ "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 format.
+ "description": "A String", # The subscription's details.
+ "title": "A String", # The subscription's title.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
},
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
+ "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.
+ "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.
+ "kind": "A String", # The type of the API resource.
+ "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.
+ "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.
},
},
- "publishedAt": "A String", # The date and time that the subscription was created. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- },
- "kind": "youtube#subscription", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#subscription"</code>.
- "contentDetails": { # Details about the content to witch a subscription refers. # The <code>contentDetails</code> 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.
- },
- "etag": "A String", # Etag of this resource.
- "subscriberSnippet": { # Basic details about a subscription's subscriber including title, # The <code>subscriberSnippet</code> object contains basic details about the
- # subscriber.
- # description, channel ID and thumbnails.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
+ "kind": "youtube#subscription", # Identifies what kind of resource this is. Value: the fixed string "youtube#subscription".
+ "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the subscriber.
+ "description": "A String", # The description of the subscriber.
+ "title": "A String", # The title of the subscriber.
+ "channelId": "A String", # The channel ID 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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
},
},
- "title": "A String", # The title of the subscriber.
- "description": "A String", # The description of the subscriber.
- "channelId": "A String", # The channel ID of the subscriber.
- },
- "id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
- }</pre>
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, mine=None, channelId=None, forChannelId=None, order=None, id=None, mySubscribers=None, myRecentSubscribers=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(part, myRecentSubscribers=None, maxResults=None, order=None, channelId=None, mine=None, mySubscribers=None, pageToken=None, onBehalfOfContentOwnerChannel=None, id=None, onBehalfOfContentOwner=None, forChannelId=None, x__xgafv=None)</code>
<pre>Retrieves a list of resources, possibly filtered.
Args:
- part: string, The <code><strong>part</strong></code> parameter specifies a
-comma-separated list of one or more <code>subscription</code> resource
-properties that the API response will include.<br><br>If the parameter
-identifies a property that contains child properties, the child properties
-will be included in the response. For example, in a
-<code>subscription</code> resource, the <code>snippet</code> property
-contains other properties, such as a display title for the subscription. If
-you set <code><strong>part=snippet</strong></code>, the API response will
-also contain all of those nested properties. (required) (repeated)
- onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> parameter indicates
-that the
-request's authorization credentials identify a YouTube CMS user who is
-acting on behalf of the content owner specified in the parameter value.
-This parameter is intended for YouTube content partners that own and manage
-many different YouTube channels. It allows content owners to authenticate
-once and get access to all their video and channel data, without having to
-provide authentication credentials for each individual channel. The CMS
-account that the user authenticates with must be linked to the specified
-YouTube content owner.
- onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a
-href="/youtube/v3/guides/authentication">authorized request</a>.
-<strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter
-specifies the YouTube channel ID of the channel to which a video is being
-added. This parameter is required when a request specifies a value for the
-<code>onBehalfOfContentOwner</code> parameter, and it can only be used in
-conjunction with that parameter. In addition, the request must be
-authorized using a CMS account that is linked to the content owner that the
-<code>onBehalfOfContentOwner</code> parameter specifies. Finally, the
-channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value
-specifies must be linked to the content owner that the
-<code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This
-parameter is intended for YouTube content partners that own and manage many
-different YouTube channels. It allows content owners to authenticate once
-and perform actions on behalf of the channel specified in the parameter
-value, without having to provide authentication credentials for each
-separate channel.
- mine: boolean, Flag for returning the subscriptions of the authenticated user.
- channelId: string, Return the subscriptions of the given channel owner.
- forChannelId: string, Return the subscriptions to the subset of these channels that the
-authenticated user is subscribed to.
- order: string, The order of the returned subscriptions
- id: string, Return the subscriptions with the given IDs for Stubby or Apiary. (repeated)
- mySubscribers: boolean, Return the subscribers of the given channel owner.
+ part: string, The *part* parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set *part=snippet*, the API response will also contain all of those nested properties. (required) (repeated)
myRecentSubscribers: boolean, A parameter
- maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the
-maximum number of items that should be returned in the result set.
- pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific
-page in the result set that should be returned. In an API response, the
-<code>nextPageToken</code> and <code>prevPageToken</code> properties
-identify other pages that could be retrieved.
+ maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
+ order: string, The order of the returned subscriptions
+ Allowed values
+ subscriptionOrderUnspecified -
+ relevance - Sort by relevance.
+ unread - Sort by order of activity.
+ alphabetical - Sort alphabetically.
+ channelId: string, Return the subscriptions of the given channel owner.
+ mine: boolean, Flag for returning the subscriptions of the authenticated user.
+ mySubscribers: boolean, Return the subscribers of the given channel owner.
+ 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.
+ onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
+ id: string, Return the subscriptions with the given IDs for Stubby or Apiary. (repeated)
+ onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+ forChannelId: string, Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -404,128 +325,100 @@
{
"tokenPagination": { # Stub token pagination template to suppress results.
},
- "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
- # parameter to retrieve the previous page in the result set.
- "items": [ # A list of subscriptions that match the request criteria.
- { # A <code><strong>subscription</strong></code> 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.
- "snippet": { # Basic details about a subscription, including title, description and # The <code>snippet</code> object contains basic details about the
- # subscription, including its title and the channel that the user subscribed
- # to.
- # thumbnails of the subscribed item.
- "title": "A String", # The subscription's title.
- "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information about the channel that
- # the user subscribed to.
- "kind": "A String", # The type of the API resource.
- "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
- # <code>resourceId.kind</code> value is <code>youtube#video</code>.
- "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
- # <code>resourceId.kind</code> value is <code>youtube#channel</code>.
- "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
- # <code>resourceId.kind</code> value is <code>youtube#playlist</code>.
- },
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
- "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.
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- "publishedAt": "A String", # The date and time that the subscription was created. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- },
- "kind": "youtube#subscription", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#subscription"</code>.
- "contentDetails": { # Details about the content to witch a subscription refers. # The <code>contentDetails</code> 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.
- },
- "etag": "A String", # Etag of this resource.
- "subscriberSnippet": { # Basic details about a subscription's subscriber including title, # The <code>subscriberSnippet</code> object contains basic details about the
- # subscriber.
- # description, channel ID and thumbnails.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "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.
- "width": 42, # (Optional) Width of the thumbnail image.
- "url": "A String", # The thumbnail image's URL.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- "title": "A String", # The title of the subscriber.
- "description": "A String", # The description of the subscriber.
- "channelId": "A String", # The channel ID of the subscriber.
- },
- "id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
- },
- ],
- "etag": "A String", # Etag of this resource.
"eventId": "A String", # Serialized EventId of the request which produced this response.
- "kind": "youtube#subscriptionListResponse", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#subscriptionListResponse"</code>.
- "visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
- "pageInfo": { # Paging details for lists of resources, including total number of items
- # available and number of resources returned in a single page.
+ "kind": "youtube#subscriptionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#subscriptionListResponse".
+ "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.
+ "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
+ "totalItemCount": 42, # The approximate number of items that the subscription points to.
+ "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).
+ },
+ "etag": "A String", # Etag of this resource.
+ "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.
+ "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
+ "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 format.
+ "description": "A String", # The subscription's details.
+ "title": "A String", # The subscription's title.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ },
+ "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.
+ "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.
+ "kind": "A String", # The type of the API resource.
+ "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.
+ "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.
+ },
+ },
+ "id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
+ "kind": "youtube#subscription", # Identifies what kind of resource this is. Value: the fixed string "youtube#subscription".
+ "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the subscriber.
+ "description": "A String", # The description of the subscriber.
+ "title": "A String", # The title of the subscriber.
+ "channelId": "A String", # The channel ID 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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+ },
+ },
+ },
+ ],
+ "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
"resultsPerPage": 42, # The number of results included in the API response.
"totalResults": 42, # The total number of results in the result set.
},
- "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
- # parameter to retrieve the next page in the result set.
+ "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.
+ "etag": "A String", # Etag of this resource.
+ "visitorId": "A String", # The visitorId identifies the visitor.
+ "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.
}</pre>
</div>