| John Asmuth | 614db98 | 2014-04-24 15:46:26 -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"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 78 | <code><a href="#get">get(includeSubscribed=None, maxChangeIdCount=None, startChangeId=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 82 | <code class="details" id="get">get(includeSubscribed=None, maxChangeIdCount=None, startChangeId=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <pre>Gets the information about the current user along with Drive API settings |
| 84 | |
| 85 | Args: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | includeSubscribed: boolean, Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the maxChangeIdCount. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 87 | maxChangeIdCount: string, Maximum number of remaining change IDs to count |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 88 | startChangeId: string, Change ID to start counting from when calculating number of remaining change IDs |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 89 | |
| 90 | Returns: |
| 91 | An object of the form: |
| 92 | |
| 93 | { # An item with user information and settings. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 94 | "additionalRoleInfo": [ # Information about supported additional roles per file type. The most specific type takes precedence. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 95 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 96 | "roleSets": [ # The supported additional roles per primary role. |
| 97 | { |
| 98 | "additionalRoles": [ # The supported additional roles with the primary role. |
| 99 | "A String", |
| 100 | ], |
| 101 | "primaryRole": "A String", # A primary permission role. |
| 102 | }, |
| 103 | ], |
| 104 | "type": "A String", # The content type that this additional role info applies to. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 105 | }, |
| 106 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 107 | "canCreateDrives": True or False, # Whether the user can create shared drives. |
| 108 | "canCreateTeamDrives": True or False, # Deprecated - use canCreateDrives instead. |
| 109 | "domainSharingPolicy": "A String", # The domain sharing policy for the current user. Possible values are: |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 110 | # - allowed |
| 111 | # - allowedWithWarning |
| 112 | # - incomingOnly |
| 113 | # - disallowed |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 114 | "driveThemes": [ # A list of themes that are supported for shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 115 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | "backgroundImageLink": "A String", # A link to this theme's background image. |
| 117 | "colorRgb": "A String", # The color of this theme as an RGB hex string. |
| 118 | "id": "A String", # The ID of the theme. |
| 119 | }, |
| 120 | ], |
| 121 | "etag": "A String", # The ETag of the item. |
| 122 | "exportFormats": [ # The allowable export formats. |
| 123 | { |
| 124 | "source": "A String", # The content type to convert from. |
| 125 | "targets": [ # The possible content types to convert to. |
| 126 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 127 | ], |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 128 | }, |
| 129 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 130 | "features": [ # List of additional features enabled on this account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 131 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 132 | "featureName": "A String", # The name of the feature. |
| 133 | "featureRate": 3.14, # The request limit rate for this feature, in queries per second. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 134 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 135 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 136 | "folderColorPalette": [ # The palette of allowable folder colors as RGB hex strings. |
| 137 | "A String", |
| 138 | ], |
| 139 | "importFormats": [ # The allowable import formats. |
| 140 | { |
| 141 | "source": "A String", # The imported file's content type to convert from. |
| 142 | "targets": [ # The possible content types to convert to. |
| 143 | "A String", |
| 144 | ], |
| 145 | }, |
| 146 | ], |
| 147 | "isCurrentAppInstalled": True or False, # A boolean indicating whether the authenticated app is installed by the authenticated user. |
| 148 | "kind": "drive#about", # This is always drive#about. |
| 149 | "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/). |
| 150 | "largestChangeId": "A String", # The largest change id. |
| 151 | "maxUploadSizes": [ # List of max upload sizes for each file type. The most specific type takes precedence. |
| 152 | { |
| 153 | "size": "A String", # The max upload size for this type. |
| 154 | "type": "A String", # The file type. |
| 155 | }, |
| 156 | ], |
| 157 | "name": "A String", # The name of the current user. |
| 158 | "permissionId": "A String", # The current user's ID as visible in the permissions collection. |
| 159 | "quotaBytesByService": [ # The amount of storage quota used by different Google services. |
| 160 | { |
| 161 | "bytesUsed": "A String", # The storage quota bytes used by the service. |
| 162 | "serviceName": "A String", # The service's name, e.g. DRIVE, GMAIL, or PHOTOS. |
| 163 | }, |
| 164 | ], |
| 165 | "quotaBytesTotal": "A String", # The total number of quota bytes. This is only relevant when quotaType is LIMITED. |
| 166 | "quotaBytesUsed": "A String", # The number of quota bytes used by Google Drive. |
| 167 | "quotaBytesUsedAggregate": "A String", # The number of quota bytes used by all Google apps (Drive, Picasa, etc.). |
| 168 | "quotaBytesUsedInTrash": "A String", # The number of quota bytes used by trashed items. |
| 169 | "quotaType": "A String", # The type of the user's storage quota. Possible values are: |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 170 | # - LIMITED |
| 171 | # - UNLIMITED |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | "remainingChangeIds": "A String", # The number of remaining change ids, limited to no more than 2500. |
| 173 | "rootFolderId": "A String", # The id of the root folder. |
| 174 | "selfLink": "A String", # A link back to this item. |
| 175 | "teamDriveThemes": [ # Deprecated - use driveThemes instead. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 176 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 177 | "backgroundImageLink": "A String", # Deprecated - use driveThemes/backgroundImageLink instead. |
| 178 | "colorRgb": "A String", # Deprecated - use driveThemes/colorRgb instead. |
| 179 | "id": "A String", # Deprecated - use driveThemes/id instead. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 180 | }, |
| 181 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 182 | "user": { # Information about a Drive user. # The authenticated user. |
| 183 | "displayName": "A String", # A plain text displayable name for this user. |
| 184 | "emailAddress": "A String", # The email address of the user. |
| 185 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 186 | "kind": "drive#user", # This is always drive#user. |
| 187 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 188 | "picture": { # The user's profile picture. |
| 189 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 190 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 191 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 192 | }</pre> |
| 193 | </div> |
| 194 | |
| 195 | </body></html> |