Debian Codegraph @

docs/dyn/drive_v3.approvals.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="drive_v3.html">Google Drive API</a> . <a href="drive_v3.approvals.html">approvals</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#approve">approve(fileId, approvalId, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Approves an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `APPROVED`. If this is the last required reviewer response, this also completes the approval and sets the approval Status to `APPROVED`.</p>
80 <p class="toc_element">
81 <code><a href="#cancel">cancel(fileId, approvalId, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Cancels an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Updates the approval Status to `CANCELLED`. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS`.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#comment">comment(fileId, approvalId, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Comments on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log.</p>
89 <p class="toc_element">
90 <code><a href="#decline">decline(fileId, approvalId, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Declines an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `DECLINED`. This also completes the approval and sets the approval Status to `DECLINED`.</p>
92 <p class="toc_element">
93 <code><a href="#get">get(fileId, approvalId, x__xgafv=None)</a></code></p>
94 <p class="firstline">Gets an approval by ID. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).</p>
95 <p class="toc_element">
96 <code><a href="#list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Lists the approvals on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).</p>
98 <p class="toc_element">
99 <code><a href="#list_next">list_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#reassign">reassign(fileId, approvalId, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Reassigns the reviewers on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Adds or replaces reviewers in the ReviewerResponse of the approval. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS` and the Response for the reviewer being reassigned is `NO_RESPONSE`. A user with the `reader` permission can only reassign an approval that's assigned to themselves. Removing a reviewer isn't allowed.</p>
104 <p class="toc_element">
105 <code><a href="#start">start(fileId, body=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Starts an approval on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).</p>
107 <h3>Method Details</h3>
108 <div class="method">
109 <code class="details" id="approve">approve(fileId, approvalId, body=None, x__xgafv=None)</code>
110 <pre>Approves an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `APPROVED`. If this is the last required reviewer response, this also completes the approval and sets the approval Status to `APPROVED`.
111
112 Args:
113 fileId: string, Required. The ID of the file that the approval is on. (required)
114 approvalId: string, Required. The ID of the approval to approve. (required)
115 body: object, The request body.
116 The object takes the form of:
117
118 { # Request for approving an approval as a reviewer.
119 &quot;message&quot;: &quot;A String&quot;, # Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.
120 }
121
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127 Returns:
128 An object of the form:
129
130 { # Metadata for an approval. An approval is a review or approve process for a Drive item.
131 &quot;approvalId&quot;: &quot;A String&quot;, # The approval ID.
132 &quot;completeTime&quot;: &quot;A String&quot;, # Output only. The time the approval was completed.
133 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the approval was created.
134 &quot;dueTime&quot;: &quot;A String&quot;, # The time that the approval is due.
135 &quot;initiator&quot;: { # Information about a Drive user. # The user that requested the approval.
136 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
137 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
138 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
139 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
140 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
141 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
142 },
143 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#approval.
144 &quot;modifyTime&quot;: &quot;A String&quot;, # Output only. The most recent time the approval was modified.
145 &quot;reviewerResponses&quot;: [ # The responses made on the approval by reviewers.
146 { # A response on an approval made by a specific reviewer.
147 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#reviewerResponse.
148 &quot;response&quot;: &quot;A String&quot;, # A reviewer’s response for the approval.
149 &quot;reviewer&quot;: { # Information about a Drive user. # The user that&#x27;s responsible for this response.
150 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
151 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
152 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
153 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
154 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
155 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
156 },
157 },
158 ],
159 &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the approval at the time this resource was requested.
160 &quot;targetFileId&quot;: &quot;A String&quot;, # Target file id of the approval.
161 }</pre>
162 </div>
163
164 <div class="method">
165 <code class="details" id="cancel">cancel(fileId, approvalId, body=None, x__xgafv=None)</code>
166 <pre>Cancels an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Updates the approval Status to `CANCELLED`. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS`.
167
168 Args:
169 fileId: string, Required. The ID of the file that the approval is on. (required)
170 approvalId: string, Required. The ID of the approval to cancel. (required)
171 body: object, The request body.
172 The object takes the form of:
173
174 { # Request for cancelling an approval as an initiator.
175 &quot;message&quot;: &quot;A String&quot;, # Optional. A message to accompany the cancellation of the approval. This message is included in notifications for the action and in the approval activity log.
176 }
177
178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183 Returns:
184 An object of the form:
185
186 { # Metadata for an approval. An approval is a review or approve process for a Drive item.
187 &quot;approvalId&quot;: &quot;A String&quot;, # The approval ID.
188 &quot;completeTime&quot;: &quot;A String&quot;, # Output only. The time the approval was completed.
189 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the approval was created.
190 &quot;dueTime&quot;: &quot;A String&quot;, # The time that the approval is due.
191 &quot;initiator&quot;: { # Information about a Drive user. # The user that requested the approval.
192 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
193 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
194 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
195 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
196 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
197 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
198 },
199 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#approval.
200 &quot;modifyTime&quot;: &quot;A String&quot;, # Output only. The most recent time the approval was modified.
201 &quot;reviewerResponses&quot;: [ # The responses made on the approval by reviewers.
202 { # A response on an approval made by a specific reviewer.
203 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#reviewerResponse.
204 &quot;response&quot;: &quot;A String&quot;, # A reviewer’s response for the approval.
205 &quot;reviewer&quot;: { # Information about a Drive user. # The user that&#x27;s responsible for this response.
206 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
207 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
208 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
209 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
210 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
211 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
212 },
213 },
214 ],
215 &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the approval at the time this resource was requested.
216 &quot;targetFileId&quot;: &quot;A String&quot;, # Target file id of the approval.
217 }</pre>
218 </div>
219
220 <div class="method">
221 <code class="details" id="close">close()</code>
222 <pre>Close httplib2 connections.</pre>
223 </div>
224
225 <div class="method">
226 <code class="details" id="comment">comment(fileId, approvalId, body=None, x__xgafv=None)</code>
227 <pre>Comments on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log.
228
229 Args:
230 fileId: string, Required. The ID of the file that the approval is on. (required)
231 approvalId: string, Required. The ID of the approval to comment on. (required)
232 body: object, The request body.
233 The object takes the form of:
234
235 { # Request for commenting on an approval.
236 &quot;message&quot;: &quot;A String&quot;, # Required. A message to comment on the approval. This message is included in notifications for the action and in the approval activity log.
237 }
238
239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
243
244 Returns:
245 An object of the form:
246
247 { # Metadata for an approval. An approval is a review or approve process for a Drive item.
248 &quot;approvalId&quot;: &quot;A String&quot;, # The approval ID.
249 &quot;completeTime&quot;: &quot;A String&quot;, # Output only. The time the approval was completed.
250 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the approval was created.
251 &quot;dueTime&quot;: &quot;A String&quot;, # The time that the approval is due.
252 &quot;initiator&quot;: { # Information about a Drive user. # The user that requested the approval.
253 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
254 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
255 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
256 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
257 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
258 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
259 },
260 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#approval.
261 &quot;modifyTime&quot;: &quot;A String&quot;, # Output only. The most recent time the approval was modified.
262 &quot;reviewerResponses&quot;: [ # The responses made on the approval by reviewers.
263 { # A response on an approval made by a specific reviewer.
264 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#reviewerResponse.
265 &quot;response&quot;: &quot;A String&quot;, # A reviewer’s response for the approval.
266 &quot;reviewer&quot;: { # Information about a Drive user. # The user that&#x27;s responsible for this response.
267 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
268 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
269 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
270 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
271 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
272 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
273 },
274 },
275 ],
276 &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the approval at the time this resource was requested.
277 &quot;targetFileId&quot;: &quot;A String&quot;, # Target file id of the approval.
278 }</pre>
279 </div>
280
281 <div class="method">
282 <code class="details" id="decline">decline(fileId, approvalId, body=None, x__xgafv=None)</code>
283 <pre>Declines an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `DECLINED`. This also completes the approval and sets the approval Status to `DECLINED`.
284
285 Args:
286 fileId: string, Required. The ID of the file that the approval is on. (required)
287 approvalId: string, Required. The ID of the approval to decline. (required)
288 body: object, The request body.
289 The object takes the form of:
290
291 { # Request for declining an approval as a reviewer.
292 &quot;message&quot;: &quot;A String&quot;, # Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.
293 }
294
295 x__xgafv: string, V1 error format.
296 Allowed values
297 1 - v1 error format
298 2 - v2 error format
299
300 Returns:
301 An object of the form:
302
303 { # Metadata for an approval. An approval is a review or approve process for a Drive item.
304 &quot;approvalId&quot;: &quot;A String&quot;, # The approval ID.
305 &quot;completeTime&quot;: &quot;A String&quot;, # Output only. The time the approval was completed.
306 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the approval was created.
307 &quot;dueTime&quot;: &quot;A String&quot;, # The time that the approval is due.
308 &quot;initiator&quot;: { # Information about a Drive user. # The user that requested the approval.
309 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
310 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
311 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
312 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
313 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
314 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
315 },
316 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#approval.
317 &quot;modifyTime&quot;: &quot;A String&quot;, # Output only. The most recent time the approval was modified.
318 &quot;reviewerResponses&quot;: [ # The responses made on the approval by reviewers.
319 { # A response on an approval made by a specific reviewer.
320 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#reviewerResponse.
321 &quot;response&quot;: &quot;A String&quot;, # A reviewer’s response for the approval.
322 &quot;reviewer&quot;: { # Information about a Drive user. # The user that&#x27;s responsible for this response.
323 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
324 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
325 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
326 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
327 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
328 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
329 },
330 },
331 ],
332 &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the approval at the time this resource was requested.
333 &quot;targetFileId&quot;: &quot;A String&quot;, # Target file id of the approval.
334 }</pre>
335 </div>
336
337 <div class="method">
338 <code class="details" id="get">get(fileId, approvalId, x__xgafv=None)</code>
339 <pre>Gets an approval by ID. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).
340
341 Args:
342 fileId: string, Required. The ID of the file that the approval is on. (required)
343 approvalId: string, Required. The ID of the approval. (required)
344 x__xgafv: string, V1 error format.
345 Allowed values
346 1 - v1 error format
347 2 - v2 error format
348
349 Returns:
350 An object of the form:
351
352 { # Metadata for an approval. An approval is a review or approve process for a Drive item.
353 &quot;approvalId&quot;: &quot;A String&quot;, # The approval ID.
354 &quot;completeTime&quot;: &quot;A String&quot;, # Output only. The time the approval was completed.
355 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the approval was created.
356 &quot;dueTime&quot;: &quot;A String&quot;, # The time that the approval is due.
357 &quot;initiator&quot;: { # Information about a Drive user. # The user that requested the approval.
358 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
359 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
360 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
361 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
362 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
363 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
364 },
365 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#approval.
366 &quot;modifyTime&quot;: &quot;A String&quot;, # Output only. The most recent time the approval was modified.
367 &quot;reviewerResponses&quot;: [ # The responses made on the approval by reviewers.
368 { # A response on an approval made by a specific reviewer.
369 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#reviewerResponse.
370 &quot;response&quot;: &quot;A String&quot;, # A reviewer’s response for the approval.
371 &quot;reviewer&quot;: { # Information about a Drive user. # The user that&#x27;s responsible for this response.
372 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
373 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
374 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
375 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
376 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
377 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
378 },
379 },
380 ],
381 &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the approval at the time this resource was requested.
382 &quot;targetFileId&quot;: &quot;A String&quot;, # Target file id of the approval.
383 }</pre>
384 </div>
385
386 <div class="method">
387 <code class="details" id="list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</code>
388 <pre>Lists the approvals on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).
389
390 Args:
391 fileId: string, Required. The ID of the file that the approval is on. (required)
392 pageSize: integer, The maximum number of approvals to return. When not set, at most 100 approvals are returned.
393 pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.
394 x__xgafv: string, V1 error format.
395 Allowed values
396 1 - v1 error format
397 2 - v2 error format
398
399 Returns:
400 An object of the form:
401
402 { # The response of an approvals list request.
403 &quot;items&quot;: [ # The list of approvals. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.
404 { # Metadata for an approval. An approval is a review or approve process for a Drive item.
405 &quot;approvalId&quot;: &quot;A String&quot;, # The approval ID.
406 &quot;completeTime&quot;: &quot;A String&quot;, # Output only. The time the approval was completed.
407 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the approval was created.
408 &quot;dueTime&quot;: &quot;A String&quot;, # The time that the approval is due.
409 &quot;initiator&quot;: { # Information about a Drive user. # The user that requested the approval.
410 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
411 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
412 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
413 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
414 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
415 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
416 },
417 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#approval.
418 &quot;modifyTime&quot;: &quot;A String&quot;, # Output only. The most recent time the approval was modified.
419 &quot;reviewerResponses&quot;: [ # The responses made on the approval by reviewers.
420 { # A response on an approval made by a specific reviewer.
421 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#reviewerResponse.
422 &quot;response&quot;: &quot;A String&quot;, # A reviewer’s response for the approval.
423 &quot;reviewer&quot;: { # Information about a Drive user. # The user that&#x27;s responsible for this response.
424 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
425 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
426 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
427 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
428 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
429 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
430 },
431 },
432 ],
433 &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the approval at the time this resource was requested.
434 &quot;targetFileId&quot;: &quot;A String&quot;, # Target file id of the approval.
435 },
436 ],
437 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#approvalList
438 &quot;nextPageToken&quot;: &quot;A String&quot;, # The page token for the next page of approvals. This is absent if the end of the approvals list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
439 }</pre>
440 </div>
441
442 <div class="method">
443 <code class="details" id="list_next">list_next()</code>
444 <pre>Retrieves the next page of results.
445
446 Args:
447 previous_request: The request for the previous page. (required)
448 previous_response: The response from the request for the previous page. (required)
449
450 Returns:
451 A request object that you can call &#x27;execute()&#x27; on to request the next
452 page. Returns None if there are no more items in the collection.
453 </pre>
454 </div>
455
456 <div class="method">
457 <code class="details" id="reassign">reassign(fileId, approvalId, body=None, x__xgafv=None)</code>
458 <pre>Reassigns the reviewers on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Adds or replaces reviewers in the ReviewerResponse of the approval. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS` and the Response for the reviewer being reassigned is `NO_RESPONSE`. A user with the `reader` permission can only reassign an approval that&#x27;s assigned to themselves. Removing a reviewer isn&#x27;t allowed.
459
460 Args:
461 fileId: string, Required. The ID of the file that the approval is on. (required)
462 approvalId: string, Required. The ID of the approval to reassign. (required)
463 body: object, The request body.
464 The object takes the form of:
465
466 { # Request for reassigning an approval. Reviewers can be added or replaced, but not removed.
467 &quot;addReviewers&quot;: [ # Optional. The list of reviewers to add.
468 { # Representation of a reviewer addition.
469 &quot;addedReviewerEmail&quot;: &quot;A String&quot;, # Required. The email of the reviewer to add.
470 },
471 ],
472 &quot;message&quot;: &quot;A String&quot;, # Optional. A message to send to the new reviewers. This message is included in notifications for the action and in the approval activity log.
473 &quot;replaceReviewers&quot;: [ # Optional. The list of reviewer replacements.
474 { # Representation of a reviewer replacement.
475 &quot;addedReviewerEmail&quot;: &quot;A String&quot;, # Required. The email of the reviewer to add.
476 &quot;removedReviewerEmail&quot;: &quot;A String&quot;, # Required. The email of the reviewer to remove.
477 },
478 ],
479 }
480
481 x__xgafv: string, V1 error format.
482 Allowed values
483 1 - v1 error format
484 2 - v2 error format
485
486 Returns:
487 An object of the form:
488
489 { # Metadata for an approval. An approval is a review or approve process for a Drive item.
490 &quot;approvalId&quot;: &quot;A String&quot;, # The approval ID.
491 &quot;completeTime&quot;: &quot;A String&quot;, # Output only. The time the approval was completed.
492 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the approval was created.
493 &quot;dueTime&quot;: &quot;A String&quot;, # The time that the approval is due.
494 &quot;initiator&quot;: { # Information about a Drive user. # The user that requested the approval.
495 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
496 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
497 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
498 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
499 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
500 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
501 },
502 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#approval.
503 &quot;modifyTime&quot;: &quot;A String&quot;, # Output only. The most recent time the approval was modified.
504 &quot;reviewerResponses&quot;: [ # The responses made on the approval by reviewers.
505 { # A response on an approval made by a specific reviewer.
506 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#reviewerResponse.
507 &quot;response&quot;: &quot;A String&quot;, # A reviewer’s response for the approval.
508 &quot;reviewer&quot;: { # Information about a Drive user. # The user that&#x27;s responsible for this response.
509 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
510 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
511 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
512 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
513 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
514 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
515 },
516 },
517 ],
518 &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the approval at the time this resource was requested.
519 &quot;targetFileId&quot;: &quot;A String&quot;, # Target file id of the approval.
520 }</pre>
521 </div>
522
523 <div class="method">
524 <code class="details" id="start">start(fileId, body=None, x__xgafv=None)</code>
525 <pre>Starts an approval on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals).
526
527 Args:
528 fileId: string, Required. The ID of the file that the approval is created on. (required)
529 body: object, The request body.
530 The object takes the form of:
531
532 { # Allows creating an approval on a file.
533 &quot;dueTime&quot;: &quot;A String&quot;, # Optional. The time that the approval is due.
534 &quot;lockFile&quot;: True or False, # Optional. Whether to lock the file when starting the approval.
535 &quot;message&quot;: &quot;A String&quot;, # Optional. A message to send to reviewers when notifying them of the approval request.
536 &quot;reviewerEmails&quot;: [ # Required. The emails of the users who are set to review the approval.
537 &quot;A String&quot;,
538 ],
539 }
540
541 x__xgafv: string, V1 error format.
542 Allowed values
543 1 - v1 error format
544 2 - v2 error format
545
546 Returns:
547 An object of the form:
548
549 { # Metadata for an approval. An approval is a review or approve process for a Drive item.
550 &quot;approvalId&quot;: &quot;A String&quot;, # The approval ID.
551 &quot;completeTime&quot;: &quot;A String&quot;, # Output only. The time the approval was completed.
552 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the approval was created.
553 &quot;dueTime&quot;: &quot;A String&quot;, # The time that the approval is due.
554 &quot;initiator&quot;: { # Information about a Drive user. # The user that requested the approval.
555 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
556 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
557 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
558 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
559 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
560 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
561 },
562 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#approval.
563 &quot;modifyTime&quot;: &quot;A String&quot;, # Output only. The most recent time the approval was modified.
564 &quot;reviewerResponses&quot;: [ # The responses made on the approval by reviewers.
565 { # A response on an approval made by a specific reviewer.
566 &quot;kind&quot;: &quot;A String&quot;, # This is always drive#reviewerResponse.
567 &quot;response&quot;: &quot;A String&quot;, # A reviewer’s response for the approval.
568 &quot;reviewer&quot;: { # Information about a Drive user. # The user that&#x27;s responsible for this response.
569 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
570 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
571 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
572 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
573 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
574 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
575 },
576 },
577 ],
578 &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the approval at the time this resource was requested.
579 &quot;targetFileId&quot;: &quot;A String&quot;, # Target file id of the approval.
580 }</pre>
581 </div>
582
583 </body></html>