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
|
<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="drive_v3.html">Google Drive API</a> . <a href="drive_v3.approvals.html">approvals</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="#get">get(fileId, approvalId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an Approval by ID.</p>
<p class="toc_element">
<code><a href="#list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the Approvals on a file.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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="get">get(fileId, approvalId, x__xgafv=None)</code>
<pre>Gets an Approval by ID.
Args:
fileId: string, Required. The ID of the file the Approval is on. (required)
approvalId: string, Required. The ID of the Approval. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata for an approval. An approval is a review/approve process for a Drive item.
"approvalId": "A String", # The Approval ID.
"completeTime": "A String", # Output only. The time time the approval was completed.
"createTime": "A String", # Output only. The time the approval was created.
"dueTime": "A String", # The time that the approval is due.
"initiator": { # Information about a Drive user. # The user that requested the Approval.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"kind": "A String", # This is always drive#approval.
"modifyTime": "A String", # Output only. The most recent time the approval was modified.
"reviewerResponses": [ # The responses made on the Approval by reviewers.
{ # A response on an Approval made by a specific Reviewer.
"kind": "A String", # This is always drive#reviewerResponse.
"response": "A String", # A Reviewer’s Response for the Approval.
"reviewer": { # Information about a Drive user. # The user that is responsible for this response.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
},
],
"status": "A String", # Output only. The status of the approval at the time this resource was requested.
"targetFileId": "A String", # Target file id of the approval.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the Approvals on a file.
Args:
fileId: string, Required. The ID of the file the Approval is on. (required)
pageSize: integer, The maximum number of Approvals to return. When not set, at most 100 Approvals will be returned.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response of an Approvals list request.
"items": [ # The list of Approvals. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # Metadata for an approval. An approval is a review/approve process for a Drive item.
"approvalId": "A String", # The Approval ID.
"completeTime": "A String", # Output only. The time time the approval was completed.
"createTime": "A String", # Output only. The time the approval was created.
"dueTime": "A String", # The time that the approval is due.
"initiator": { # Information about a Drive user. # The user that requested the Approval.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"kind": "A String", # This is always drive#approval.
"modifyTime": "A String", # Output only. The most recent time the approval was modified.
"reviewerResponses": [ # The responses made on the Approval by reviewers.
{ # A response on an Approval made by a specific Reviewer.
"kind": "A String", # This is always drive#reviewerResponse.
"response": "A String", # A Reviewer’s Response for the Approval.
"reviewer": { # Information about a Drive user. # The user that is responsible for this response.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
},
],
"status": "A String", # Output only. The status of the approval at the time this resource was requested.
"targetFileId": "A String", # Target file id of the approval.
},
],
"kind": "A String", # This is always drive#approvalList
"nextPageToken": "A String", # The page token for the next page of Approvals. This will be 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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
