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 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012
|
<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">Google Drive API</a> . <a href="drive_v3.files.html">files</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#copy">copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).</p>
<p class="toc_element">
<code><a href="#create">create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None)</a></code></p>
<p class="firstline"> Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</a></code></p>
<p class="firstline">Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.</p>
<p class="toc_element">
<code><a href="#download">download(fileId, mimeType=None, revisionId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.</p>
<p class="toc_element">
<code><a href="#emptyTrash">emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None)</a></code></p>
<p class="firstline">Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).</p>
<p class="toc_element">
<code><a href="#export">export(fileId, mimeType, x__xgafv=None)</a></code></p>
<p class="firstline">Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.</p>
<p class="toc_element">
<code><a href="#export_media">export_media(fileId, mimeType, x__xgafv=None)</a></code></p>
<p class="firstline">Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.</p>
<p class="toc_element">
<code><a href="#generateIds">generateIds(count=None, space=None, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).</p>
<p class="toc_element">
<code><a href="#get">get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</a></code></p>
<p class="firstline"> Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).</p>
<p class="toc_element">
<code><a href="#get_media">get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</a></code></p>
<p class="firstline"> Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).</p>
<p class="toc_element">
<code><a href="#list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)</a></code></p>
<p class="firstline"> Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.</p>
<p class="toc_element">
<code><a href="#listLabels">listLabels(fileId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).</p>
<p class="toc_element">
<code><a href="#listLabels_next">listLabels_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#modifyLabels">modifyLabels(fileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, addParents=None, body=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None)</a></code></p>
<p class="firstline"> Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).</p>
<p class="toc_element">
<code><a href="#watch">watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</a></code></p>
<p class="firstline">Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="copy">copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</code>
<pre>Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).
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. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
"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. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 if it's not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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's being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 if it's not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from 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 128 KB 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.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file.
"effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
"itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
},
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output only. 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's not cleared if the new name doesn't contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
"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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. 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. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"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, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"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
"id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
},
],
"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",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The `resourceKey` for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
enforceSingleParent: boolean, Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.
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.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
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. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
"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. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 if it's not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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's being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 if it's not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from 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 128 KB 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.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file.
"effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
"itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
},
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output only. 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's not cleared if the new name doesn't contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
"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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. 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. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"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, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"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
"id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
},
],
"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",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The `resourceKey` for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}</pre>
</div>
<div class="method">
<code class="details" id="create">create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None)</code>
<pre> Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.
Args:
body: object, The request body.
The object takes the form of:
{ # The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
"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. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 if it's not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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's being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 if it's not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from 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 128 KB 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.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file.
"effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
"itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
},
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output only. 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's not cleared if the new name doesn't contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
"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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. 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. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"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, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"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
"id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
},
],
"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",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The `resourceKey` for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
enforceSingleParent: boolean, Deprecated: Creating files in multiple folders is no longer supported.
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.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
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. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type 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).
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
"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. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 if it's not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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's being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 if it's not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from 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 128 KB 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.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file.
"effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
"itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
},
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output only. 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's not cleared if the new name doesn't contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
"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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. 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. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"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, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"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
"id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
},
],
"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",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The `resourceKey` for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</code>
<pre>Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.
Args:
fileId: string, The ID of the file. (required)
enforceSingleParent: boolean, Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="download">download(fileId, mimeType=None, revisionId=None, x__xgafv=None)</code>
<pre>Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.
Args:
fileId: string, Required. The ID of the file to download. (required)
mimeType: string, Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.
revisionId: string, Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="emptyTrash">emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None)</code>
<pre>Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).
Args:
driveId: string, If set, empties the trash of the provided shared drive.
enforceSingleParent: boolean, Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="export">export(fileId, mimeType, x__xgafv=None)</code>
<pre>Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.
Args:
fileId: string, The ID of the file. (required)
mimeType: string, Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="export_media">export_media(fileId, mimeType, x__xgafv=None)</code>
<pre>Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.
Args:
fileId: string, The ID of the file. (required)
mimeType: string, Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="generateIds">generateIds(count=None, space=None, type=None, x__xgafv=None)</code>
<pre>Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).
Args:
count: integer, The number of IDs to return.
space: string, The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
type: string, The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of generated file IDs which can be provided in create requests.
"ids": [ # The IDs generated for the requesting user in the specified space.
"A String",
],
"kind": "drive#generatedIds", # Identifies what kind of resource this is. Value: the fixed string `"drive#generatedIds"`.
"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, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</code>
<pre> Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).
Args:
fileId: string, The ID of the file. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
"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. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 if it's not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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's being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 if it's not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from 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 128 KB 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.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file.
"effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
"itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
},
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output only. 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's not cleared if the new name doesn't contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
"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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. 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. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"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, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"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
"id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
},
],
"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",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The `resourceKey` for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}</pre>
</div>
<div class="method">
<code class="details" id="get_media">get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</code>
<pre> Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).
Args:
fileId: string, The ID of the file. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
The media object as a string.
</pre>
</div>
<div class="method">
<code class="details" id="list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)</code>
<pre> Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.
Args:
corpora: string, Bodies of items (files or documents) to which the query applies. Supported bodies are: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
corpus: string, Deprecated: The source of files to list. Use `corpora` instead.
Allowed values
domain - Files shared to the user's domain.
user - Files owned by or shared to the user.
driveId: string, ID of the shared drive to search.
includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead.
orderBy: string, A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.
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.
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.
q: string, A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).
spaces: string, A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
teamDriveId: string, Deprecated: Use `driveId` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
"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. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 if it's not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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's being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 if it's not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from 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 128 KB 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.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file.
"effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
"itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
},
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output only. 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's not cleared if the new name doesn't contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
"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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. 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. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"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, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"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
"id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
},
],
"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",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The `resourceKey` for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
},
],
"incompleteSearch": True or False, # Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's 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. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
}</pre>
</div>
<div class="method">
<code class="details" id="listLabels">listLabels(fileId, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).
Args:
fileId: string, The ID for the file. (required)
maxResults: integer, The maximum number of labels to return per page. When not set, defaults to 100.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of labels applied to a file.
"kind": "A String", # This is always `"drive#labelList"`.
"labels": [ # The list of labels.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
"nextPageToken": "A String", # The page token for the next page of labels. This field will be absent if the end of the 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. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
}</pre>
</div>
<div class="method">
<code class="details" id="listLabels_next">listLabels_next()</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="list_next">list_next()</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="modifyLabels">modifyLabels(fileId, body=None, x__xgafv=None)</code>
<pre>Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.
Args:
fileId: string, The ID of the file to which the labels belong. (required)
body: object, The request body.
The object takes the form of:
{ # A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.
"kind": "A String", # This is always `"drive#modifyLabelsRequest"`.
"labelModifications": [ # The list of modifications to apply to the labels on the file.
{ # A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.
"fieldModifications": [ # The list of modifications to this label's fields.
{ # A modification to a label's field.
"fieldId": "A String", # The ID of the field to be modified.
"kind": "A String", # This is always `"drive#labelFieldModification"`.
"setDateValues": [ # Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD.
"A String",
],
"setIntegerValues": [ # Replaces the value of an `integer` field with these new values.
"A String",
],
"setSelectionValues": [ # Replaces a `selection` field with these new values.
"A String",
],
"setTextValues": [ # Sets the value of a `text` field.
"A String",
],
"setUserValues": [ # Replaces a `user` field with these new values. The values must be a valid email addresses.
"A String",
],
"unsetValues": True or False, # Unsets the values for this field.
},
],
"kind": "A String", # This is always `"drive#labelModification"`.
"labelId": "A String", # The ID of the label to modify.
"removeLabel": True or False, # If true, the label will be removed from the file.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request.
"kind": "A String", # This is always `"drive#modifyLabelsResponse"`.
"modifiedLabels": [ # The list of labels which were added or updated by the request.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(fileId, addParents=None, body=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None)</code>
<pre> Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).
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. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
"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. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 if it's not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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's being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 if it's not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from 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 128 KB 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.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file.
"effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
"itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
},
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output only. 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's not cleared if the new name doesn't contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
"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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. 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. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"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, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"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
"id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
},
],
"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",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The `resourceKey` for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
addParents: string, A comma-separated list of parent IDs to add.
enforceSingleParent: boolean, Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
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. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type 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).
removeParents: string, A comma-separated list of parent IDs to remove.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
"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. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeItemDownloadRestriction": True or False, # Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 if it's not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canDisableInheritedPermissions": True or False, # Whether a user can disable inherited permissions.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canEnableInheritedPermissions": True or False, # Whether a user can re-enable inherited permissions.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. 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's being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 if it's not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there's a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from 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 128 KB 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.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly=true`.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"downloadRestrictions": { # Download restrictions applied to the file. # Download restrictions applied on the file.
"effectiveDownloadRestrictionWithContext": { # A restriction for copy and download of the file. # Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
"itemDownloadRestriction": { # A restriction for copy and download of the file. # The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.
},
},
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output only. 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's not cleared if the new name doesn't contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"inheritedPermissionsDisabled": True or False, # Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
"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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. 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. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/workspace/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"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, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"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
"id": "A String", # Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
},
],
"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",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The `resourceKey` for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output only. 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}</pre>
</div>
<div class="method">
<code class="details" id="watch">watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</code>
<pre>Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).
Args:
fileId: string, The ID of the file. (required)
body: object, The request body.
The object takes the form of:
{ # A notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".
}
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".
}</pre>
</div>
</body></html>
|