blob: 8f1ab67f8a4827e9b3bceea92284ce1b39ef511c [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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="drive_v2.html">Drive API</a> . <a href="drive_v2.parents.html">parents</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#delete">delete(fileId, parentId, enforceSingleParent=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040079<p class="firstline">Removes a parent from a file.</p>
80<p class="toc_element">
81 <code><a href="#get">get(fileId, parentId)</a></code></p>
82<p class="firstline">Gets a specific parent reference.</p>
83<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070084 <code><a href="#insert">insert(fileId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<p class="firstline">Adds a parent folder for a file.</p>
86<p class="toc_element">
87 <code><a href="#list">list(fileId)</a></code></p>
88<p class="firstline">Lists a file's parents.</p>
89<h3>Method Details</h3>
90<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070091 <code class="details" id="delete">delete(fileId, parentId, enforceSingleParent=None)</code>
John Asmuth614db982014-04-24 15:46:26 -040092 <pre>Removes a parent from a file.
93
94Args:
95 fileId: string, The ID of the file. (required)
96 parentId: string, The ID of the parent. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -070097 enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item&#x27;s last parent is removed, the item is placed under its owner&#x27;s root.
John Asmuth614db982014-04-24 15:46:26 -040098</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="get">get(fileId, parentId)</code>
103 <pre>Gets a specific parent reference.
104
105Args:
106 fileId: string, The ID of the file. (required)
107 parentId: string, The ID of the parent. (required)
108
109Returns:
110 An object of the form:
111
Bu Sun Kim65020912020-05-20 12:08:20 -0700112 { # A reference to a file&#x27;s parent.
113 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
114 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
115 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
116 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
117 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400118 }</pre>
119</div>
120
121<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700122 <code class="details" id="insert">insert(fileId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400123 <pre>Adds a parent folder for a file.
124
125Args:
126 fileId: string, The ID of the file. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700127 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400128 The object takes the form of:
129
Bu Sun Kim65020912020-05-20 12:08:20 -0700130{ # A reference to a file&#x27;s parent.
131 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
132 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
133 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
134 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
135 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400136}
137
Bu Sun Kim65020912020-05-20 12:08:20 -0700138 enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the child&#x27;s owner makes the request, the child is removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child&#x27;s parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700139 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700140 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400141
142Returns:
143 An object of the form:
144
Bu Sun Kim65020912020-05-20 12:08:20 -0700145 { # A reference to a file&#x27;s parent.
146 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
147 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
148 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
149 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
150 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400151 }</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="list">list(fileId)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700156 <pre>Lists a file&#x27;s parents.
John Asmuth614db982014-04-24 15:46:26 -0400157
158Args:
159 fileId: string, The ID of the file. (required)
160
161Returns:
162 An object of the form:
163
Bu Sun Kim65020912020-05-20 12:08:20 -0700164 { # A list of a file&#x27;s parents.
165 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
166 &quot;items&quot;: [ # The list of parents.
167 { # A reference to a file&#x27;s parent.
168 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
169 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
170 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
171 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
172 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400173 },
174 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700175 &quot;kind&quot;: &quot;drive#parentList&quot;, # This is always drive#parentList.
176 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this list.
John Asmuth614db982014-04-24 15:46:26 -0400177 }</pre>
178</div>
179
180</body></html>