docs/dyn/chat_v1.media.html - platform/external/python/google-api-python-client - Git at Google

 <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="chat_v1.html">Google Chat API</a> . <a href="chat_v1.media.html">media</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="#download">download(resourceName, x__xgafv=None)</a></code></p>
 <p class="firstline">Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.</p>
 <p class="toc_element">
   <code><a href="#download_media">download_media(resourceName, x__xgafv=None)</a></code></p>
 <p class="firstline">Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.</p>
 <p class="toc_element">
   <code><a href="#upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).</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="download">download(resourceName, x__xgafv=None)</code>
   <pre>Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.

 Args:
   resourceName: string, Name of the media that is being downloaded. See ReadRequest.resource_name. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Media resource.
   &quot;resourceName&quot;: &quot;A String&quot;, # Name of the media resource.
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="download_media">download_media(resourceName, x__xgafv=None)</code>
   <pre>Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.

 Args:
   resourceName: string, Name of the media that is being downloaded. See ReadRequest.resource_name. (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>

 <div class="method">
     <code class="details" id="upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</code>
   <pre>Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren&#x27;t supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&amp;co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).

 Args:
   parent: string, Required. Resource name of the Chat space in which the attachment is uploaded. Format &quot;spaces/{space}&quot;. (required)
   body: object, The request body.
     The object takes the form of:

 { # Request to upload an attachment.
   &quot;filename&quot;: &quot;A String&quot;, # Required. The filename of the attachment, including the file extension.
 }

   media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
   media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Response of uploading an attachment.
   &quot;attachmentDataRef&quot;: { # A reference to the attachment data. # Reference to the uploaded attachment.
     &quot;attachmentUploadToken&quot;: &quot;A String&quot;, # Optional. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments.
     &quot;resourceName&quot;: &quot;A String&quot;, # Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data.
   },
 }</pre>
 </div>

 </body></html>
	<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="chat_v1.html">Google Chat API</a> . <a href="chat_v1.media.html">media</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="#download">download(resourceName, x__xgafv=None)</a></code></p>
	<p class="firstline">Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.</p>
	<p class="toc_element">
	<code><a href="#download_media">download_media(resourceName, x__xgafv=None)</a></code></p>
	<p class="firstline">Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.</p>
	<p class="toc_element">
	<code><a href="#upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).</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="download">download(resourceName, x__xgafv=None)</code>
	<pre>Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.

	Args:
	resourceName: string, Name of the media that is being downloaded. See ReadRequest.resource_name. (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Media resource.
	"resourceName": "A String", # Name of the media resource.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="download_media">download_media(resourceName, x__xgafv=None)</code>
	<pre>Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.

	Args:
	resourceName: string, Name of the media that is being downloaded. See ReadRequest.resource_name. (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>

	<div class="method">
	<code class="details" id="upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</code>
	<pre>Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).

	Args:
	parent: string, Required. Resource name of the Chat space in which the attachment is uploaded. Format "spaces/{space}". (required)
	body: object, The request body.
	The object takes the form of:

	{ # Request to upload an attachment.
	"filename": "A String", # Required. The filename of the attachment, including the file extension.
	}

	media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
	media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Response of uploading an attachment.
	"attachmentDataRef": { # A reference to the attachment data. # Reference to the uploaded attachment.
	"attachmentUploadToken": "A String", # Optional. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments.
	"resourceName": "A String", # Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data.
	},
	}</pre>
	</div>

	</body></html>