1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v3.html">Drive API</a> . <a href="drive_v3.files.html">files</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#copy">copy(fileId, body, keepRevisionForever=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None)</a></code></p>
<p class="firstline">Creates a copy of a file and applies any requested updates with patch semantics.</p>
<p class="toc_element">
<code><a href="#create">create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None, media_mime_type=None)</a></code></p>
<p class="firstline">Creates a new file.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
<p class="firstline">Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.</p>
<p class="toc_element">
<code><a href="#emptyTrash">emptyTrash()</a></code></p>
<p class="firstline">Permanently deletes all of the user's trashed files.</p>
<p class="toc_element">
<code><a href="#export">export(fileId, mimeType)</a></code></p>
<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.</p>
<p class="toc_element">
<code><a href="#export_media">export_media(fileId, mimeType)</a></code></p>
<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.</p>
<p class="toc_element">
<code><a href="#generateIds">generateIds(count=None, space=None)</a></code></p>
<p class="firstline">Generates a set of file IDs which can be provided in create requests.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a file's metadata or content by ID.</p>
<p class="toc_element">
<code><a href="#get_media">get_media(fileId, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a file's metadata or content by ID.</p>
<p class="toc_element">
<code><a href="#list">list(orderBy=None, pageSize=None, supportsTeamDrives=None, spaces=None, q=None, pageToken=None, corpus=None, teamDriveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, corpora=None, supportsAllDrives=None, driveId=None)</a></code></p>
<p class="firstline">Lists or searches files.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, body=None, keepRevisionForever=None, removeParents=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, addParents=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None)</a></code></p>
<p class="firstline">Updates a file's metadata and/or content with patch semantics.</p>
<p class="toc_element">
<code><a href="#watch">watch(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Subscribes to changes to a file</p>
<p class="toc_element">
<code><a href="#watch_media">watch_media(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Subscribes to changes to a file</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="copy">copy(fileId, body, keepRevisionForever=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None)</code>
<pre>Creates a copy of a file and applies any requested updates with patch semantics.
Args:
fileId: string, The ID of the file. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The metadata for a file.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"mimeType": "A String", # The MIME type of the file.
# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"teamDriveId": "A String", # Deprecated - use driveId instead.
"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
# If an unsupported color is specified, the closest color in the palette will be used instead.
"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canComment": True or False, # Whether the current user can comment on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canEdit": True or False, # Whether the current user can edit this file.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
# If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
"starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"width": 42, # The width of the image in pixels.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"isoSpeed": 42, # The ISO speed used to create the photo.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
"hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}
keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
Returns:
An object of the form:
{ # The metadata for a file.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"mimeType": "A String", # The MIME type of the file.
# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"teamDriveId": "A String", # Deprecated - use driveId instead.
"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
# If an unsupported color is specified, the closest color in the palette will be used instead.
"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canComment": True or False, # Whether the current user can comment on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canEdit": True or False, # Whether the current user can edit this file.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
# If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
"starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"width": 42, # The width of the image in pixels.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"isoSpeed": 42, # The ISO speed used to create the photo.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
"hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}</pre>
</div>
<div class="method">
<code class="details" id="create">create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None, media_mime_type=None)</code>
<pre>Creates a new file.
Args:
body: object, The request body.
The object takes the form of:
{ # The metadata for a file.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"mimeType": "A String", # The MIME type of the file.
# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"teamDriveId": "A String", # Deprecated - use driveId instead.
"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
# If an unsupported color is specified, the closest color in the palette will be used instead.
"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canComment": True or False, # Whether the current user can comment on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canEdit": True or False, # Whether the current user can edit this file.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
# If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
"starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"width": 42, # The width of the image in pixels.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"isoSpeed": 42, # The ISO speed used to create the photo.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
"hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # The metadata for a file.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"mimeType": "A String", # The MIME type of the file.
# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"teamDriveId": "A String", # Deprecated - use driveId instead.
"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
# If an unsupported color is specified, the closest color in the palette will be used instead.
"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canComment": True or False, # Whether the current user can comment on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canEdit": True or False, # Whether the current user can edit this file.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
# If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
"starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"width": 42, # The width of the image in pixels.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"isoSpeed": 42, # The ISO speed used to create the photo.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
"hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(fileId, supportsTeamDrives=None, supportsAllDrives=None)</code>
<pre>Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.
Args:
fileId: string, The ID of the file. (required)
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
</pre>
</div>
<div class="method">
<code class="details" id="emptyTrash">emptyTrash()</code>
<pre>Permanently deletes all of the user's trashed files.
Args:
</pre>
</div>
<div class="method">
<code class="details" id="export">export(fileId, mimeType)</code>
<pre>Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.
Args:
fileId: string, The ID of the file. (required)
mimeType: string, The MIME type of the format requested for this export. (required)
</pre>
</div>
<div class="method">
<code class="details" id="export_media">export_media(fileId, mimeType)</code>
<pre>Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.
Args:
fileId: string, The ID of the file. (required)
mimeType: string, The MIME type of the format requested for this export. (required)
</pre>
</div>
<div class="method">
<code class="details" id="generateIds">generateIds(count=None, space=None)</code>
<pre>Generates a set of file IDs which can be provided in create requests.
Args:
count: integer, The number of IDs to return.
space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.
Returns:
An object of the form:
{ # A list of generated file IDs which can be provided in create requests.
"kind": "drive#generatedIds", # Identifies what kind of resource this is. Value: the fixed string "drive#generatedIds".
"ids": [ # The IDs generated for the requesting user in the specified space.
"A String",
],
"space": "A String", # The type of file that can be created with these IDs.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Gets a file's metadata or content by ID.
Args:
fileId: string, The ID of the file. (required)
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns:
An object of the form:
{ # The metadata for a file.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"mimeType": "A String", # The MIME type of the file.
# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"teamDriveId": "A String", # Deprecated - use driveId instead.
"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
# If an unsupported color is specified, the closest color in the palette will be used instead.
"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canComment": True or False, # Whether the current user can comment on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canEdit": True or False, # Whether the current user can edit this file.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
# If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
"starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"width": 42, # The width of the image in pixels.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"isoSpeed": 42, # The ISO speed used to create the photo.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
"hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}</pre>
</div>
<div class="method">
<code class="details" id="get_media">get_media(fileId, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Gets a file's metadata or content by ID.
Args:
fileId: string, The ID of the file. (required)
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns:
The media object as a string.
</pre>
</div>
<div class="method">
<code class="details" id="list">list(orderBy=None, pageSize=None, supportsTeamDrives=None, spaces=None, q=None, pageToken=None, corpus=None, teamDriveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, corpora=None, supportsAllDrives=None, driveId=None)</code>
<pre>Lists or searches files.
Args:
orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
pageSize: integer, The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
spaces: string, A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
q: string, A query for filtering the file results. See the "Search for Files" guide for supported syntax.
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
corpus: string, The source of files to list. Deprecated: use 'corpora' instead.
Allowed values
domain - Files shared to the user's domain.
user - Files owned by or shared to the user.
teamDriveId: string, Deprecated use driveId instead.
includeItemsFromAllDrives: boolean, Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
driveId: string, ID of the shared drive to search.
Returns:
An object of the form:
{ # A list of files.
"files": [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # The metadata for a file.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"mimeType": "A String", # The MIME type of the file.
# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"teamDriveId": "A String", # Deprecated - use driveId instead.
"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
# If an unsupported color is specified, the closest color in the palette will be used instead.
"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canComment": True or False, # Whether the current user can comment on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canEdit": True or False, # Whether the current user can edit this file.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
# If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
"starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"width": 42, # The width of the image in pixels.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"isoSpeed": 42, # The ISO speed used to create the photo.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
"hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
},
],
"incompleteSearch": True or False, # Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "user" or "drive".
"kind": "drive#fileList", # Identifies what kind of resource this is. Value: the fixed string "drive#fileList".
"nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(fileId, body=None, keepRevisionForever=None, removeParents=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, addParents=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None)</code>
<pre>Updates a file's metadata and/or content with patch semantics.
Args:
fileId: string, The ID of the file. (required)
body: object, The request body.
The object takes the form of:
{ # The metadata for a file.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"mimeType": "A String", # The MIME type of the file.
# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"teamDriveId": "A String", # Deprecated - use driveId instead.
"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
# If an unsupported color is specified, the closest color in the palette will be used instead.
"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canComment": True or False, # Whether the current user can comment on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canEdit": True or False, # Whether the current user can edit this file.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
# If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
"starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"width": 42, # The width of the image in pixels.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"isoSpeed": 42, # The ISO speed used to create the photo.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
"hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}
keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive.
removeParents: string, A comma-separated list of parent IDs to remove.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
addParents: string, A comma-separated list of parent IDs to add.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # The metadata for a file.
"hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"mimeType": "A String", # The MIME type of the file.
# Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
"thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
"teamDriveId": "A String", # Deprecated - use driveId instead.
"writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
"ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
"height": 42, # The height of the video in pixels.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
# If an unsupported color is specified, the closest color in the palette will be used instead.
"appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
"canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
"canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder.
"canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
"canComment": True or False, # Whether the current user can comment on this file.
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
"canEdit": True or False, # Whether the current user can edit this file.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
# If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
"viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
"owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
"starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"width": 42, # The width of the image in pixels.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"isoSpeed": 42, # The ISO speed used to create the photo.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
"name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
"webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in Permission resources.
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
"driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"permissionIds": [ # List of permission IDs for users with access to this file.
"A String",
],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
"hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}</pre>
</div>
<div class="method">
<code class="details" id="watch">watch(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Subscribes to changes to a file
Args:
fileId: string, The ID of the file. (required)
body: object, The request body. (required)
The object takes the form of:
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"address": "A String", # The address where notifications are delivered for this channel.
"type": "A String", # The type of delivery mechanism used for this channel.
"id": "A String", # A UUID or similar unique string that identifies this channel.
}
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns:
An object of the form:
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"address": "A String", # The address where notifications are delivered for this channel.
"type": "A String", # The type of delivery mechanism used for this channel.
"id": "A String", # A UUID or similar unique string that identifies this channel.
}</pre>
</div>
<div class="method">
<code class="details" id="watch_media">watch_media(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Subscribes to changes to a file
Args:
fileId: string, The ID of the file. (required)
body: object, The request body. (required)
The object takes the form of:
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"address": "A String", # The address where notifications are delivered for this channel.
"type": "A String", # The type of delivery mechanism used for this channel.
"id": "A String", # A UUID or similar unique string that identifies this channel.
}
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns:
The media object as a string.
</pre>
</div>
</body></html>
|