blob: 4349974f647b02966dd29323af5f2fd7c3778e74 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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.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:
86 includeSubscribed: boolean, Whether to include subscribed items when calculating the number of remaining change IDs
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.
94 "kind": "drive#about", # This is always drive#about.
95 "features": [ # List of additional features enabled on this account.
96 {
97 "featureName": "A String", # The name of the feature.
98 "featureRate": 3.14, # The request limit rate for this feature, in queries per second.
99 },
100 ],
101 "quotaBytesUsed": "A String", # The number of quota bytes used.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500102 "user": { # The JSON template for a user. # The authenticated user.
103 "picture": { # The user's profile picture.
104 "url": "A String", # A URL that points to a profile picture of this user.
105 },
106 "kind": "drive#user", # This is always drive#user.
107 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
108 "displayName": "A String", # A plain text displayable name for this user.
109 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400110 "permissionId": "A String", # The current user's ID as visible in the permissions collection.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400111 "maxUploadSizes": [ # List of max upload sizes for each file type. The most specific type takes precedence.
Joe Gregorio075572b2012-07-09 16:53:09 -0400112 {
113 "type": "A String", # The file type.
114 "size": "A String", # The max upload size for this type.
115 },
116 ],
117 "name": "A String", # The name of the current user.
118 "remainingChangeIds": "A String", # The number of remaining change ids.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400119 "additionalRoleInfo": [ # Information about supported additional roles per file type. The most specific type takes precedence.
Joe Gregorio075572b2012-07-09 16:53:09 -0400120 {
Joe Gregorioad8013f2012-08-03 08:44:02 -0400121 "roleSets": [ # The supported additional roles per primary role.
Joe Gregorio075572b2012-07-09 16:53:09 -0400122 {
Joe Gregorioad8013f2012-08-03 08:44:02 -0400123 "primaryRole": "A String", # A primary permission role.
124 "additionalRoles": [ # The supported additional roles with the primary role.
Joe Gregorio075572b2012-07-09 16:53:09 -0400125 "A String",
126 ],
127 },
128 ],
Joe Gregorioad8013f2012-08-03 08:44:02 -0400129 "type": "A String", # The content type that this additional role info applies to.
Joe Gregorio075572b2012-07-09 16:53:09 -0400130 },
131 ],
132 "etag": "A String", # The ETag of the item.
133 "importFormats": [ # The allowable import formats.
134 {
135 "source": "A String", # The imported file's content type to convert from.
136 "targets": [ # The possible content types to convert to.
137 "A String",
138 ],
139 },
140 ],
141 "quotaBytesTotal": "A String", # The total number of quota bytes.
142 "rootFolderId": "A String", # The id of the root folder.
143 "largestChangeId": "A String", # The largest change id.
144 "quotaBytesUsedInTrash": "A String", # The number of quota bytes used by trashed items.
145 "exportFormats": [ # The allowable export formats.
146 {
147 "source": "A String", # The content type to convert from.
148 "targets": [ # The possible content types to convert to.
149 "A String",
150 ],
151 },
152 ],
Joe Gregoriod67010d2012-11-05 08:57:06 -0500153 "quotaBytesUsedAggregate": "A String", # The number of quota bytes used by all Google apps (Drive, Picasa, etc.).
Joe Gregorio075572b2012-07-09 16:53:09 -0400154 "domainSharingPolicy": "A String", # The domain sharing policy for the current user.
155 "selfLink": "A String", # A link back to this item.
156 "isCurrentAppInstalled": True or False, # A boolean indicating whether the authenticated app is installed by the authenticated user.
157 }</pre>
158</div>
159
160</body></html>