1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.users.html">users</a> . <a href="admin_directory_v1.users.photos.html">photos</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(userKey, x__xgafv=None)</a></code></p> 82<p class="firstline">Removes the user's photo.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(userKey, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves the user's photo.</p> 86<p class="toc_element"> 87 <code><a href="#patch">patch(userKey, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Adds a photo for the user. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).</p> 89<p class="toc_element"> 90 <code><a href="#update">update(userKey, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Adds a photo for the user.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="delete">delete(userKey, x__xgafv=None)</code> 100 <pre>Removes the user's photo. 101 102Args: 103 userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required) 104 x__xgafv: string, V1 error format. 105 Allowed values 106 1 - v1 error format 107 2 - v2 error format 108</pre> 109</div> 110 111<div class="method"> 112 <code class="details" id="get">get(userKey, x__xgafv=None)</code> 113 <pre>Retrieves the user's photo. 114 115Args: 116 userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required) 117 x__xgafv: string, V1 error format. 118 Allowed values 119 1 - v1 error format 120 2 - v2 error format 121 122Returns: 123 An object of the form: 124 125 { 126 "etag": "A String", # ETag of the resource. 127 "height": 42, # Height of the photo in pixels. 128 "id": "A String", # The ID the API uses to uniquely identify the user. 129 "kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`. 130 "mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding. 131 "photoData": "A String", # The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels. 132 "primaryEmail": "A String", # The user's primary email address. 133 "width": 42, # Width of the photo in pixels. 134}</pre> 135</div> 136 137<div class="method"> 138 <code class="details" id="patch">patch(userKey, body=None, x__xgafv=None)</code> 139 <pre>Adds a photo for the user. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch). 140 141Args: 142 userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required) 143 body: object, The request body. 144 The object takes the form of: 145 146{ 147 "etag": "A String", # ETag of the resource. 148 "height": 42, # Height of the photo in pixels. 149 "id": "A String", # The ID the API uses to uniquely identify the user. 150 "kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`. 151 "mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding. 152 "photoData": "A String", # The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels. 153 "primaryEmail": "A String", # The user's primary email address. 154 "width": 42, # Width of the photo in pixels. 155} 156 157 x__xgafv: string, V1 error format. 158 Allowed values 159 1 - v1 error format 160 2 - v2 error format 161 162Returns: 163 An object of the form: 164 165 { 166 "etag": "A String", # ETag of the resource. 167 "height": 42, # Height of the photo in pixels. 168 "id": "A String", # The ID the API uses to uniquely identify the user. 169 "kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`. 170 "mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding. 171 "photoData": "A String", # The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels. 172 "primaryEmail": "A String", # The user's primary email address. 173 "width": 42, # Width of the photo in pixels. 174}</pre> 175</div> 176 177<div class="method"> 178 <code class="details" id="update">update(userKey, body=None, x__xgafv=None)</code> 179 <pre>Adds a photo for the user. 180 181Args: 182 userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required) 183 body: object, The request body. 184 The object takes the form of: 185 186{ 187 "etag": "A String", # ETag of the resource. 188 "height": 42, # Height of the photo in pixels. 189 "id": "A String", # The ID the API uses to uniquely identify the user. 190 "kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`. 191 "mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding. 192 "photoData": "A String", # The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels. 193 "primaryEmail": "A String", # The user's primary email address. 194 "width": 42, # Width of the photo in pixels. 195} 196 197 x__xgafv: string, V1 error format. 198 Allowed values 199 1 - v1 error format 200 2 - v2 error format 201 202Returns: 203 An object of the form: 204 205 { 206 "etag": "A String", # ETag of the resource. 207 "height": 42, # Height of the photo in pixels. 208 "id": "A String", # The ID the API uses to uniquely identify the user. 209 "kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`. 210 "mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding. 211 "photoData": "A String", # The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels. 212 "primaryEmail": "A String", # The user's primary email address. 213 "width": 42, # Width of the photo in pixels. 214}</pre> 215</div> 216 217</body></html>