blob: fb39b719f0f934a4eefeee0253f2c60440b1ecb7 [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="youtubereporting_v1.html">YouTube Reporting API</a> . <a href="youtubereporting_v1.media.html">media</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#download">download(resourceName, x__xgafv=None)</a></code></p>
<p class="firstline">Method for media download. Download is supported</p>
<p class="toc_element">
<code><a href="#download_media">download_media(resourceName, x__xgafv=None)</a></code></p>
<p class="firstline">Method for media download. Download is supported</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="download">download(resourceName, x__xgafv=None)</code>
<pre>Method for media download. Download is supported
on the URI `/v1/media/{+name}?alt=media`.
Args:
resourceName: string, Name of the media that is being downloaded. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # gdata
&quot;token&quot;: &quot;A String&quot;, # gdata
&quot;blobstore2Info&quot;: { # gdata # gdata
&quot;readToken&quot;: &quot;A String&quot;, # gdata
&quot;blobId&quot;: &quot;A String&quot;, # gdata
&quot;blobGeneration&quot;: &quot;A String&quot;, # gdata
&quot;downloadReadHandle&quot;: &quot;A String&quot;, # gdata
&quot;uploadMetadataContainer&quot;: &quot;A String&quot;, # gdata
},
&quot;timestamp&quot;: &quot;A String&quot;, # gdata
&quot;hash&quot;: &quot;A String&quot;, # gdata
&quot;diffUploadResponse&quot;: { # gdata # gdata
&quot;originalObject&quot;: { # gdata # gdata
&quot;blobstore2Info&quot;: { # gdata # gdata
&quot;readToken&quot;: &quot;A String&quot;, # gdata
&quot;blobId&quot;: &quot;A String&quot;, # gdata
&quot;blobGeneration&quot;: &quot;A String&quot;, # gdata
&quot;downloadReadHandle&quot;: &quot;A String&quot;, # gdata
&quot;uploadMetadataContainer&quot;: &quot;A String&quot;, # gdata
},
&quot;cosmoBinaryReference&quot;: &quot;A String&quot;, # gdata
&quot;referenceType&quot;: &quot;A String&quot;, # gdata
&quot;path&quot;: &quot;A String&quot;, # gdata
&quot;length&quot;: &quot;A String&quot;, # gdata
&quot;crc32cHash&quot;: 42, # gdata
&quot;objectId&quot;: { # gdata # gdata
&quot;objectName&quot;: &quot;A String&quot;, # gdata
&quot;bucketName&quot;: &quot;A String&quot;, # gdata
&quot;generation&quot;: &quot;A String&quot;, # gdata
},
&quot;blobRef&quot;: &quot;A String&quot;, # gdata
&quot;inline&quot;: &quot;A String&quot;, # gdata
&quot;sha1Hash&quot;: &quot;A String&quot;, # gdata
&quot;md5Hash&quot;: &quot;A String&quot;, # gdata
},
&quot;objectVersion&quot;: &quot;A String&quot;, # gdata
},
&quot;diffVersionResponse&quot;: { # gdata # gdata
&quot;objectSizeBytes&quot;: &quot;A String&quot;, # gdata
&quot;objectVersion&quot;: &quot;A String&quot;, # gdata
},
&quot;mediaId&quot;: &quot;A String&quot;, # gdata
&quot;algorithm&quot;: &quot;A String&quot;, # gdata
&quot;length&quot;: &quot;A String&quot;, # gdata
&quot;referenceType&quot;: &quot;A String&quot;, # gdata
&quot;hashVerified&quot;: True or False, # gdata
&quot;sha256Hash&quot;: &quot;A String&quot;, # gdata
&quot;sha1Hash&quot;: &quot;A String&quot;, # gdata
&quot;inline&quot;: &quot;A String&quot;, # gdata
&quot;compositeMedia&quot;: [ # gdata
{ # gdata
&quot;blobstore2Info&quot;: { # gdata # gdata
&quot;readToken&quot;: &quot;A String&quot;, # gdata
&quot;blobId&quot;: &quot;A String&quot;, # gdata
&quot;blobGeneration&quot;: &quot;A String&quot;, # gdata
&quot;downloadReadHandle&quot;: &quot;A String&quot;, # gdata
&quot;uploadMetadataContainer&quot;: &quot;A String&quot;, # gdata
},
&quot;cosmoBinaryReference&quot;: &quot;A String&quot;, # gdata
&quot;referenceType&quot;: &quot;A String&quot;, # gdata
&quot;path&quot;: &quot;A String&quot;, # gdata
&quot;length&quot;: &quot;A String&quot;, # gdata
&quot;crc32cHash&quot;: 42, # gdata
&quot;objectId&quot;: { # gdata # gdata
&quot;objectName&quot;: &quot;A String&quot;, # gdata
&quot;bucketName&quot;: &quot;A String&quot;, # gdata
&quot;generation&quot;: &quot;A String&quot;, # gdata
},
&quot;blobRef&quot;: &quot;A String&quot;, # gdata
&quot;inline&quot;: &quot;A String&quot;, # gdata
&quot;sha1Hash&quot;: &quot;A String&quot;, # gdata
&quot;md5Hash&quot;: &quot;A String&quot;, # gdata
},
],
&quot;cosmoBinaryReference&quot;: &quot;A String&quot;, # gdata
&quot;diffChecksumsResponse&quot;: { # gdata # gdata
&quot;objectVersion&quot;: &quot;A String&quot;, # gdata
&quot;objectLocation&quot;: { # gdata # gdata
&quot;blobstore2Info&quot;: { # gdata # gdata
&quot;readToken&quot;: &quot;A String&quot;, # gdata
&quot;blobId&quot;: &quot;A String&quot;, # gdata
&quot;blobGeneration&quot;: &quot;A String&quot;, # gdata
&quot;downloadReadHandle&quot;: &quot;A String&quot;, # gdata
&quot;uploadMetadataContainer&quot;: &quot;A String&quot;, # gdata
},
&quot;cosmoBinaryReference&quot;: &quot;A String&quot;, # gdata
&quot;referenceType&quot;: &quot;A String&quot;, # gdata
&quot;path&quot;: &quot;A String&quot;, # gdata
&quot;length&quot;: &quot;A String&quot;, # gdata
&quot;crc32cHash&quot;: 42, # gdata
&quot;objectId&quot;: { # gdata # gdata
&quot;objectName&quot;: &quot;A String&quot;, # gdata
&quot;bucketName&quot;: &quot;A String&quot;, # gdata
&quot;generation&quot;: &quot;A String&quot;, # gdata
},
&quot;blobRef&quot;: &quot;A String&quot;, # gdata
&quot;inline&quot;: &quot;A String&quot;, # gdata
&quot;sha1Hash&quot;: &quot;A String&quot;, # gdata
&quot;md5Hash&quot;: &quot;A String&quot;, # gdata
},
&quot;checksumsLocation&quot;: { # gdata # gdata
&quot;blobstore2Info&quot;: { # gdata # gdata
&quot;readToken&quot;: &quot;A String&quot;, # gdata
&quot;blobId&quot;: &quot;A String&quot;, # gdata
&quot;blobGeneration&quot;: &quot;A String&quot;, # gdata
&quot;downloadReadHandle&quot;: &quot;A String&quot;, # gdata
&quot;uploadMetadataContainer&quot;: &quot;A String&quot;, # gdata
},
&quot;cosmoBinaryReference&quot;: &quot;A String&quot;, # gdata
&quot;referenceType&quot;: &quot;A String&quot;, # gdata
&quot;path&quot;: &quot;A String&quot;, # gdata
&quot;length&quot;: &quot;A String&quot;, # gdata
&quot;crc32cHash&quot;: 42, # gdata
&quot;objectId&quot;: { # gdata # gdata
&quot;objectName&quot;: &quot;A String&quot;, # gdata
&quot;bucketName&quot;: &quot;A String&quot;, # gdata
&quot;generation&quot;: &quot;A String&quot;, # gdata
},
&quot;blobRef&quot;: &quot;A String&quot;, # gdata
&quot;inline&quot;: &quot;A String&quot;, # gdata
&quot;sha1Hash&quot;: &quot;A String&quot;, # gdata
&quot;md5Hash&quot;: &quot;A String&quot;, # gdata
},
&quot;objectSizeBytes&quot;: &quot;A String&quot;, # gdata
&quot;chunkSizeBytes&quot;: &quot;A String&quot;, # gdata
},
&quot;md5Hash&quot;: &quot;A String&quot;, # gdata
&quot;downloadParameters&quot;: { # gdata # gdata
&quot;allowGzipCompression&quot;: True or False, # gdata
&quot;ignoreRange&quot;: True or False, # gdata
},
&quot;diffDownloadResponse&quot;: { # gdata # gdata
&quot;objectLocation&quot;: { # gdata # gdata
&quot;blobstore2Info&quot;: { # gdata # gdata
&quot;readToken&quot;: &quot;A String&quot;, # gdata
&quot;blobId&quot;: &quot;A String&quot;, # gdata
&quot;blobGeneration&quot;: &quot;A String&quot;, # gdata
&quot;downloadReadHandle&quot;: &quot;A String&quot;, # gdata
&quot;uploadMetadataContainer&quot;: &quot;A String&quot;, # gdata
},
&quot;cosmoBinaryReference&quot;: &quot;A String&quot;, # gdata
&quot;referenceType&quot;: &quot;A String&quot;, # gdata
&quot;path&quot;: &quot;A String&quot;, # gdata
&quot;length&quot;: &quot;A String&quot;, # gdata
&quot;crc32cHash&quot;: 42, # gdata
&quot;objectId&quot;: { # gdata # gdata
&quot;objectName&quot;: &quot;A String&quot;, # gdata
&quot;bucketName&quot;: &quot;A String&quot;, # gdata
&quot;generation&quot;: &quot;A String&quot;, # gdata
},
&quot;blobRef&quot;: &quot;A String&quot;, # gdata
&quot;inline&quot;: &quot;A String&quot;, # gdata
&quot;sha1Hash&quot;: &quot;A String&quot;, # gdata
&quot;md5Hash&quot;: &quot;A String&quot;, # gdata
},
},
&quot;contentType&quot;: &quot;A String&quot;, # gdata
&quot;contentTypeInfo&quot;: { # gdata # gdata
&quot;fromUrlPath&quot;: &quot;A String&quot;, # gdata
&quot;fromHeader&quot;: &quot;A String&quot;, # gdata
&quot;fromBytes&quot;: &quot;A String&quot;, # gdata
&quot;bestGuess&quot;: &quot;A String&quot;, # gdata
&quot;fromFileName&quot;: &quot;A String&quot;, # gdata
},
&quot;diffUploadRequest&quot;: { # gdata # gdata
&quot;objectVersion&quot;: &quot;A String&quot;, # gdata
&quot;objectInfo&quot;: { # gdata # gdata
&quot;blobstore2Info&quot;: { # gdata # gdata
&quot;readToken&quot;: &quot;A String&quot;, # gdata
&quot;blobId&quot;: &quot;A String&quot;, # gdata
&quot;blobGeneration&quot;: &quot;A String&quot;, # gdata
&quot;downloadReadHandle&quot;: &quot;A String&quot;, # gdata
&quot;uploadMetadataContainer&quot;: &quot;A String&quot;, # gdata
},
&quot;cosmoBinaryReference&quot;: &quot;A String&quot;, # gdata
&quot;referenceType&quot;: &quot;A String&quot;, # gdata
&quot;path&quot;: &quot;A String&quot;, # gdata
&quot;length&quot;: &quot;A String&quot;, # gdata
&quot;crc32cHash&quot;: 42, # gdata
&quot;objectId&quot;: { # gdata # gdata
&quot;objectName&quot;: &quot;A String&quot;, # gdata
&quot;bucketName&quot;: &quot;A String&quot;, # gdata
&quot;generation&quot;: &quot;A String&quot;, # gdata
},
&quot;blobRef&quot;: &quot;A String&quot;, # gdata
&quot;inline&quot;: &quot;A String&quot;, # gdata
&quot;sha1Hash&quot;: &quot;A String&quot;, # gdata
&quot;md5Hash&quot;: &quot;A String&quot;, # gdata
},
&quot;checksumsInfo&quot;: { # gdata # gdata
&quot;blobstore2Info&quot;: { # gdata # gdata
&quot;readToken&quot;: &quot;A String&quot;, # gdata
&quot;blobId&quot;: &quot;A String&quot;, # gdata
&quot;blobGeneration&quot;: &quot;A String&quot;, # gdata
&quot;downloadReadHandle&quot;: &quot;A String&quot;, # gdata
&quot;uploadMetadataContainer&quot;: &quot;A String&quot;, # gdata
},
&quot;cosmoBinaryReference&quot;: &quot;A String&quot;, # gdata
&quot;referenceType&quot;: &quot;A String&quot;, # gdata
&quot;path&quot;: &quot;A String&quot;, # gdata
&quot;length&quot;: &quot;A String&quot;, # gdata
&quot;crc32cHash&quot;: 42, # gdata
&quot;objectId&quot;: { # gdata # gdata
&quot;objectName&quot;: &quot;A String&quot;, # gdata
&quot;bucketName&quot;: &quot;A String&quot;, # gdata
&quot;generation&quot;: &quot;A String&quot;, # gdata
},
&quot;blobRef&quot;: &quot;A String&quot;, # gdata
&quot;inline&quot;: &quot;A String&quot;, # gdata
&quot;sha1Hash&quot;: &quot;A String&quot;, # gdata
&quot;md5Hash&quot;: &quot;A String&quot;, # gdata
},
},
&quot;filename&quot;: &quot;A String&quot;, # gdata
&quot;bigstoreObjectRef&quot;: &quot;A String&quot;, # gdata
&quot;isPotentialRetry&quot;: True or False, # gdata
&quot;crc32cHash&quot;: 42, # gdata
&quot;blobRef&quot;: &quot;A String&quot;, # gdata
&quot;path&quot;: &quot;A String&quot;, # gdata
&quot;objectId&quot;: { # gdata # gdata
&quot;objectName&quot;: &quot;A String&quot;, # gdata
&quot;bucketName&quot;: &quot;A String&quot;, # gdata
&quot;generation&quot;: &quot;A String&quot;, # gdata
},
}</pre>
</div>
<div class="method">
<code class="details" id="download_media">download_media(resourceName, x__xgafv=None)</code>
<pre>Method for media download. Download is supported
on the URI `/v1/media/{+name}?alt=media`.
Args:
resourceName: string, Name of the media that is being downloaded. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
The media object as a string.
</pre>
</div>
</body></html>