• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 Directory API</a> . <a href="admin_directory_v1.resources.html">resources</a> . <a href="admin_directory_v1.resources.features.html">features</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(customer, featureKey)</a></code></p>
79<p class="firstline">Deletes a feature.</p>
80<p class="toc_element">
81  <code><a href="#get">get(customer, featureKey)</a></code></p>
82<p class="firstline">Retrieves a feature.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(customer, body)</a></code></p>
85<p class="firstline">Inserts a feature.</p>
86<p class="toc_element">
87  <code><a href="#list">list(customer, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Retrieves a list of features for an account.</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93  <code><a href="#patch">patch(customer, featureKey, body)</a></code></p>
94<p class="firstline">Updates a feature. This method supports patch semantics.</p>
95<p class="toc_element">
96  <code><a href="#rename">rename(customer, oldName, body)</a></code></p>
97<p class="firstline">Renames a feature.</p>
98<p class="toc_element">
99  <code><a href="#update">update(customer, featureKey, body)</a></code></p>
100<p class="firstline">Updates a feature.</p>
101<h3>Method Details</h3>
102<div class="method">
103    <code class="details" id="delete">delete(customer, featureKey)</code>
104  <pre>Deletes a feature.
105
106Args:
107  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
108  featureKey: string, The unique ID of the feature to delete. (required)
109</pre>
110</div>
111
112<div class="method">
113    <code class="details" id="get">get(customer, featureKey)</code>
114  <pre>Retrieves a feature.
115
116Args:
117  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
118  featureKey: string, The unique ID of the feature to retrieve. (required)
119
120Returns:
121  An object of the form:
122
123    { # JSON template for Feature object in Directory API.
124      "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
125      "etags": "A String", # ETag of the resource.
126      "name": "A String", # The name of the feature.
127    }</pre>
128</div>
129
130<div class="method">
131    <code class="details" id="insert">insert(customer, body)</code>
132  <pre>Inserts a feature.
133
134Args:
135  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
136  body: object, The request body. (required)
137    The object takes the form of:
138
139{ # JSON template for Feature object in Directory API.
140    "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
141    "etags": "A String", # ETag of the resource.
142    "name": "A String", # The name of the feature.
143  }
144
145
146Returns:
147  An object of the form:
148
149    { # JSON template for Feature object in Directory API.
150      "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
151      "etags": "A String", # ETag of the resource.
152      "name": "A String", # The name of the feature.
153    }</pre>
154</div>
155
156<div class="method">
157    <code class="details" id="list">list(customer, pageToken=None, maxResults=None)</code>
158  <pre>Retrieves a list of features for an account.
159
160Args:
161  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
162  pageToken: string, Token to specify the next page in the list.
163  maxResults: integer, Maximum number of results to return.
164
165Returns:
166  An object of the form:
167
168    { # JSON template for Feature List Response object in Directory API.
169    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
170    "kind": "admin#directory#resources#features#featuresList", # Kind of resource this is.
171    "etag": "A String", # ETag of the resource.
172    "features": [ # The Features in this page of results.
173      { # JSON template for Feature object in Directory API.
174          "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
175          "etags": "A String", # ETag of the resource.
176          "name": "A String", # The name of the feature.
177        },
178    ],
179  }</pre>
180</div>
181
182<div class="method">
183    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
184  <pre>Retrieves the next page of results.
185
186Args:
187  previous_request: The request for the previous page. (required)
188  previous_response: The response from the request for the previous page. (required)
189
190Returns:
191  A request object that you can call 'execute()' on to request the next
192  page. Returns None if there are no more items in the collection.
193    </pre>
194</div>
195
196<div class="method">
197    <code class="details" id="patch">patch(customer, featureKey, body)</code>
198  <pre>Updates a feature. This method supports patch semantics.
199
200Args:
201  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
202  featureKey: string, The unique ID of the feature to update. (required)
203  body: object, The request body. (required)
204    The object takes the form of:
205
206{ # JSON template for Feature object in Directory API.
207    "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
208    "etags": "A String", # ETag of the resource.
209    "name": "A String", # The name of the feature.
210  }
211
212
213Returns:
214  An object of the form:
215
216    { # JSON template for Feature object in Directory API.
217      "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
218      "etags": "A String", # ETag of the resource.
219      "name": "A String", # The name of the feature.
220    }</pre>
221</div>
222
223<div class="method">
224    <code class="details" id="rename">rename(customer, oldName, body)</code>
225  <pre>Renames a feature.
226
227Args:
228  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
229  oldName: string, The unique ID of the feature to rename. (required)
230  body: object, The request body. (required)
231    The object takes the form of:
232
233{ # JSON request template for renaming a feature.
234    "newName": "A String", # New name of the feature.
235  }
236
237</pre>
238</div>
239
240<div class="method">
241    <code class="details" id="update">update(customer, featureKey, body)</code>
242  <pre>Updates a feature.
243
244Args:
245  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
246  featureKey: string, The unique ID of the feature to update. (required)
247  body: object, The request body. (required)
248    The object takes the form of:
249
250{ # JSON template for Feature object in Directory API.
251    "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
252    "etags": "A String", # ETag of the resource.
253    "name": "A String", # The name of the feature.
254  }
255
256
257Returns:
258  An object of the form:
259
260    { # JSON template for Feature object in Directory API.
261      "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
262      "etags": "A String", # ETag of the resource.
263      "name": "A String", # The name of the feature.
264    }</pre>
265</div>
266
267</body></html>