Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / drive_v2.about.html
blob: 5acffec63774b0af2d97a191f87f091becab0ed0 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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="drive_v2.html">Drive API</a> . <a href="drive_v2.about.html">about</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(includeSubscribed=None, startChangeId=None, maxChangeIdCount=None)</a></code></p>
79<p class="firstline">Gets the information about the current user along with Drive API settings</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="get">get(includeSubscribed=None, startChangeId=None, maxChangeIdCount=None)</code>
83 <pre>Gets the information about the current user along with Drive API settings
84
85Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]86 includeSubscribed: boolean, When calculating the number of remaining change IDs, whether to include public files the user has opened and shared files. When set to false, this counts only change IDs for owned files and any shared or public files that the user has explicitly added to a folder they own.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]87 startChangeId: string, Change ID to start counting from when calculating number of remaining change IDs
88 maxChangeIdCount: string, Maximum number of remaining change IDs to count
89
90Returns:
91 An object of the form:
92
93 { # An item with user information and settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]94 "languageCode": "A String", # The user's language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
95 "quotaBytesByService": [ # The amount of storage quota used by different Google services.
96 {
97 "serviceName": "A String", # The service's name, e.g. DRIVE, GMAIL, or PHOTOS.
98 "bytesUsed": "A String", # The storage quota bytes used by the service.
99 },
100 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101 "features": [ # List of additional features enabled on this account.
102 {
103 "featureName": "A String", # The name of the feature.
104 "featureRate": 3.14, # The request limit rate for this feature, in queries per second.
105 },
106 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]107 "folderColorPalette": [ # The palette of allowable folder colors as RGB hex strings.
108 "A String",
109 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]110 "quotaBytesUsedAggregate": "A String", # The number of quota bytes used by all Google apps (Drive, Picasa, etc.).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111 "permissionId": "A String", # The current user's ID as visible in the permissions collection.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]112 "teamDriveThemes": [ # A list of themes that are supported for Team Drives.
113 {
114 "colorRgb": "A String", # The color of this Team Drive theme as an RGB hex string.
115 "backgroundImageLink": "A String", # A link to this Team Drive theme's background image.
116 "id": "A String", # The ID of the theme.
117 },
118 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]119 "etag": "A String", # The ETag of the item.
120 "largestChangeId": "A String", # The largest change id.
121 "quotaBytesUsedInTrash": "A String", # The number of quota bytes used by trashed items.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]122 "domainSharingPolicy": "A String", # The domain sharing policy for the current user. Possible values are:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]123 # - allowed
124 # - allowedWithWarning
125 # - incomingOnly
126 # - disallowed
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]127 "isCurrentAppInstalled": True or False, # A boolean indicating whether the authenticated app is installed by the authenticated user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 "additionalRoleInfo": [ # Information about supported additional roles per file type. The most specific type takes precedence.
129 {
130 "roleSets": [ # The supported additional roles per primary role.
131 {
132 "primaryRole": "A String", # A primary permission role.
133 "additionalRoles": [ # The supported additional roles with the primary role.
134 "A String",
135 ],
136 },
137 ],
138 "type": "A String", # The content type that this additional role info applies to.
139 },
140 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]141 "user": { # Information about a Drive user. # The authenticated user.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]142 "picture": { # The user's profile picture.
143 "url": "A String", # A URL that points to a profile picture of this user.
144 },
145 "kind": "drive#user", # This is always drive#user.
146 "displayName": "A String", # A plain text displayable name for this user.
147 "permissionId": "A String", # The user's ID as visible in the permissions collection.
148 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
149 "emailAddress": "A String", # The email address of the user.
150 },
151 "quotaType": "A String", # The type of the user's storage quota. Possible values are:
152 # - LIMITED
153 # - UNLIMITED
154 "maxUploadSizes": [ # List of max upload sizes for each file type. The most specific type takes precedence.
155 {
156 "type": "A String", # The file type.
157 "size": "A String", # The max upload size for this type.
158 },
159 ],
160 "kind": "drive#about", # This is always drive#about.
161 "name": "A String", # The name of the current user.
162 "quotaBytesTotal": "A String", # The total number of quota bytes.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]163 "remainingChangeIds": "A String", # The number of remaining change ids, limited to no more than 2500.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]164 "importFormats": [ # The allowable import formats.
165 {
166 "source": "A String", # The imported file's content type to convert from.
167 "targets": [ # The possible content types to convert to.
168 "A String",
169 ],
170 },
171 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]172 "rootFolderId": "A String", # The id of the root folder.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]173 "quotaBytesUsed": "A String", # The number of quota bytes used by Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]174 "exportFormats": [ # The allowable export formats.
175 {
176 "source": "A String", # The content type to convert from.
177 "targets": [ # The possible content types to convert to.
178 "A String",
179 ],
180 },
181 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]182 "selfLink": "A String", # A link back to this item.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]183 }</pre>
184</div>
185
186</body></html>