Debian Codegraph @

docs/dyn/admin_directory_v1.schemas.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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.schemas.html">schemas</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(customerId, schemaKey, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes a schema.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(customerId, schemaKey, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a schema.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(customerId, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Creates a schema.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(customerId, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves all schemas for a customer.</p>
92 <p class="toc_element">
93 <code><a href="#patch">patch(customerId, schemaKey, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Patches a schema.</p>
95 <p class="toc_element">
96 <code><a href="#update">update(customerId, schemaKey, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates a schema.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="delete">delete(customerId, schemaKey, x__xgafv=None)</code>
106 <pre>Deletes a schema.
107
108 Args:
109 customerId: string, Immutable ID of the Google Workspace account. (required)
110 schemaKey: string, Name or immutable ID of the schema. (required)
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115 </pre>
116 </div>
117
118 <div class="method">
119 <code class="details" id="get">get(customerId, schemaKey, x__xgafv=None)</code>
120 <pre>Retrieves a schema.
121
122 Args:
123 customerId: string, The unique ID for the customer&#x27;s Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account&#x27;s `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
124 schemaKey: string, Name or immutable ID of the schema. (required)
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130 Returns:
131 An object of the form:
132
133 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
134 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the schema.
135 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the resource.
136 &quot;fields&quot;: [ # A list of fields in the schema.
137 { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
138 &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the field.
139 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the field.
140 &quot;fieldId&quot;: &quot;A String&quot;, # The unique identifier of the field (Read-only)
141 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field.
142 &quot;fieldType&quot;: &quot;A String&quot;, # The type of the field.
143 &quot;indexed&quot;: true, # Boolean specifying whether the field is indexed or not. Default: `true`.
144 &quot;kind&quot;: &quot;admin#directory#schema#fieldspec&quot;, # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
145 &quot;multiValued&quot;: True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
146 &quot;numericIndexingSpec&quot;: { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.
147 &quot;maxValue&quot;: 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
148 &quot;minValue&quot;: 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
149 },
150 &quot;readAccessType&quot;: &quot;ALL_DOMAIN_USERS&quot;, # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
151 },
152 ],
153 &quot;kind&quot;: &quot;admin#directory#schema&quot;, # Kind of resource this is.
154 &quot;schemaId&quot;: &quot;A String&quot;, # The unique identifier of the schema (Read-only)
155 &quot;schemaName&quot;: &quot;A String&quot;, # The schema&#x27;s name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
156 }</pre>
157 </div>
158
159 <div class="method">
160 <code class="details" id="insert">insert(customerId, body=None, x__xgafv=None)</code>
161 <pre>Creates a schema.
162
163 Args:
164 customerId: string, Immutable ID of the Google Workspace account. (required)
165 body: object, The request body.
166 The object takes the form of:
167
168 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
169 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the schema.
170 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the resource.
171 &quot;fields&quot;: [ # A list of fields in the schema.
172 { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
173 &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the field.
174 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the field.
175 &quot;fieldId&quot;: &quot;A String&quot;, # The unique identifier of the field (Read-only)
176 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field.
177 &quot;fieldType&quot;: &quot;A String&quot;, # The type of the field.
178 &quot;indexed&quot;: true, # Boolean specifying whether the field is indexed or not. Default: `true`.
179 &quot;kind&quot;: &quot;admin#directory#schema#fieldspec&quot;, # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
180 &quot;multiValued&quot;: True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
181 &quot;numericIndexingSpec&quot;: { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.
182 &quot;maxValue&quot;: 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
183 &quot;minValue&quot;: 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
184 },
185 &quot;readAccessType&quot;: &quot;ALL_DOMAIN_USERS&quot;, # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
186 },
187 ],
188 &quot;kind&quot;: &quot;admin#directory#schema&quot;, # Kind of resource this is.
189 &quot;schemaId&quot;: &quot;A String&quot;, # The unique identifier of the schema (Read-only)
190 &quot;schemaName&quot;: &quot;A String&quot;, # The schema&#x27;s name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
191 }
192
193 x__xgafv: string, V1 error format.
194 Allowed values
195 1 - v1 error format
196 2 - v2 error format
197
198 Returns:
199 An object of the form:
200
201 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
202 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the schema.
203 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the resource.
204 &quot;fields&quot;: [ # A list of fields in the schema.
205 { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
206 &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the field.
207 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the field.
208 &quot;fieldId&quot;: &quot;A String&quot;, # The unique identifier of the field (Read-only)
209 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field.
210 &quot;fieldType&quot;: &quot;A String&quot;, # The type of the field.
211 &quot;indexed&quot;: true, # Boolean specifying whether the field is indexed or not. Default: `true`.
212 &quot;kind&quot;: &quot;admin#directory#schema#fieldspec&quot;, # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
213 &quot;multiValued&quot;: True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
214 &quot;numericIndexingSpec&quot;: { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.
215 &quot;maxValue&quot;: 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
216 &quot;minValue&quot;: 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
217 },
218 &quot;readAccessType&quot;: &quot;ALL_DOMAIN_USERS&quot;, # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
219 },
220 ],
221 &quot;kind&quot;: &quot;admin#directory#schema&quot;, # Kind of resource this is.
222 &quot;schemaId&quot;: &quot;A String&quot;, # The unique identifier of the schema (Read-only)
223 &quot;schemaName&quot;: &quot;A String&quot;, # The schema&#x27;s name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
224 }</pre>
225 </div>
226
227 <div class="method">
228 <code class="details" id="list">list(customerId, x__xgafv=None)</code>
229 <pre>Retrieves all schemas for a customer.
230
231 Args:
232 customerId: string, The unique ID for the customer&#x27;s Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account&#x27;s `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
237
238 Returns:
239 An object of the form:
240
241 { # JSON response template for List Schema operation in Directory API.
242 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
243 &quot;kind&quot;: &quot;admin#directory#schemas&quot;, # Kind of resource this is.
244 &quot;schemas&quot;: [ # A list of UserSchema objects.
245 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
246 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the schema.
247 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the resource.
248 &quot;fields&quot;: [ # A list of fields in the schema.
249 { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
250 &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the field.
251 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the field.
252 &quot;fieldId&quot;: &quot;A String&quot;, # The unique identifier of the field (Read-only)
253 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field.
254 &quot;fieldType&quot;: &quot;A String&quot;, # The type of the field.
255 &quot;indexed&quot;: true, # Boolean specifying whether the field is indexed or not. Default: `true`.
256 &quot;kind&quot;: &quot;admin#directory#schema#fieldspec&quot;, # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
257 &quot;multiValued&quot;: True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
258 &quot;numericIndexingSpec&quot;: { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.
259 &quot;maxValue&quot;: 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
260 &quot;minValue&quot;: 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
261 },
262 &quot;readAccessType&quot;: &quot;ALL_DOMAIN_USERS&quot;, # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
263 },
264 ],
265 &quot;kind&quot;: &quot;admin#directory#schema&quot;, # Kind of resource this is.
266 &quot;schemaId&quot;: &quot;A String&quot;, # The unique identifier of the schema (Read-only)
267 &quot;schemaName&quot;: &quot;A String&quot;, # The schema&#x27;s name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
268 },
269 ],
270 }</pre>
271 </div>
272
273 <div class="method">
274 <code class="details" id="patch">patch(customerId, schemaKey, body=None, x__xgafv=None)</code>
275 <pre>Patches a schema.
276
277 Args:
278 customerId: string, Immutable ID of the Google Workspace account. (required)
279 schemaKey: string, Name or immutable ID of the schema. (required)
280 body: object, The request body.
281 The object takes the form of:
282
283 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
284 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the schema.
285 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the resource.
286 &quot;fields&quot;: [ # A list of fields in the schema.
287 { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
288 &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the field.
289 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the field.
290 &quot;fieldId&quot;: &quot;A String&quot;, # The unique identifier of the field (Read-only)
291 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field.
292 &quot;fieldType&quot;: &quot;A String&quot;, # The type of the field.
293 &quot;indexed&quot;: true, # Boolean specifying whether the field is indexed or not. Default: `true`.
294 &quot;kind&quot;: &quot;admin#directory#schema#fieldspec&quot;, # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
295 &quot;multiValued&quot;: True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
296 &quot;numericIndexingSpec&quot;: { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.
297 &quot;maxValue&quot;: 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
298 &quot;minValue&quot;: 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
299 },
300 &quot;readAccessType&quot;: &quot;ALL_DOMAIN_USERS&quot;, # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
301 },
302 ],
303 &quot;kind&quot;: &quot;admin#directory#schema&quot;, # Kind of resource this is.
304 &quot;schemaId&quot;: &quot;A String&quot;, # The unique identifier of the schema (Read-only)
305 &quot;schemaName&quot;: &quot;A String&quot;, # The schema&#x27;s name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
306 }
307
308 x__xgafv: string, V1 error format.
309 Allowed values
310 1 - v1 error format
311 2 - v2 error format
312
313 Returns:
314 An object of the form:
315
316 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
317 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the schema.
318 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the resource.
319 &quot;fields&quot;: [ # A list of fields in the schema.
320 { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
321 &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the field.
322 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the field.
323 &quot;fieldId&quot;: &quot;A String&quot;, # The unique identifier of the field (Read-only)
324 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field.
325 &quot;fieldType&quot;: &quot;A String&quot;, # The type of the field.
326 &quot;indexed&quot;: true, # Boolean specifying whether the field is indexed or not. Default: `true`.
327 &quot;kind&quot;: &quot;admin#directory#schema#fieldspec&quot;, # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
328 &quot;multiValued&quot;: True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
329 &quot;numericIndexingSpec&quot;: { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.
330 &quot;maxValue&quot;: 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
331 &quot;minValue&quot;: 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
332 },
333 &quot;readAccessType&quot;: &quot;ALL_DOMAIN_USERS&quot;, # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
334 },
335 ],
336 &quot;kind&quot;: &quot;admin#directory#schema&quot;, # Kind of resource this is.
337 &quot;schemaId&quot;: &quot;A String&quot;, # The unique identifier of the schema (Read-only)
338 &quot;schemaName&quot;: &quot;A String&quot;, # The schema&#x27;s name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
339 }</pre>
340 </div>
341
342 <div class="method">
343 <code class="details" id="update">update(customerId, schemaKey, body=None, x__xgafv=None)</code>
344 <pre>Updates a schema.
345
346 Args:
347 customerId: string, Immutable ID of the Google Workspace account. (required)
348 schemaKey: string, Name or immutable ID of the schema. (required)
349 body: object, The request body.
350 The object takes the form of:
351
352 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
353 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the schema.
354 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the resource.
355 &quot;fields&quot;: [ # A list of fields in the schema.
356 { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
357 &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the field.
358 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the field.
359 &quot;fieldId&quot;: &quot;A String&quot;, # The unique identifier of the field (Read-only)
360 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field.
361 &quot;fieldType&quot;: &quot;A String&quot;, # The type of the field.
362 &quot;indexed&quot;: true, # Boolean specifying whether the field is indexed or not. Default: `true`.
363 &quot;kind&quot;: &quot;admin#directory#schema#fieldspec&quot;, # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
364 &quot;multiValued&quot;: True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
365 &quot;numericIndexingSpec&quot;: { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.
366 &quot;maxValue&quot;: 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
367 &quot;minValue&quot;: 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
368 },
369 &quot;readAccessType&quot;: &quot;ALL_DOMAIN_USERS&quot;, # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
370 },
371 ],
372 &quot;kind&quot;: &quot;admin#directory#schema&quot;, # Kind of resource this is.
373 &quot;schemaId&quot;: &quot;A String&quot;, # The unique identifier of the schema (Read-only)
374 &quot;schemaName&quot;: &quot;A String&quot;, # The schema&#x27;s name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
375 }
376
377 x__xgafv: string, V1 error format.
378 Allowed values
379 1 - v1 error format
380 2 - v2 error format
381
382 Returns:
383 An object of the form:
384
385 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
386 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the schema.
387 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the resource.
388 &quot;fields&quot;: [ # A list of fields in the schema.
389 { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
390 &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the field.
391 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the field.
392 &quot;fieldId&quot;: &quot;A String&quot;, # The unique identifier of the field (Read-only)
393 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field.
394 &quot;fieldType&quot;: &quot;A String&quot;, # The type of the field.
395 &quot;indexed&quot;: true, # Boolean specifying whether the field is indexed or not. Default: `true`.
396 &quot;kind&quot;: &quot;admin#directory#schema#fieldspec&quot;, # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
397 &quot;multiValued&quot;: True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
398 &quot;numericIndexingSpec&quot;: { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.
399 &quot;maxValue&quot;: 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
400 &quot;minValue&quot;: 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
401 },
402 &quot;readAccessType&quot;: &quot;ALL_DOMAIN_USERS&quot;, # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
403 },
404 ],
405 &quot;kind&quot;: &quot;admin#directory#schema&quot;, # Kind of resource this is.
406 &quot;schemaId&quot;: &quot;A String&quot;, # The unique identifier of the schema (Read-only)
407 &quot;schemaName&quot;: &quot;A String&quot;, # The schema&#x27;s name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
408 }</pre>
409 </div>
410
411 </body></html>