Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 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_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 | |
| 85 | Args: |
Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 86 | includeSubscribed: boolean, When calculating the number of remaining change IDs, whether to include shared files and public files the user has opened. When set to false, this counts only change IDs for owned files and any shared or public files that the user has explictly added to a folder in Drive. |
Joe Gregorio | 075572b | 2012-07-09 16:53:09 -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 | |
| 90 | Returns: |
| 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 | ], |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 101 | "quotaBytesUsed": "A String", # The number of quota bytes used by Google Drive. |
Joe Gregorio | d67010d | 2012-11-05 08:57:06 -0500 | [diff] [blame] | 102 | "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. |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 107 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
Joe Gregorio | d67010d | 2012-11-05 08:57:06 -0500 | [diff] [blame] | 108 | "displayName": "A String", # A plain text displayable name for this user. |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 109 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
Joe Gregorio | d67010d | 2012-11-05 08:57:06 -0500 | [diff] [blame] | 110 | }, |
Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 111 | "permissionId": "A String", # The current user's ID as visible in the permissions collection. |
Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 112 | "maxUploadSizes": [ # List of max upload sizes for each file type. The most specific type takes precedence. |
Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 113 | { |
| 114 | "type": "A String", # The file type. |
| 115 | "size": "A String", # The max upload size for this type. |
| 116 | }, |
| 117 | ], |
| 118 | "name": "A String", # The name of the current user. |
| 119 | "remainingChangeIds": "A String", # The number of remaining change ids. |
Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 120 | "additionalRoleInfo": [ # Information about supported additional roles per file type. The most specific type takes precedence. |
Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 121 | { |
Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 122 | "roleSets": [ # The supported additional roles per primary role. |
Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 123 | { |
Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 124 | "primaryRole": "A String", # A primary permission role. |
| 125 | "additionalRoles": [ # The supported additional roles with the primary role. |
Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 126 | "A String", |
| 127 | ], |
| 128 | }, |
| 129 | ], |
Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 130 | "type": "A String", # The content type that this additional role info applies to. |
Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 131 | }, |
| 132 | ], |
| 133 | "etag": "A String", # The ETag of the item. |
| 134 | "importFormats": [ # The allowable import formats. |
| 135 | { |
| 136 | "source": "A String", # The imported file's content type to convert from. |
| 137 | "targets": [ # The possible content types to convert to. |
| 138 | "A String", |
| 139 | ], |
| 140 | }, |
| 141 | ], |
| 142 | "quotaBytesTotal": "A String", # The total number of quota bytes. |
| 143 | "rootFolderId": "A String", # The id of the root folder. |
| 144 | "largestChangeId": "A String", # The largest change id. |
| 145 | "quotaBytesUsedInTrash": "A String", # The number of quota bytes used by trashed items. |
| 146 | "exportFormats": [ # The allowable export formats. |
| 147 | { |
| 148 | "source": "A String", # The content type to convert from. |
| 149 | "targets": [ # The possible content types to convert to. |
| 150 | "A String", |
| 151 | ], |
| 152 | }, |
| 153 | ], |
Joe Gregorio | d67010d | 2012-11-05 08:57:06 -0500 | [diff] [blame] | 154 | "quotaBytesUsedAggregate": "A String", # The number of quota bytes used by all Google apps (Drive, Picasa, etc.). |
Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 155 | "domainSharingPolicy": "A String", # The domain sharing policy for the current user. |
| 156 | "selfLink": "A String", # A link back to this item. |
| 157 | "isCurrentAppInstalled": True or False, # A boolean indicating whether the authenticated app is installed by the authenticated user. |
| 158 | }</pre> |
| 159 | </div> |
| 160 | |
| 161 | </body></html> |