1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<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="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>
<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="#delete">delete(userKey, x__xgafv=None)</a></code></p>
<p class="firstline">Removes the user's photo.</p>
<p class="toc_element">
<code><a href="#get">get(userKey, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the user's photo.</p>
<p class="toc_element">
<code><a href="#patch">patch(userKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a photo for the user. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).</p>
<p class="toc_element">
<code><a href="#update">update(userKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a photo for the user.</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="delete">delete(userKey, x__xgafv=None)</code>
<pre>Removes the user's photo.
Args:
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(userKey, x__xgafv=None)</code>
<pre>Retrieves the user's photo.
Args:
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"height": 42, # Height of the photo in pixels.
"id": "A String", # The ID the API uses to uniquely identify the user.
"kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.
"mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.
"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.
"primaryEmail": "A String", # The user's primary email address.
"width": 42, # Width of the photo in pixels.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(userKey, body=None, x__xgafv=None)</code>
<pre>Adds a photo for the user. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
Args:
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)
body: object, The request body.
The object takes the form of:
{
"etag": "A String", # ETag of the resource.
"height": 42, # Height of the photo in pixels.
"id": "A String", # The ID the API uses to uniquely identify the user.
"kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.
"mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.
"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.
"primaryEmail": "A String", # The user's primary email address.
"width": 42, # Width of the photo in pixels.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"height": 42, # Height of the photo in pixels.
"id": "A String", # The ID the API uses to uniquely identify the user.
"kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.
"mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.
"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.
"primaryEmail": "A String", # The user's primary email address.
"width": 42, # Width of the photo in pixels.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(userKey, body=None, x__xgafv=None)</code>
<pre>Adds a photo for the user.
Args:
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)
body: object, The request body.
The object takes the form of:
{
"etag": "A String", # ETag of the resource.
"height": 42, # Height of the photo in pixels.
"id": "A String", # The ID the API uses to uniquely identify the user.
"kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.
"mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.
"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.
"primaryEmail": "A String", # The user's primary email address.
"width": 42, # Width of the photo in pixels.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"height": 42, # Height of the photo in pixels.
"id": "A String", # The ID the API uses to uniquely identify the user.
"kind": "admin#directory#user#photo", # The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.
"mimeType": "A String", # The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.
"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.
"primaryEmail": "A String", # The user's primary email address.
"width": 42, # Width of the photo in pixels.
}</pre>
</div>
</body></html>
|
