Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2cc09387e8c3d43370f9c61ca89e16b3c1b5cb16 / . / docs / dyn / youtube_v3.videos.html
blob: 4d1a5d883100112b854ffefb6de881485b63fac6 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.videos.html">videos</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(id)</a></code></p>
<p class="firstline">Deletes a YouTube video.</p>
<p class="toc_element">
<code><a href="#insert">insert(part=None, body=None, media_body=None)</a></code></p>
<p class="firstline">Uploads a video to YouTube and optionally sets the video's metadata.</p>
<p class="toc_element">
<code><a href="#list">list(id, part=None)</a></code></p>
<p class="firstline">Returns a list of videos that match the API request parameters.</p>
<p class="toc_element">
<code><a href="#update">update(part=None, body)</a></code></p>
<p class="firstline">Updates a video's metadata.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(id)</code>
<pre>Deletes a YouTube video.
Args:
id: string, The id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID. (required)
</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(part=None, body=None, media_body=None)</code>
<pre>Uploads a video to YouTube and optionally sets the video's metadata.
Args:
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, contentDetails, player, statistics, status, and topicDetails. However, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. (required)
body: object, The request body.
The object takes the form of:
{ # A video resource represents a YouTube video.
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
"privacyStatus": "A String", # The video's privacy status.
"uploadStatus": "A String", # The status of the uploaded video.
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
},
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
"A String",
],
},
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
"commentCount": "A String", # The number of comments for the video.
"viewCount": "A String", # The number of times the video has been viewed.
"favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
},
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
"A String",
],
"allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
"A String",
],
},
},
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
"thumbnails": { # 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.
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
"url": "A String", # The thumbnail image's URL.
"width": 42,
"height": 42,
},
},
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The video's title.
"categoryId": "A String", # The YouTube video category associated with the video.
"description": "A String", # The video's description.
},
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
},
"etag": "A String", # The ETag of the video resource.
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"locationDescription": "A String", # The text description of the location where the video was recorded.
"location": { # A geoPoint holds geo location information associated with a YouTube resource. # The geolocation information associated with the video.
"latitude": 3.14, # Latitude in degrees.
"elevation": 3.14, # Altitude above the Earth, in meters.
"longitude": 3.14, # Longitude in degrees.
},
},
"id": "A String", # The ID that YouTube uses to uniquely identify the video.
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # A video resource represents a YouTube video.
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
"privacyStatus": "A String", # The video's privacy status.
"uploadStatus": "A String", # The status of the uploaded video.
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
},
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
"A String",
],
},
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
"commentCount": "A String", # The number of comments for the video.
"viewCount": "A String", # The number of times the video has been viewed.
"favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
},
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
"A String",
],
"allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
"A String",
],
},
},
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
"thumbnails": { # 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.
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
"url": "A String", # The thumbnail image's URL.
"width": 42,
"height": 42,
},
},
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The video's title.
"categoryId": "A String", # The YouTube video category associated with the video.
"description": "A String", # The video's description.
},
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
},
"etag": "A String", # The ETag of the video resource.
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"locationDescription": "A String", # The text description of the location where the video was recorded.
"location": { # A geoPoint holds geo location information associated with a YouTube resource. # The geolocation information associated with the video.
"latitude": 3.14, # Latitude in degrees.
"elevation": 3.14, # Altitude above the Earth, in meters.
"longitude": 3.14, # Longitude in degrees.
},
},
"id": "A String", # The ID that YouTube uses to uniquely identify the video.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(id, part=None)</code>
<pre>Returns a list of videos that match the API request parameters.
Args:
id: string, The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID. (required)
part: string, The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails.
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties. (required)
Returns:
An object of the form:
{ # A paginated list of videos returned as the response to a youtube.videos.list call.
"items": [ # A list of videos that match the request criteria.
{ # A video resource represents a YouTube video.
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
"privacyStatus": "A String", # The video's privacy status.
"uploadStatus": "A String", # The status of the uploaded video.
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
},
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
"A String",
],
},
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
"commentCount": "A String", # The number of comments for the video.
"viewCount": "A String", # The number of times the video has been viewed.
"favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
},
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
"A String",
],
"allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
"A String",
],
},
},
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
"thumbnails": { # 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.
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
"url": "A String", # The thumbnail image's URL.
"width": 42,
"height": 42,
},
},
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The video's title.
"categoryId": "A String", # The YouTube video category associated with the video.
"description": "A String", # The video's description.
},
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
},
"etag": "A String", # The ETag of the video resource.
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"locationDescription": "A String", # The text description of the location where the video was recorded.
"location": { # A geoPoint holds geo location information associated with a YouTube resource. # The geolocation information associated with the video.
"latitude": 3.14, # Latitude in degrees.
"elevation": 3.14, # Altitude above the Earth, in meters.
"longitude": 3.14, # Longitude in degrees.
},
},
"id": "A String", # The ID that YouTube uses to uniquely identify the video.
},
],
"kind": "youtube#videoListResponse", # The type of the API response. For this operation, the value will be youtube#videoListResponse.
"etag": "A String", # The ETag of the response.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(part=None, body)</code>
<pre>Updates a video's metadata.
Args:
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, contentDetails, player, statistics, status, and topicDetails.
Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting.
In addition, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A video resource represents a YouTube video.
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
"privacyStatus": "A String", # The video's privacy status.
"uploadStatus": "A String", # The status of the uploaded video.
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
},
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
"A String",
],
},
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
"commentCount": "A String", # The number of comments for the video.
"viewCount": "A String", # The number of times the video has been viewed.
"favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
},
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
"A String",
],
"allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
"A String",
],
},
},
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
"thumbnails": { # 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.
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
"url": "A String", # The thumbnail image's URL.
"width": 42,
"height": 42,
},
},
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The video's title.
"categoryId": "A String", # The YouTube video category associated with the video.
"description": "A String", # The video's description.
},
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
},
"etag": "A String", # The ETag of the video resource.
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"locationDescription": "A String", # The text description of the location where the video was recorded.
"location": { # A geoPoint holds geo location information associated with a YouTube resource. # The geolocation information associated with the video.
"latitude": 3.14, # Latitude in degrees.
"elevation": 3.14, # Altitude above the Earth, in meters.
"longitude": 3.14, # Longitude in degrees.
},
},
"id": "A String", # The ID that YouTube uses to uniquely identify the video.
}
Returns:
An object of the form:
{ # A video resource represents a YouTube video.
"status": { # The status of a video details the video's upload status and privacy status. # The status object contains information about the video's uploading, processing, and privacy statuses.
"privacyStatus": "A String", # The video's privacy status.
"uploadStatus": "A String", # The status of the uploaded video.
"rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
"failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
},
"topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
"topicIds": [ # A list of Freebase topic IDs associated with the video. You can retrieve information about each topic using the Freebase Topic API.
"A String",
],
},
"kind": "youtube#video", # The type of the API resource. For video resources, the value will be youtube#video.
"statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
"commentCount": "A String", # The number of comments for the video.
"viewCount": "A String", # The number of times the video has been viewed.
"favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
"dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
},
"contentDetails": { # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
"duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
"regionRestriction": { # Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
"blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
"A String",
],
"allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
"A String",
],
},
},
"snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
"thumbnails": { # 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.
"a_key": { # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
"url": "A String", # The thumbnail image's URL.
"width": 42,
"height": 42,
},
},
"tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
"A String",
],
"channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
"publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The video's title.
"categoryId": "A String", # The YouTube video category associated with the video.
"description": "A String", # The video's description.
},
"player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
"embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
},
"etag": "A String", # The ETag of the video resource.
"recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
"recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"locationDescription": "A String", # The text description of the location where the video was recorded.
"location": { # A geoPoint holds geo location information associated with a YouTube resource. # The geolocation information associated with the video.
"latitude": 3.14, # Latitude in degrees.
"elevation": 3.14, # Altitude above the Earth, in meters.
"longitude": 3.14, # Longitude in degrees.
},
},
"id": "A String", # The ID that YouTube uses to uniquely identify the video.
}</pre>
</div>
</body></html>