Refresh docs
diff --git a/docs/dyn/youtube_v3.subscriptions.html b/docs/dyn/youtube_v3.subscriptions.html
index 09b3547..7f5948e 100644
--- a/docs/dyn/youtube_v3.subscriptions.html
+++ b/docs/dyn/youtube_v3.subscriptions.html
@@ -72,158 +72,165 @@
</style>
-<h1><a href="youtube_v3.html">YouTube API</a> . <a href="youtube_v3.subscriptions.html">subscriptions</a></h1>
+<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.subscriptions.html">subscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p>
-<p class="firstline">Deletes subscriptions by IDs.</p>
+ <code><a href="#delete">delete(id)</a></code></p>
+<p class="firstline">Deletes a subscription.</p>
<p class="toc_element">
- <code><a href="#insert">insert(part, body, onBehalfOfContentOwner=None)</a></code></p>
-<p class="firstline">Insert a subscription.</p>
+ <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, onBehalfOfContentOwner=None, id=None, pageToken=None, channelId=None, mine=None, maxResults=None, forChannelId=None, order=None)</a></code></p>
-<p class="firstline">Browses the subscriptions collection.</p>
+ <code><a href="#list">list(part=None, pageToken=None, channelId=None, mine=None, maxResults=None, forChannelId=None, order=None, id=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>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
- <pre>Deletes subscriptions by IDs.
+ <code class="details" id="delete">delete(id)</code>
+ <pre>Deletes a subscription.
Args:
- id: string, YouTube IDs of the subscription to be deleted. (required)
- onBehalfOfContentOwner: string, The authenticated user acts on behalf of this content owner.
+ id: string, The id parameter specifies the YouTube subscription ID for the resource that is being deleted. In a subscription resource, the id property specifies the YouTube subscription ID. (required)
</pre>
</div>
<div class="method">
- <code class="details" id="insert">insert(part, body, onBehalfOfContentOwner=None)</code>
- <pre>Insert a subscription.
+ <code class="details" id="insert">insert(part=None, body)</code>
+ <pre>Adds a subscription for the authenticated user's channel.
Args:
- part: string, One or more parts to return on the current request. (required)
+ 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.
+
+The part names that you can include in the parameter value are snippet and contentDetails. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A subscription resource contains information about a YouTube user subscription.
- "snippet": { # Basic details about a subscription, including title, description and thumbnails of the subscribed item. # Basic details about the subscription
- "description": "A String", # Description of the subscription.
- "title": "A String", # Title of the subscription.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resource subscribed to.
- "kind": "A String", # The kind of the referred resource.
- "channelId": "A String", # ID of the referred channel. Present only when type is "CHANNEL".
- "playlistId": "A String", # ID of the referred playlist. Present only when type is "PLAYLIST".
- "videoId": "A String", # ID of the referred video. Present only when type is "VIDEO".
+{ # 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.
+ "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.
+ "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.
+ "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", # Channel publishing the subscription.
- "publishedAt": "A String", # Date and time the subscription was published at.
- "thumbnails": { # Subscription thumbnails.
- "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
- "url": "A String", # The URL for the thumbnail.
+ "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": { # The thumbnail image's name.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42,
+ "height": 42,
},
},
},
- "contentDetails": { # Details about the content to witch a subscription refers. # Basic statistics about the subscription
- "newItemCount": 42, # Number of new items in the subscription since its content was last read.
- "totalItemCount": 42, # Approximate total number of items the subscription points to.
+ "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 this API resource.
- "etag": "A String", # The eTag of the subscription.
- "id": "A String", # The unique id of the subscription.
+ "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.
}
- onBehalfOfContentOwner: string, The authenticated user acts on behalf of this content owner.
Returns:
An object of the form:
- { # A subscription resource contains information about a YouTube user subscription.
- "snippet": { # Basic details about a subscription, including title, description and thumbnails of the subscribed item. # Basic details about the subscription
- "description": "A String", # Description of the subscription.
- "title": "A String", # Title of the subscription.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resource subscribed to.
- "kind": "A String", # The kind of the referred resource.
- "channelId": "A String", # ID of the referred channel. Present only when type is "CHANNEL".
- "playlistId": "A String", # ID of the referred playlist. Present only when type is "PLAYLIST".
- "videoId": "A String", # ID of the referred video. Present only when type is "VIDEO".
+ { # 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.
+ "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.
+ "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.
+ "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", # Channel publishing the subscription.
- "publishedAt": "A String", # Date and time the subscription was published at.
- "thumbnails": { # Subscription thumbnails.
- "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
- "url": "A String", # The URL for the thumbnail.
+ "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": { # The thumbnail image's name.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42,
+ "height": 42,
},
},
},
- "contentDetails": { # Details about the content to witch a subscription refers. # Basic statistics about the subscription
- "newItemCount": 42, # Number of new items in the subscription since its content was last read.
- "totalItemCount": 42, # Approximate total number of items the subscription points to.
+ "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 this API resource.
- "etag": "A String", # The eTag of the subscription.
- "id": "A String", # The unique id of the subscription.
+ "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, onBehalfOfContentOwner=None, id=None, pageToken=None, channelId=None, mine=None, maxResults=None, forChannelId=None, order=None)</code>
- <pre>Browses the subscriptions collection.
+ <code class="details" id="list">list(part=None, pageToken=None, channelId=None, mine=None, maxResults=None, forChannelId=None, order=None, id=None)</code>
+ <pre>Returns subscription resources that match the API request criteria.
Args:
- part: string, Subscription parts to include in the returned response. Valid values are: id, snippet and contentDetails. (required)
- onBehalfOfContentOwner: string, The authenticated user acts on behalf of this content owner.
- id: string, YouTube IDs of the subscriptions to be returned.
- pageToken: string, Token for the page selection.
- channelId: string, Only return subscriptions to given channelId.
- mine: string, Flag indicating only return the subscriptions of the authenticated user.
- maxResults: integer, Maximum number of search results to return per page.
- forChannelId: string, Comma separated list of channel IDs to return subscriptions for.
- order: string, Sort order.
+ part: string, The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.
+
+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
+ 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.
+ order: string, The order parameter specifies the method that will be used to sort resources in the API response.
Allowed values
- alphabetical - Sort alphabetically
+ 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.
- "nextPageToken": "A String", # Token to the next page.
- "kind": "youtube#subscriptionListResponse", # The type of this API response.
- "items": [ # List of subscriptions matching the request criteria.
- { # A subscription resource contains information about a YouTube user subscription.
- "snippet": { # Basic details about a subscription, including title, description and thumbnails of the subscribed item. # Basic details about the subscription
- "description": "A String", # Description of the subscription.
- "title": "A String", # Title of the subscription.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resource subscribed to.
- "kind": "A String", # The kind of the referred resource.
- "channelId": "A String", # ID of the referred channel. Present only when type is "CHANNEL".
- "playlistId": "A String", # ID of the referred playlist. Present only when type is "PLAYLIST".
- "videoId": "A String", # ID of the referred video. Present only when type is "VIDEO".
+ "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.
+ "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.
+ "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.
+ "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.
+ "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", # Channel publishing the subscription.
- "publishedAt": "A String", # Date and time the subscription was published at.
- "thumbnails": { # Subscription thumbnails.
- "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
- "url": "A String", # The URL for the thumbnail.
+ "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": { # The thumbnail image's name.
+ "url": "A String", # The thumbnail image's URL.
+ "width": 42,
+ "height": 42,
},
},
},
- "contentDetails": { # Details about the content to witch a subscription refers. # Basic statistics about the subscription
- "newItemCount": 42, # Number of new items in the subscription since its content was last read.
- "totalItemCount": 42, # Approximate total number of items the subscription points to.
+ "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 this API resource.
- "etag": "A String", # The eTag of the subscription.
- "id": "A String", # The unique id of the subscription.
+ "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.
},
],
- "etag": "A String", # The eTag of the response.
- "prevPageToken": "A String", # Token to the previous page.
- "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # Paging information for the list result.
- "totalResults": 42, # The total number of results.
- "resultsPerPage": 42, # The number of results to display for each page.
+ "etag": "A String", # The ETag of the response.
+ "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.
+ "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
+ "totalResults": 42, # The total number of results in the result set.
+ "resultsPerPage": 42, # The number of results included in the API response.
},
}</pre>
</div>
@@ -239,7 +246,7 @@
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
- </pre>
+ </pre>
</div>
</body></html>
\ No newline at end of file