Low-level functions to execute one or more Drive API requests and, perhaps, process the response(s). Most users should, instead, use higher-level wrappers that facilitate common tasks, such as uploading or downloading Drive files. The functions here are intended for internal use and for programming around the Drive API. Three functions are documented here:
make_request() does the bare minimum: just calls an HTTP method, only
adding the googledrive user agent. Typically the input is created with
generate_request() or build_request() and the output is
processed with process_response().
do_request() is simply process_response(make_request(x, ...)). It
exists only because we had to make do_paginated_request() and it felt
weird to not make the equivalent for a single request.
do_paginated_request() executes the input request with page
traversal. It is impossible to separate paginated requests into a "make
request" step and a "process request" step, because the token for the
next page must be extracted from the content of the current page.
Therefore this function does both and returns a list of processed
responses, one per page.
make_request(x, ...) do_request(x, ...) do_paginated_request(x, ..., n_max = Inf, n = function(res) 1, verbose = TRUE)
| x | List, holding the components for an HTTP request, presumably created
with |
|---|---|
| ... | Optional arguments passed through to the HTTP method. |
| n_max | Maximum number of items to return. Defaults to |
| n | Function that computes the number of items in one response or page.
The default function always returns |
| verbose | Logical, indicating whether to print informative messages
(default |
make_request(): Object of class response from httr.
do_request(): List representing the content returned by a single
request.
do_paginated_request(): List of lists, representing the returned
content, one component per page.
Other low-level API functions: drive_token,
generate_request,
process_response
# NOT RUN { ## build a request for an endpoint that is: ## * paginated ## * NOT privileged in googledrive, i.e. not covered by generate_request() ## "comments" are a great example ## https://developers.google.com/drive/v3/reference/comments ## ## Practice with a target file with > 2 comments ## Note that we request 2 items (comments) per page req <- build_request( path = "drive/v3/files/{fileId}/comments", method = "GET", params = list( fileId = "your-file-id-goes-here", fields = "*", pageSize = 2 ), token = googledrive:::drive_token() ) ## make the paginated request, but cap it at 1 page ## should get back exactly two comments do_paginated_request(req, n_max = 1) # }