You may be able to improve the performance of your API calls by requesting only the metadata that you actually need. This function is primarily for internal use and is currently focused on the Files resource. Note that high-level googledrive functions assume that the name, id, and kind fields are included, at a bare minimum. Assuming that resource = "files" (the default), input provided via fields is checked for validity against the known field names and the validated fields are returned. To see a tibble containing all possible fields and a short description of each, call drive_fields(expose()). prep_fields() prepares fields for inclusion as query parameters.

drive_fields(fields = NULL, resource = "files")

prep_fields(fields, resource = "files")

Arguments

fields

Character vector of field names. If resource = "files", they are checked for validity. Otherwise, they are passed through.

resource

Character, naming the API resource of interest. Currently, only the Files resource is anticipated.

Value

drive_fields(): Character vector of field names. prep_fields(): a string.

See also

Working with partial resources, in the Drive API documentation.

Examples

## get a tibble of all fields for the Files resource + indicator of defaults drive_fields(expose())
#> # A tibble: 51 x 2 #> name desc #> <chr> <chr> #> 1 appProperties "A collection of arbitrary key-value pairs which ar… #> 2 capabilities Capabilities the current user has on this file. Eac… #> 3 contentHints Additional information about the content of the fil… #> 4 createdTime The time at which the file was created (RFC 3339 da… #> 5 description A short description of the file. #> 6 explicitlyTrashed Whether the file has been explicitly trashed, as op… #> 7 fileExtension The final component of fullFileExtension. This is o… #> 8 folderColorRgb "The color for a folder as an RGB hex string. The s… #> 9 fullFileExtension "The full file extension extracted from the name fi… #> 10 hasAugmentedPermissions Whether any users are granted file access directly … #> # ... with 41 more rows
## invalid fields are removed and throw warning drive_fields(c("name", "parents", "ownedByMe", "pancakes!"))
#> Warning: Ignoring fields that are non-standard for the Files resource: #> * pancakes!
#> [1] "name" "parents" "ownedByMe"
## prepare fields for query prep_fields(c("name", "parents", "kind"))
#> [1] "files/name,files/parents,files/kind"